diff --git a/.automation/generated/flavors-stats.json b/.automation/generated/flavors-stats.json index 9329c277ab8..64cf46bc4c5 100644 --- a/.automation/generated/flavors-stats.json +++ b/.automation/generated/flavors-stats.json @@ -1197,8 +1197,8 @@ 2724455 ], [ - "2023-01-06T11:41:09", - 2726275 + "2023-01-06T12:01:29", + 2726288 ] ], "ci_light": [ @@ -2399,8 +2399,8 @@ 41320 ], [ - "2023-01-06T11:41:09", - 41725 + "2023-01-06T12:01:29", + 41728 ] ], "cupcake": [ @@ -2581,7 +2581,7 @@ 1362 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 1393 ] ], @@ -4693,8 +4693,8 @@ 100398 ], [ - "2023-01-06T11:41:09", - 100809 + "2023-01-06T12:01:29", + 100810 ] ], "dotnet": [ @@ -5895,8 +5895,8 @@ 336755 ], [ - "2023-01-06T11:41:09", - 337239 + "2023-01-06T12:01:29", + 337242 ] ], "go": [ @@ -7097,7 +7097,7 @@ 15931 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 15952 ] ], @@ -8299,7 +8299,7 @@ 104610 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 104756 ] ], @@ -9501,8 +9501,8 @@ 182719 ], [ - "2023-01-06T11:41:09", - 183311 + "2023-01-06T12:01:29", + 183319 ] ], "php": [ @@ -10703,8 +10703,8 @@ 34525 ], [ - "2023-01-06T11:41:09", - 34874 + "2023-01-06T12:01:29", + 34875 ] ], "python": [ @@ -11905,8 +11905,8 @@ 142966 ], [ - "2023-01-06T11:41:09", - 143549 + "2023-01-06T12:01:29", + 143558 ] ], "ruby": [ @@ -13103,7 +13103,7 @@ 2802 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 2802 ] ], @@ -14301,7 +14301,7 @@ 4381 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 4387 ] ], @@ -15503,7 +15503,7 @@ 15909 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 15934 ] ], @@ -16703,7 +16703,7 @@ 1927 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 1977 ] ], @@ -17901,7 +17901,7 @@ 3031 ], [ - "2023-01-06T11:41:09", + "2023-01-06T12:01:29", 3060 ] ], @@ -19103,8 +19103,8 @@ 155882 ], [ - "2023-01-06T11:41:09", - 156670 + "2023-01-06T12:01:29", + 156680 ] ] } \ No newline at end of file diff --git a/docs/all_linters.md b/docs/all_linters.md index 5a26b87fc38..b4176feeec2 100644 --- a/docs/all_linters.md +++ b/docs/all_linters.md @@ -21,10 +21,10 @@ | [**clj-kondo**](https://github.com/borkdude/clj-kondo){target=_blank} | 2022.12.10 | [EPL-1.0](licenses/clj-kondo.md) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo){target=_blank} | [CLOJURE](descriptors/clojure_clj_kondo.md) | :heart: | [MegaLinter reference](https://github.com/borkdude/clj-kondo/blob/master/doc/ci-integration.md#github){target=_blank} | | [**coffeelint**](https://github.com/clutchski/coffeelint){target=_blank} | 5.2.11 | [Other](licenses/coffeelint.md) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint){target=_blank} | [COFFEE](descriptors/coffee_coffeelint.md) | :white_circle: | [Repository](https://github.com/clutchski/coffeelint){target=_blank} | | [**cpplint**](https://github.com/cpplint/cpplint){target=_blank} | 1.6.1 | | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint){target=_blank} | [C](descriptors/c_cpplint.md)
[CPP](descriptors/cpp_cpplint.md) | :white_circle: | [Repository](https://github.com/cpplint/cpplint){target=_blank} | -| [**csharpier**](https://github.com/belav/csharpier){target=_blank} | 0.16.0 | | [![GitHub stars](https://img.shields.io/github/stars/belav/csharpier?cacheSeconds=3600)](https://github.com/belav/csharpier){target=_blank} | [CSHARP](descriptors/csharp_csharpier.md) | :white_circle: | [Repository](https://github.com/belav/csharpier){target=_blank} | +| [**csharpier**](https://github.com/belav/csharpier){target=_blank} | 0.21.0 | | [![GitHub stars](https://img.shields.io/github/stars/belav/csharpier?cacheSeconds=3600)](https://github.com/belav/csharpier){target=_blank} | [CSHARP](descriptors/csharp_csharpier.md) | :white_circle: | [Repository](https://github.com/belav/csharpier){target=_blank} | | [**cspell**](https://github.com/streetsidesoftware/cspell){target=_blank} | 6.18.1 | [MIT](licenses/cspell.md) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell){target=_blank} | [SPELL](descriptors/spell_cspell.md) | :heart: | [MegaLinter reference](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell#mega-linter){target=_blank} | | [**dartanalyzer**](https://github.com/dart-lang/sdk){target=_blank} | N/A | [BSD-3-Clause](licenses/dartanalyzer.md) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk){target=_blank} | [DART](descriptors/dart_dartanalyzer.md) | :no_entry_sign: | [Repository](https://github.com/dart-lang/sdk){target=_blank} | -| [**devskim**](https://github.com/microsoft/DevSkim){target=_blank} | 0.6.9 | [MIT](licenses/devskim.md) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim){target=_blank} | [REPOSITORY](descriptors/repository_devskim.md) | :white_circle: | [Repository](https://github.com/microsoft/DevSkim){target=_blank} | +| [**devskim**](https://github.com/microsoft/DevSkim){target=_blank} | 0.7.101 | [MIT](licenses/devskim.md) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim){target=_blank} | [REPOSITORY](descriptors/repository_devskim.md) | :white_circle: | [Repository](https://github.com/microsoft/DevSkim){target=_blank} | | [**djlint**](https://github.com/Riverside-Healthcare/djlint){target=_blank} | 1.19.11 | [GPL-3.0](licenses/djlint.md) | [![GitHub stars](https://img.shields.io/github/stars/Riverside-Healthcare/djlint?cacheSeconds=3600)](https://github.com/Riverside-Healthcare/djlint){target=_blank} | [HTML](descriptors/html_djlint.md) | :heart: | [MegaLinter reference](https://djlint.com/docs/integrations/#megalinter){target=_blank} | | [**dotenv-linter**](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | 3.3.0 | [MIT](licenses/dotenv-linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | [ENV](descriptors/env_dotenv_linter.md) | :heart: | [MegaLinter reference](https://dotenv-linter.github.io/#/integrations/mega_linter){target=_blank} | | [**dotnet-format**](https://github.com/dotnet/format){target=_blank} | 000 | [MIT](licenses/dotnet-format.md) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format){target=_blank} | [CSHARP](descriptors/csharp_dotnet_format.md)
[VBDOTNET](descriptors/vbdotnet_dotnet_format.md) | :white_circle: | [Repository](https://github.com/dotnet/format){target=_blank} | @@ -81,7 +81,7 @@ | [**scalafix**](https://github.com/scalacenter/scalafix){target=_blank} | 0.10.4 | [Other](licenses/scalafix.md) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix){target=_blank} | [SCALA](descriptors/scala_scalafix.md) | :heart: | [MegaLinter reference](https://scalacenter.github.io/scalafix/docs/users/installation.html#plugins-for-other-build-tools){target=_blank} | | [**scss-lint**](https://github.com/sds/scss-lint){target=_blank} | 0.59.0 | | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint){target=_blank} | [CSS](descriptors/css_scss_lint.md) | :white_circle: | [Repository](https://github.com/sds/scss-lint){target=_blank} | | [**secretlint**](https://github.com/secretlint/secretlint){target=_blank} | 6.0.2 | [MIT](licenses/secretlint.md) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint){target=_blank} | [REPOSITORY](descriptors/repository_secretlint.md) | :heart: | [MegaLinter reference](https://github.com/secretlint/secretlint#mega-linter){target=_blank} | -| [**semgrep**](https://github.com/returntocorp/semgrep){target=_blank} | 1.2.1 | | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep){target=_blank} | [REPOSITORY](descriptors/repository_semgrep.md) | :white_circle: | [Repository](https://github.com/returntocorp/semgrep){target=_blank} | +| [**semgrep**](https://github.com/returntocorp/semgrep){target=_blank} | 1.3.0 | | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep){target=_blank} | [REPOSITORY](descriptors/repository_semgrep.md) | :white_circle: | [Repository](https://github.com/returntocorp/semgrep){target=_blank} | | [**sfdx-scanner-apex**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 3.8.0 | [MIT](licenses/sfdx-scanner-apex.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_apex.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | | [**sfdx-scanner-aura**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 3.8.0 | [MIT](licenses/sfdx-scanner-aura.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_aura.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | | [**sfdx-scanner-lwc**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 3.8.0 | [MIT](licenses/sfdx-scanner-lwc.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_lwc.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | @@ -102,7 +102,7 @@ | [**terrascan**](https://github.com/accurics/terrascan){target=_blank} | 1.16.0 | [Apache-2.0](licenses/terrascan.md) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan){target=_blank} | [TERRAFORM](descriptors/terraform_terrascan.md) | :white_circle: | [Repository](https://github.com/accurics/terrascan){target=_blank} | | [**tflint**](https://github.com/terraform-linters/tflint){target=_blank} | 0.44.0 | | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint){target=_blank} | [TERRAFORM](descriptors/terraform_tflint.md) | :white_circle: | [Repository](https://github.com/terraform-linters/tflint){target=_blank} | | [**trivy**](https://github.com/aquasecurity/trivy){target=_blank} | 0.35.0 | [Apache-2.0](licenses/trivy.md) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy){target=_blank} | [REPOSITORY](descriptors/repository_trivy.md) | :white_circle: | [Repository](https://github.com/aquasecurity/trivy){target=_blank} | -| [**tsqllint**](https://github.com/tsqllint/tsqllint){target=_blank} | 1.14.5.0 | [MIT](licenses/tsqllint.md) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint){target=_blank} | [SQL](descriptors/sql_tsqllint.md) | :white_circle: | [Repository](https://github.com/tsqllint/tsqllint){target=_blank} | +| [**tsqllint**](https://github.com/tsqllint/tsqllint){target=_blank} | 1.15.1.0 | [MIT](licenses/tsqllint.md) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint){target=_blank} | [SQL](descriptors/sql_tsqllint.md) | :white_circle: | [Repository](https://github.com/tsqllint/tsqllint){target=_blank} | | [**v8r**](https://github.com/chris48s/v8r){target=_blank} | 0.13.1 | | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r){target=_blank} | [JSON](descriptors/json_v8r.md)
[YAML](descriptors/yaml_v8r.md) | :no_entry_sign: | [Repository](https://github.com/chris48s/v8r){target=_blank} | | [**xmllint**](http://xmlsoft.org/xmllint.html){target=_blank} | 20914 | | | [XML](descriptors/xml_xmllint.md) | :white_circle: | [Web Site](http://xmlsoft.org/xmllint.html){target=_blank} | | [**yamllint**](https://github.com/adrienverge/yamllint){target=_blank} | 1.28.0 | [GPL-3.0](licenses/yamllint.md) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint){target=_blank} | [YAML](descriptors/yaml_yamllint.md) | :no_entry_sign: | [Repository](https://github.com/adrienverge/yamllint){target=_blank} | diff --git a/docs/descriptors/csharp_dotnet_format.md b/docs/descriptors/csharp_dotnet_format.md index f3c0cc4978e..2534eb0a611 100644 --- a/docs/descriptors/csharp_dotnet_format.md +++ b/docs/descriptors/csharp_dotnet_format.md @@ -4,13 +4,15 @@ description: How to use dotnet-format (configure, ignore files, ignore errors, h --- -# dotnet-format +# dotnet-format [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/dotnet/format?sort=semver)](https://github.com/dotnet/format/releases) [![GitHub last commit](https://img.shields.io/github/last-commit/dotnet/format)](https://github.com/dotnet/format/commits) [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/dotnet/format)](https://github.com/dotnet/format/graphs/commit-activity/) [![GitHub contributors](https://img.shields.io/github/contributors/dotnet/format)](https://github.com/dotnet/format/graphs/contributors/) +dotnet-format requires a `.sln` or `.csproj` file to run correctly. + ## dotnet-format documentation - Version in MegaLinter: **000** -- Visit [Official Web Site](https://github.com/dotnet/format#readme){target=_blank} +- Visit [Official Web Site](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format){target=_blank} [![format - GitHub](https://gh-card.dev/repos/dotnet/format.svg?fullname=)](https://github.com/dotnet/format){target=_blank} @@ -58,42 +60,76 @@ This linter is available in the following flavours ### Example calls ```shell -dotnet-format --folder --check --exclude / --include myfile.cs +dotnet format {{WORKSPACE}} --verify-no-changes ``` ```shell -dotnet-format --folder --exclude / --include myfile.cs +dotnet format {{WORKSPACE}} ``` ### Help content ```shell -dotnet-format - dotnet-format - -Usage: - dotnet-format [options] [] - -Arguments: - 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 `` argument as a simple folder of files. - -w, --fix-whitespace Run whitespace formatting. Run by default when not applying fixes. - -s, --fix-style Run code style analyzers and apply fixes. - -a, --fix-analyzers Run 3rd party analyzers and apply fixes. - --diagnostics A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues. [default: ] - --include A list of relative file or folder paths to include in formatting. All files are formatted if empty. [default: ] - --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 Accepts a file path, which if provided, will produce a json report in the given directory. - -v, --verbosity Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] - --binarylog Log all project or solution load information to a binary log file. - --version Show version information - -?, -h, --help Show help and usage information - +Usage: dotnet [runtime-options] [path-to-application] [arguments] + +Execute a .NET application. + +runtime-options: + --additionalprobingpath Path containing probing policy and assemblies to probe for. + --additional-deps Path to additional deps.json file. + --depsfile Path to .deps.json file. + --fx-version Version of the installed Shared Framework to use to run the application. + --roll-forward Roll forward to framework version (LatestPatch, Minor, LatestMinor, Major, LatestMajor, Disable). + --runtimeconfig Path to .runtimeconfig.json file. + +path-to-application: + The path to an application .dll file to execute. + +Usage: dotnet [sdk-options] [command] [command-options] [arguments] + +Execute a .NET SDK command. + +sdk-options: + -d|--diagnostics Enable diagnostic output. + -h|--help Show command line help. + --info Display .NET information. + --list-runtimes Display the installed runtimes. + --list-sdks Display the installed SDKs. + --version Display .NET SDK version in use. + +SDK commands: + add Add a package or reference to a .NET project. + build Build a .NET project. + build-server Interact with servers started by a build. + clean Clean build outputs of a .NET project. + format Apply style preferences to a project or solution. + help Show command line help. + list List project references of a .NET project. + msbuild Run Microsoft Build Engine (MSBuild) commands. + new Create a new .NET project or file. + nuget Provides additional NuGet commands. + pack Create a NuGet package. + publish Publish a .NET project for deployment. + remove Remove a package or reference from a .NET project. + restore Restore dependencies specified in a .NET project. + run Build and run a .NET project output. + sdk Manage .NET SDK installation. + sln Modify Visual Studio solution files. + store Store the specified assemblies in the runtime package store. + test Run unit tests using the test runner specified in a .NET project. + tool Install or manage tools that extend the .NET experience. + vstest Run Microsoft Test Engine (VSTest) commands. + workload Manage optional workloads. + +Additional commands from bundled tools: + dev-certs Create and manage development certificates. + fsi Start F# Interactive / execute F# scripts. + sql-cache SQL Server cache command-line tools. + user-secrets Manage development user secrets. + watch Start a file watcher that runs a command when files change. + +Run 'dotnet [command] --help' for more information on a command. ``` ### Installation on mega-linter Docker image @@ -103,7 +139,7 @@ Options: # Parent descriptor install RUN wget --tries=5 -q -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 5.0 -version latest + && ./dotnet-install.sh --install-dir /usr/share/dotnet -channel 6.0 -version latest ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet" # Linter install diff --git a/docs/descriptors/vbdotnet_dotnet_format.md b/docs/descriptors/vbdotnet_dotnet_format.md index 116660b7fd3..9fab2e8fba0 100644 --- a/docs/descriptors/vbdotnet_dotnet_format.md +++ b/docs/descriptors/vbdotnet_dotnet_format.md @@ -4,13 +4,15 @@ description: How to use dotnet-format (configure, ignore files, ignore errors, h --- -# dotnet-format +# dotnet-format [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/dotnet/format?sort=semver)](https://github.com/dotnet/format/releases) [![GitHub last commit](https://img.shields.io/github/last-commit/dotnet/format)](https://github.com/dotnet/format/commits) [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/dotnet/format)](https://github.com/dotnet/format/graphs/commit-activity/) [![GitHub contributors](https://img.shields.io/github/contributors/dotnet/format)](https://github.com/dotnet/format/graphs/contributors/) +dotnet-format requires a `.sln` or `.vbproj` file to run correctly. + ## dotnet-format documentation - Version in MegaLinter: **000** -- Visit [Official Web Site](https://github.com/dotnet/format#readme){target=_blank} +- Visit [Official Web Site](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format){target=_blank} [![format - GitHub](https://gh-card.dev/repos/dotnet/format.svg?fullname=)](https://github.com/dotnet/format){target=_blank} @@ -58,55 +60,77 @@ This linter is available in the following flavours ### Example calls ```shell -dotnet-format --folder --check --exclude / --include myfile.vb +dotnet format {{WORKSPACE}} --verify-no-changes ``` ```shell -dotnet-format --folder --exclude / --include myfile.vb +dotnet format {{WORKSPACE}} ``` ### Help content ```shell -dotnet-format - dotnet-format - -Usage: - dotnet-format [options] [] - -Arguments: - 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 `` argument as a simple folder of files. - -w, --fix-whitespace Run whitespace formatting. Run by default when not applying fixes. - -s, --fix-style Run code style analyzers and apply fixes. - -a, --fix-analyzers Run 3rd party analyzers and apply fixes. - --diagnostics A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues. [default: ] - --include A list of relative file or folder paths to include in formatting. All files are formatted if empty. [default: ] - --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 Accepts a file path, which if provided, will produce a json report in the given directory. - -v, --verbosity Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic] - --binarylog Log all project or solution load information to a binary log file. - --version Show version information - -?, -h, --help Show help and usage information - +Usage: dotnet [runtime-options] [path-to-application] [arguments] + +Execute a .NET application. + +runtime-options: + --additionalprobingpath Path containing probing policy and assemblies to probe for. + --additional-deps Path to additional deps.json file. + --depsfile Path to .deps.json file. + --fx-version Version of the installed Shared Framework to use to run the application. + --roll-forward Roll forward to framework version (LatestPatch, Minor, LatestMinor, Major, LatestMajor, Disable). + --runtimeconfig Path to .runtimeconfig.json file. + +path-to-application: + The path to an application .dll file to execute. + +Usage: dotnet [sdk-options] [command] [command-options] [arguments] + +Execute a .NET SDK command. + +sdk-options: + -d|--diagnostics Enable diagnostic output. + -h|--help Show command line help. + --info Display .NET information. + --list-runtimes Display the installed runtimes. + --list-sdks Display the installed SDKs. + --version Display .NET SDK version in use. + +SDK commands: + add Add a package or reference to a .NET project. + build Build a .NET project. + build-server Interact with servers started by a build. + clean Clean build outputs of a .NET project. + format Apply style preferences to a project or solution. + help Show command line help. + list List project references of a .NET project. + msbuild Run Microsoft Build Engine (MSBuild) commands. + new Create a new .NET project or file. + nuget Provides additional NuGet commands. + pack Create a NuGet package. + publish Publish a .NET project for deployment. + remove Remove a package or reference from a .NET project. + restore Restore dependencies specified in a .NET project. + run Build and run a .NET project output. + sdk Manage .NET SDK installation. + sln Modify Visual Studio solution files. + store Store the specified assemblies in the runtime package store. + test Run unit tests using the test runner specified in a .NET project. + tool Install or manage tools that extend the .NET experience. + vstest Run Microsoft Test Engine (VSTest) commands. + workload Manage optional workloads. + +Additional commands from bundled tools: + dev-certs Create and manage development certificates. + fsi Start F# Interactive / execute F# scripts. + sql-cache SQL Server cache command-line tools. + user-secrets Manage development user secrets. + watch Start a file watcher that runs a command when files change. + +Run 'dotnet [command] --help' for more information on a command. ``` ### Installation on mega-linter Docker image -- Dockerfile commands : -```dockerfile -# Parent descriptor install -RUN wget --tries=5 -q -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 5.0 -version latest - -ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet" -# Linter install -RUN /usr/share/dotnet/dotnet tool install -g dotnet-format -``` -