summaryrefslogtreecommitdiff
path: root/doc/ale-cs.txt
diff options
context:
space:
mode:
authorJelte Fennema <github-tech@jeltef.nl>2021-08-25 08:27:04 +0200
committerGitHub <noreply@github.com>2021-08-25 15:27:04 +0900
commitd53a085096306c890897385692693ee653aaddce (patch)
treec55044979ba1c480589de22590b4df63bc44a17a /doc/ale-cs.txt
parentf896744feec260fb196d38bba23308080c04192c (diff)
downloadale-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/ale-cs.txt')
-rw-r--r--doc/ale-cs.txt33
1 files changed, 33 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