dotnet-format
dotnet-format documentation
- Version in Mega-Linter: 4.1.131201
- Visit Official Web Site
Configuration in Mega-Linter
- Enable dotnet-format by adding
CSHARP_DOTNET_FORMATin ENABLE_LINTERS variable - Disable dotnet-format by adding
CSHARP_DOTNET_FORMATin DISABLE_LINTERS variable
- Enable auto-fixes by adding
CSHARP_DOTNET_FORMATin APPLY_FIXES variable
| Variable | Description | Default value |
|---|---|---|
| CSHARP_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
| CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src|lib) |
Include every file |
| CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test|examples) |
Exclude no file |
| CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".cs"] |
| CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
| CSHARP_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | true |
Mega-Linter Flavours
This linter is available in the following flavours
| Flavor | Description | Embedded linters | Info | |
|---|---|---|---|---|
 |
all | Default Mega-Linter Flavor | 83 |   |
| dotnet | Optimized for C, C++, C# or VB based projects | 42 |   |
Behind the scenes
How are identified applicable files
- File extensions:
.cs
Example calls
dotnet-format --folder --check --exclude / --include myfile.cs
dotnet-format --folder --exclude / --include myfile.cs
Help content
dotnet-format:
dotnet-format
Usage:
dotnet-format
[options]
[<project>]
Arguments:
<project>
The
solution
or
project
file
to
operate
on.
If
a
file
is
not
specified,
the
command
will
search
the
current
directory
for
one.
Options:
-f, --folder <folder>
Whether
to
treat
the
`<project>`
path
as
a
folder
of
files.
[default:
]
--files, --include <include>
A
list
of
relative
file
or
folder
paths
to
include
in
formatting.
All
files
are
formatted
if
empty.
[default:
System.String[]]
--exclude <exclude>
A
list
of
relative
file
or
folder
paths
to
exclude
from
formatting.
[default:
System.String[]]
--check, --dry-run
Formats
files
without
saving
changes
to
disk.
Terminates
with
a
non-zero
exit
code
if
any
files
were
formatted.
--report <report>
Accepts
a
file
path,
which
if
provided,
will
produce
a
json
report
in
the
given
directory.
[default:
]
-v, --verbosity <verbosity>
Set
the
verbosity
level.
Allowed
values
are
q[uiet],
m[inimal],
n[ormal],
d[etailed],
and
diag[nostic]
--version
Show
version
information
-?, -h, --help
Show
help
and
usage
information
Installation on mega-linter Docker image
- Dockerfile commands :
# Parent descriptor install
RUN wget --tries=5 -O dotnet-install.sh https://dot.net/v1/dotnet-install.sh \
&& chmod +x dotnet-install.sh \
&& ./dotnet-install.sh --install-dir /usr/share/dotnet -channel Current -version latest
ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet"
# Linter install
RUN /usr/share/dotnet/dotnet tool install -g dotnet-format
Example success log
Results of dotnet-format linter (version 4.1.131201)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/csharp_dotnet_format/
-----------------------------------------------
[SUCCESS] .automation/test/csharp/csharp_good_01.cs
Formatting code files in workspace '.automation/test/csharp'.
Format complete in 1181ms.
Example error log
Results of dotnet-format linter (version 4.1.131201)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/csharp_dotnet_format/
-----------------------------------------------
[ERROR] .automation/test/csharp/csharp_bad_01.cs
Formatting code files in workspace '.automation/test/csharp'.
csharp/csharp_bad_01.cs(1,33): Fix whitespace formatting.
Formatted code file '.automation/test/csharp/csharp_bad_01.cs'.
Format complete in 1295ms.