summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorghsang <66662835+ghsang@users.noreply.github.com>2021-07-16 16:20:47 +0900
committerGitHub <noreply@github.com>2021-07-16 16:20:47 +0900
commitd6dbb5398e805466ab30b4e7f1c78d7c4168fcf8 (patch)
tree6720ada3fa39907eaf358594badaf22ad0105f5e /doc
parentd8f4e8b7081724c0b9ff2491dd68409b3da69b0f (diff)
downloadale-d6dbb5398e805466ab30b4e7f1c78d7c4168fcf8.zip
Add support for `dart format` fixer (#3764)
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-dart.txt31
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 33 insertions, 0 deletions
diff --git a/doc/ale-dart.txt b/doc/ale-dart.txt
index 01089252..983a23d1 100644
--- a/doc/ale-dart.txt
+++ b/doc/ale-dart.txt
@@ -58,6 +58,37 @@ g:ale_dart_dartanalyzer_executable *g:ale_dart_dartanalyzer_executable*
This variable can be set to change the path to dartanalyzer.
+===============================================================================
+dart-format *ale-dart-format*
+
+Installation
+-------------------------------------------------------------------------------
+
+Installing Dart should probably ensure that `dart` is in your `$PATH`.
+
+In case it is not, try to set the executable option to its absolute path. : >
+ " Set the executable path for dart to the absolute path to it.
+ let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart'
+ >
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_dart_format_executable *g:ale_dart_format_executable*
+ *b:ale_dart_format_executable*
+ Type: |String|
+ Default: `'dart'`
+
+ This variable can be set to specify an absolute path to the
+ format executable (or to specify an alternate executable).
+
+
+g:ale_dart_format_options *g:ale_dart_format_options*
+ *b:ale_dart_format_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the dart format fixer.
===============================================================================
dartfmt *ale-dart-dartfmt*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index d71d9354..638cee7d 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -124,6 +124,7 @@ Notes:
* `dafny`!!
* Dart
* `analysis_server`
+ * `dart-format`!!
* `dartanalyzer`!!
* `dartfmt`!!
* `language_server`
diff --git a/doc/ale.txt b/doc/ale.txt
index 1ec22c18..f81bcefb 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2699,6 +2699,7 @@ documented in additional help files.
dart....................................|ale-dart-options|
analysis_server.......................|ale-dart-analysis_server|
dartanalyzer..........................|ale-dart-dartanalyzer|
+ dart-format...........................|ale-dart-format|
dartfmt...............................|ale-dart-dartfmt|
desktop.................................|ale-desktop-options|
desktop-file-validate.................|ale-desktop-desktop-file-validate|