dotnet-format
dotnet-format documentation
- Version in MegaLinter: 000
- Visit Official Web Site
Configuration in MegaLinter
- Enable dotnet-format by adding
VBDOTNET_DOTNET_FORMAT
in ENABLE_LINTERS variable - Disable dotnet-format by adding
VBDOTNET_DOTNET_FORMAT
in DISABLE_LINTERS variable
- Enable auto-fixes by adding
VBDOTNET_DOTNET_FORMAT
in APPLY_FIXES variable
Variable | Description | Default value |
---|---|---|
VBDOTNET_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE | Override default CLI lint mode - file : Calls the linter for each file- list_of_files : Call the linter with the list of files as argument- project : Call the linter from the root of the project |
{linter.cli_lint_mode} |
VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".vb"] |
VBDOTNET_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 |
VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None |
VBDOTNET_DOTNET_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None |
VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | true |
VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default MegaLinter Flavor | 95 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 47 |
Behind the scenes
How are identified applicable files
- File extensions:
.vb
How the linting is performed
- dotnet-format is called one time by identified file
Example calls
dotnet-format --folder --check --exclude / --include myfile.vb
dotnet-format --folder --exclude / --include myfile.vb
Help content
dotnet-format
dotnet-format
Usage:
dotnet-format [options] [<workspace>]
Arguments:
<workspace> A path to a solution file, a project file, or a folder containing a solution or project file. If a path is not specified then the current directory is used. [default: ]
Options:
--no-restore Doesn't execute an implicit restore before formatting.
-f, --folder Whether to treat the `<workspace>` argument as a simple folder of files.
-w, --fix-whitespace Run whitespace formatting. Run by default when not applying fixes.
-s, --fix-style <error|info|warn> Run code style analyzers and apply fixes.
-a, --fix-analyzers <error|info|warn> Run 3rd party analyzers and apply fixes.
--diagnostics <diagnostics> A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues. [default: ]
--include <include> A list of relative file or folder paths to include in formatting. All files are formatted if empty. [default: ]
--exclude <exclude> A list of relative file or folder paths to exclude from formatting. [default: ]
--check Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
--report <report-path> Accepts a file path, which if provided, will produce a json report in the given directory.
-v, --verbosity <d|detailed|diag|diagnostic|m|minimal|n|normal|q|quiet> Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]
--binarylog <binary-log-path> Log all project or solution load information to a binary log file.
--version Show version information
-?, -h, --help Show help and usage information
Installation on mega-linter Docker image
None
Example success log
Results of dotnet-format linter (version 4.1.131201)
See documentation on https://megalinter.github.io/descriptors/vbdotnet_dotnet_format/
-----------------------------------------------
[SUCCESS] .automation/test/vbdotnet/vbdotnet_good_1.vb
Formatting code files in workspace '.automation/test/vbdotnet'.
Format complete in 1063ms.
Example error log
Results of dotnet-format linter (version 4.1.131201)
See documentation on https://megalinter.github.io/descriptors/vbdotnet_dotnet_format/
-----------------------------------------------
[ERROR] .automation/test/vbdotnet/vbdotnet_bad_1.vb
Formatting code files in workspace '.automation/test/vbdotnet'.
vbdotnet/vbdotnet_bad_1.vb(4,4): Fix whitespace formatting.
vbdotnet/vbdotnet_bad_1.vb(4,20): Fix whitespace formatting.
vbdotnet/vbdotnet_bad_1.vb(5,7): Fix whitespace formatting.
Formatted code file '.automation/test/vbdotnet/vbdotnet_bad_1.vb'.
Format complete in 1188ms.