summaryrefslogtreecommitdiff
path: root/doc/ale-dart.txt
blob: a046808b633b6533c18d2e9af410c79f4523788c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
===============================================================================
ALE Dart Integration                                         *ale-dart-options*


===============================================================================
analysis_server                                      *ale-dart-analysis_server*

Installation
-------------------------------------------------------------------------------

Install Dart via whatever means. `analysis_server` will be included in the SDK.

In case that `dart` is not in your path, 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_analysis_server_executable = '/usr/local/bin/dart'
<

Options
-------------------------------------------------------------------------------

g:ale_dart_analysis_server_executable   *g:ale_dart_analysis_server_executable*
                                        *b:ale_dart_analysis_server_executable*
  Type: |String|
  Default: `'dart'`

  This variable can be set to change the path of dart.


===============================================================================
dart-analyze                                                 *ale-dart-analyze*

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'
 >

Install Dart via whatever means. `dart analyze` will be included in the SDK.

Options
-------------------------------------------------------------------------------

g:ale_dart_analyze_executable                   *g:ale_dart_analyze_executable*
                                                *b:ale_dart_analyze_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).


===============================================================================
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.



===============================================================================
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*

Installation
-------------------------------------------------------------------------------

Installing Dart should probably ensure that `dartfmt` is in your `$PATH`.

In case it is not, try to set the executable option to its absolute path. : >
  " Set the executable path for dartfmt to the absolute path to it.
  let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt'
 >

Options
-------------------------------------------------------------------------------

g:ale_dart_dartfmt_executable                   *g:ale_dart_dartfmt_executable*
                                                *b:ale_dart_dartfmt_executable*
  Type: |String|
  Default: `''`

  This variable can be set to specify an absolute path to the
  dartfmt executable (or to specify an alternate executable).


g:ale_dart_dartfmt_options                         *g:ale_dart_dartfmt_options*
                                                   *b:ale_dart_dartfmt_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the dartfmt fixer.

===============================================================================

  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: