summaryrefslogtreecommitdiff
path: root/doc/ale-dart.txt
diff options
context:
space:
mode:
authorghsang <66662835+ghsang@users.noreply.github.com>2021-07-25 13:48:12 +0900
committerGitHub <noreply@github.com>2021-07-25 13:48:12 +0900
commit73d32335fe0b9d723e19f098d3c263b01e17d234 (patch)
tree00939ac8aaf01fcfbd077e649e79aa12efc8822a /doc/ale-dart.txt
parent8c591996a83d623fb158fe090acbd89dabbfaf06 (diff)
downloadale-73d32335fe0b9d723e19f098d3c263b01e17d234.zip
Add support for `dart analyze` (#3825)
Diffstat (limited to 'doc/ale-dart.txt')
-rw-r--r--doc/ale-dart.txt64
1 files changed, 47 insertions, 17 deletions
diff --git a/doc/ale-dart.txt b/doc/ale-dart.txt
index 983a23d1..a046808b 100644
--- a/doc/ale-dart.txt
+++ b/doc/ale-dart.txt
@@ -28,35 +28,31 @@ g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable*
===============================================================================
-dartanalyzer *ale-dart-dartanalyzer*
+dart-analyze *ale-dart-analyze*
Installation
-------------------------------------------------------------------------------
-Install Dart via whatever means. `dartanalyzer` will be included in the SDK.
-
-You can add the SDK to `$PATH`, as described here:
-https://www.dartlang.org/tools/sdk
+Installing Dart should probably ensure that `dart` is in your `$PATH`.
-If you have installed Dart on Linux, you can also try the following: >
- " Set the executable path for dartanalyzer to the absolute path to it.
- let g:ale_dart_dartanalyzer_executable = '/usr/lib/dart/bin/dartanalyzer'
-<
-... or similarly for wherever your Dart SDK lives. This should work without
-having to modify `$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'
+ >
-ALE can only check for problems with `dartanalyzer` with the file on disk.
-See |ale-lint-file-linters|
+Install Dart via whatever means. `dart analyze` will be included in the SDK.
Options
-------------------------------------------------------------------------------
-g:ale_dart_dartanalyzer_executable *g:ale_dart_dartanalyzer_executable*
- *b:ale_dart_dartanalyzer_executable*
+g:ale_dart_analyze_executable *g:ale_dart_analyze_executable*
+ *b:ale_dart_analyze_executable*
Type: |String|
- Default: `'dartanalyzer'`
+ Default: `'dart'`
+
+ This variable can be set to specify an absolute path to the
+ format executable (or to specify an alternate executable).
- This variable can be set to change the path to dartanalyzer.
===============================================================================
dart-format *ale-dart-format*
@@ -90,6 +86,40 @@ g:ale_dart_format_options *g:ale_dart_format_options*
This variable can be set to pass additional options to the dart format fixer.
+
+
+===============================================================================
+dartanalyzer *ale-dart-dartanalyzer*
+
+Installation
+-------------------------------------------------------------------------------
+
+Install Dart via whatever means. `dartanalyzer` will be included in the SDK.
+
+You can add the SDK to `$PATH`, as described here:
+https://www.dartlang.org/tools/sdk
+
+If you have installed Dart on Linux, you can also try the following: >
+ " Set the executable path for dartanalyzer to the absolute path to it.
+ let g:ale_dart_dartanalyzer_executable = '/usr/lib/dart/bin/dartanalyzer'
+<
+... or similarly for wherever your Dart SDK lives. This should work without
+having to modify `$PATH`.
+
+ALE can only check for problems with `dartanalyzer` with the file on disk.
+See |ale-lint-file-linters|
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_dart_dartanalyzer_executable *g:ale_dart_dartanalyzer_executable*
+ *b:ale_dart_dartanalyzer_executable*
+ Type: |String|
+ Default: `'dartanalyzer'`
+
+ This variable can be set to change the path to dartanalyzer.
+
+
===============================================================================
dartfmt *ale-dart-dartfmt*