diff options
| author | Jelte Fennema <github-tech@jeltef.nl> | 2021-08-25 08:27:04 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-25 15:27:04 +0900 |
| commit | d53a085096306c890897385692693ee653aaddce (patch) | |
| tree | c55044979ba1c480589de22590b4df63bc44a17a /doc | |
| parent | f896744feec260fb196d38bba23308080c04192c (diff) | |
| download | ale-d53a085096306c890897385692693ee653aaddce.zip | |
Add fixer for "dotnet format" (#3879)
The .NET ecosystem has an official tool for formatting its files: `dotnet format`
This adds support for that tool to ALE.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-cs.txt | 33 | ||||
| -rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 1 | ||||
| -rw-r--r-- | doc/ale.txt | 1 |
3 files changed, 35 insertions, 0 deletions
diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index bb13863f..bef495b9 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -91,6 +91,39 @@ g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies* < =============================================================================== +dotnet-format *ale-cs-dotnet-format* + +Installation +------------------------------------------------------------------------------- + +Installing .NET SDK should probably ensure that `dotnet` is in your `$PATH`. +For .NET 6 the `dotnet format` tool is already included in the .NET SDK. For +.NET 5 or below you will have to manually install it using the instructions +from listed in this repository: https://github.com/dotnet/format + + +Options +------------------------------------------------------------------------------- + +g:ale_cs_dotnet_format_executable *g:ale_cs_dotnet_format_executable* + *b:ale_cs_dotnet_format_executable* + Type: |String| + Default: `'dotnet'` + + This variable can be set to specify an absolute path to the + `dotnet` executable (or to specify an alternate executable). + + +g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options* + *b:ale_cs_dotnet_format_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the `dotnet format` + fixer. + + +=============================================================================== mcs *ale-cs-mcs* The `mcs` linter looks only for syntax errors while you type. See diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index db67b593..ba2d2255 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -66,6 +66,7 @@ Notes: * `uncrustify` * C# * `csc`!! + * `dotnet-format` * `mcs` * `mcsc`!! * `uncrustify` diff --git a/doc/ale.txt b/doc/ale.txt index c2a1b01e..351c34ce 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2681,6 +2681,7 @@ documented in additional help files. uncrustify............................|ale-cpp-uncrustify| c#......................................|ale-cs-options| csc...................................|ale-cs-csc| + dotnet-format.........................|ale-cs-dotnet-format| mcs...................................|ale-cs-mcs| mcsc..................................|ale-cs-mcsc| uncrustify............................|ale-cs-uncrustify| |