doc/ale-javascript.txt

   1 ===============================================================================
   2 ALE JavaScript Integration                             *ale-javascript-options*
   3                                         *ale-eslint-nested-configuration-files*
   4
   5 For fixing files with ESLint, nested configuration files with `root: false`
   6 are not supported. This is because ALE fixes files by writing the contents of
   7 buffers to temporary files, and then explicitly sets the configuration file.
   8 Configuration files which are set explicitly must be root configuration files.
   9 If you are using nested configuration files, you should restructure your
  10 project so your configuration files use `extends` instead.
  11
  12 See the ESLint documentation here:
  13 http://eslint.org/docs/user-guide/configuring#extending-configuration-files
  14
  15 You should change the structure of your project from this: >
  16   /path/foo/.eslintrc.js # root: true
  17   /path/foo/bar/.eslintrc.js # root: false
  18 <
  19
  20 To this: >
  21   /path/foo/.base-eslintrc.js # Base configuration here
  22   /path/foo/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
  23   /path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
  24 <
  25
  26 ===============================================================================
  27 biome                                                    *ale-javascript-biome*
  28
  29 Check the docs over at |ale-typescript-biome|.
  30
  31
  32 ===============================================================================
  33 clang-format                                       *ale-javascript-clangformat*
  34
  35 See |ale-c-clangformat| for information about the available options.
  36 Note that the C options are also used for JavaScript.
  37
  38
  39 ===============================================================================
  40 cspell                                                  *ale-javascript-cspell*
  41
  42 See |ale-cspell-options|
  43
  44
  45 ===============================================================================
  46 deno                                                      *ale-javascript-deno*
  47
  48 Check the docs over at |ale-typescript-deno|.
  49
  50
  51 ===============================================================================
  52 dprint                                                  *ale-javascript-dprint*
  53
  54 See |ale-dprint-options| and https://dprint.dev/plugins/typescript
  55
  56
  57 ===============================================================================
  58 eslint                                                  *ale-javascript-eslint*
  59
  60                                      *ale-options.javascript_eslint_executable*
  61                                            *g:ale_javascript_eslint_executable*
  62                                            *b:ale_javascript_eslint_executable*
  63 javascript_eslint_executable
  64 g:ale_javascript_eslint_executable
  65   Type: |String|
  66   Default: `'eslint'`
  67
  68   See |ale-integrations-local-executables|
  69
  70                                         *ale-options.javascript_eslint_options*
  71                                               *g:ale_javascript_eslint_options*
  72                                               *b:ale_javascript_eslint_options*
  73 javascript_eslint_options
  74 g:ale_javascript_eslint_options
  75   Type: |String|
  76   Default: `''`
  77
  78   This variable can be set to pass additional options to eslint.
  79
  80                                      *ale-options.javascript_eslint_use_global*
  81                                            *g:ale_javascript_eslint_use_global*
  82                                            *b:ale_javascript_eslint_use_global*
  83 javascript_eslint_use_global
  84 g:ale_javascript_eslint_use_global
  85   Type: |Number|
  86   Default: `get(g:, 'ale_use_global_executables', 0)`
  87
  88   See |ale-integrations-local-executables|
  89
  90
  91                           *ale-options.javascript_eslint_suppress_eslintignore*
  92                                 *g:ale_javascript_eslint_suppress_eslintignore*
  93                                 *b:ale_javascript_eslint_suppress_eslintignore*
  94 javascript_eslint_suppress_eslintignore
  95 g:ale_javascript_eslint_suppress_eslintignore
  96   Type: |Number|
  97   Default: `0`
  98
  99   This variable can be set to `1` to disable warnings for files being ignored
 100   by eslint.
 101
 102
 103                         *ale-options.javascript_eslint_suppress_missing_config*
 104                               *g:ale_javascript_eslint_suppress_missing_config*
 105                               *b:ale_javascript_eslint_suppress_missing_config*
 106 javascript_eslint_suppress_missing_config
 107 g:ale_javascript_eslint_suppress_missing_config
 108   Type: |Number|
 109   Default: `0`
 110
 111   This variable can be set to `1` to disable errors for missing eslint
 112   configuration files.
 113
 114   When turning this option on, eslint will not report any problems when no
 115   configuration files are found.
 116
 117
 118 ===============================================================================
 119 fecs                                                      *ale-javascript-fecs*
 120
 121 `fecs` is a lint tool for HTML/CSS/JavaScript, can be installed via:
 122
 123   `$ npm install --save-dev fecs`
 124
 125 And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com
 126 for more options.
 127
 128                                        *ale-options.javascript_fecs_executable*
 129                                              *g:ale_javascript_fecs_executable*
 130                                              *b:ale_javascript_fecs_executable*
 131 javascript_fecs_executable
 132 g:ale_javascript_fecs_executable
 133   Type: |String|
 134   Default: `'fecs'`
 135
 136   See |ale-integrations-local-executables|
 137
 138                                        *ale-options.javascript_fecs_use_global*
 139                                              *g:ale_javascript_fecs_use_global*
 140                                              *b:ale_javascript_fecs_use_global*
 141 javascript_fecs_use_global
 142 g:ale_javascript_fecs_use_global
 143   Type: |Number|
 144   Default: `get(g:, 'ale_use_global_executables', 0)`
 145
 146   See |ale-integrations-local-executables|
 147
 148
 149 ===============================================================================
 150 flow                                                      *ale-javascript-flow*
 151
 152                                        *ale-options.javascript_flow_executable*
 153                                              *g:ale_javascript_flow_executable*
 154                                              *b:ale_javascript_flow_executable*
 155 javascript_flow_executable
 156 g:ale_javascript_flow_executable
 157   Type: |String|
 158   Default: `'flow'`
 159
 160   See |ale-integrations-local-executables|
 161
 162                                   *ale-options.javascript_flow_use_home_config*
 163                                         *g:ale_javascript_flow_use_home_config*
 164                                         *b:ale_javascript_flow_use_home_config*
 165 javascript_flow_use_home_config
 166 g:ale_javascript_flow_use_home_config
 167   Type: |Number|
 168   Default: `0`
 169
 170   When set to `1`, ALE will allow Flow to be executed with configuration files
 171   from your home directory. ALE will not run Flow with home directory
 172   configuration files by default, as doing so can lead to Vim consuming all of
 173   your RAM and CPU power.
 174
 175                                        *ale-options.javascript_flow_use_global*
 176                                              *g:ale_javascript_flow_use_global*
 177                                              *b:ale_javascript_flow_use_global*
 178 javascript_flow_use_global
 179 g:ale_javascript_flow_use_global
 180   Type: |Number|
 181   Default: `get(g:, 'ale_use_global_executables', 0)`
 182
 183   See |ale-integrations-local-executables|
 184
 185                                *ale-options.javascript_flow_use_respect_pragma*
 186                                      *g:ale_javascript_flow_use_respect_pragma*
 187                                      *b:ale_javascript_flow_use_respect_pragma*
 188 javascript_flow_use_respect_pragma
 189 g:ale_javascript_flow_use_respect_pragma
 190   Type: |Number|
 191   Default: `1`
 192
 193   By default, ALE will use the `--respect-pragma` option for `flow`, so only
 194   files with the `@flow` pragma are checked by ALE. This option can be set to
 195   `0` to disable that behavior, so all files can be checked by `flow`.
 196
 197
 198 ===============================================================================
 199 importjs                                              *ale-javascript-importjs*
 200
 201                                    *ale-options.javascript_importjs_executable*
 202                                          *g:ale_javascript_importjs_executable*
 203                                          *b:ale_javascript_importjs_executable*
 204 javascript_importjs_executable
 205 g:ale_javascript_importjs_executable
 206   Type: |String|
 207   Default: `'importjs'`
 208
 209
 210 ===============================================================================
 211 jscs                                                      *ale-javascript-jscs*
 212
 213                                        *ale-options.javascript_jscs_executable*
 214                                              *g:ale_javascript_jscs_executable*
 215                                              *b:ale_javascript_jscs_executable*
 216 javascript_jscs_executable
 217 g:ale_javascript_jscs_executable
 218   Type: |String|
 219   Default: `'jscs'`
 220
 221   See |ale-integrations-local-executables|
 222
 223                                        *ale-options.javascript_jscs_use_global*
 224                                              *g:ale_javascript_jscs_use_global*
 225                                              *b:ale_javascript_jscs_use_global*
 226 javascript_jscs_use_global
 227 g:ale_javascript_jscs_use_global
 228   Type: |Number|
 229   Default: `get(g:, 'ale_use_global_executables', 0)`
 230
 231   See |ale-integrations-local-executables|
 232
 233
 234 ===============================================================================
 235 jshint                                                  *ale-javascript-jshint*
 236
 237                                      *ale-options.javascript_jshint_executable*
 238                                            *g:ale_javascript_jshint_executable*
 239                                            *b:ale_javascript_jshint_executable*
 240 javascript_jshint_executable
 241 g:ale_javascript_jshint_executable
 242   Type: |String|
 243   Default: `'jshint'`
 244
 245   See |ale-integrations-local-executables|
 246
 247                                      *ale-options.javascript_jshint_use_global*
 248                                            *g:ale_javascript_jshint_use_global*
 249                                            *b:ale_javascript_jshint_use_global*
 250 javascript_jshint_use_global
 251 g:ale_javascript_jshint_use_global
 252   Type: |Number|
 253   Default: `get(g:, 'ale_use_global_executables', 0)`
 254
 255   See |ale-integrations-local-executables|
 256
 257
 258 ===============================================================================
 259 prettier                                              *ale-javascript-prettier*
 260
 261                                    *ale-options.javascript_prettier_executable*
 262                                          *g:ale_javascript_prettier_executable*
 263                                          *b:ale_javascript_prettier_executable*
 264 javascript_prettier_executable
 265 g:ale_javascript_prettier_executable
 266   Type: |String|
 267   Default: `'prettier'`
 268
 269   See |ale-integrations-local-executables|
 270
 271                                       *ale-options.javascript_prettier_options*
 272                                             *g:ale_javascript_prettier_options*
 273                                             *b:ale_javascript_prettier_options*
 274 javascript_prettier_options
 275 g:ale_javascript_prettier_options
 276   Type: |String|
 277   Default: `''`
 278
 279   This variable can be set to pass additional options to prettier.
 280
 281                                    *ale-options.javascript_prettier_use_global*
 282                                          *g:ale_javascript_prettier_use_global*
 283                                          *b:ale_javascript_prettier_use_global*
 284 javascript_prettier_use_global
 285 g:ale_javascript_prettier_use_global
 286   Type: |Number|
 287   Default: `get(g:, 'ale_use_global_executables', 0)`
 288
 289   See |ale-integrations-local-executables|
 290
 291
 292 ===============================================================================
 293 prettier-eslint                                *ale-javascript-prettier-eslint*
 294
 295                             *ale-options.javascript_prettier_eslint_executable*
 296                                   *g:ale_javascript_prettier_eslint_executable*
 297                                   *b:ale_javascript_prettier_eslint_executable*
 298 javascript_prettier_eslint_executable
 299 g:ale_javascript_prettier_eslint_executable
 300   Type: |String|
 301   Default: `'prettier-eslint'`
 302
 303   See |ale-integrations-local-executables|
 304
 305                                *ale-options.javascript_prettier_eslint_options*
 306                                      *g:ale_javascript_prettier_eslint_options*
 307                                      *b:ale_javascript_prettier_eslint_options*
 308 javascript_prettier_eslint_options
 309 g:ale_javascript_prettier_eslint_options
 310   Type: |String|
 311   Default: `''`
 312
 313   This variable can be set to pass additional options to prettier-eslint.
 314
 315
 316                             *ale-options.javascript_prettier_eslint_use_global*
 317                                   *g:ale_javascript_prettier_eslint_use_global*
 318                                   *b:ale_javascript_prettier_eslint_use_global*
 319 javascript_prettier_eslint_use_global
 320 g:ale_javascript_prettier_eslint_use_global
 321   Type: |Number|
 322   Default: `get(g:, 'ale_use_global_executables', 0)`
 323
 324   See |ale-integrations-local-executables|
 325
 326
 327 ===============================================================================
 328 prettier-standard                            *ale-javascript-prettier-standard*
 329
 330
 331                           *ale-options.javascript_prettier_standard_executable*
 332                                 *g:ale_javascript_prettier_standard_executable*
 333                                 *b:ale_javascript_prettier_standard_executable*
 334 javascript_prettier_standard_executable
 335 g:ale_javascript_prettier_standard_executable
 336   Type: |String|
 337   Default: `'prettier-standard'`
 338
 339   See |ale-integrations-local-executables|
 340
 341
 342                              *ale-options.javascript_prettier_standard_options*
 343                                    *g:ale_javascript_prettier_standard_options*
 344                                    *b:ale_javascript_prettier_standard_options*
 345 javascript_prettier_standard_options
 346 g:ale_javascript_prettier_standard_options
 347   Type: |String|
 348   Default: `''`
 349
 350   This variable can be set to pass additional options to prettier-standard.
 351
 352
 353                           *ale-options.javascript_prettier_standard_use_global*
 354                                 *g:ale_javascript_prettier_standard_use_global*
 355                                 *b:ale_javascript_prettier_standard_use_global*
 356 javascript_prettier_standard_use_global
 357 g:ale_javascript_prettier_standard_use_global
 358   Type: |Number|
 359   Default: `get(g:, 'ale_use_global_executables', 0)`
 360
 361   See |ale-integrations-local-executables|
 362
 363
 364 ===============================================================================
 365 standard                                              *ale-javascript-standard*
 366
 367                                    *ale-options.javascript_standard_executable*
 368                                          *g:ale_javascript_standard_executable*
 369                                          *b:ale_javascript_standard_executable*
 370 javascript_standard_executable
 371 g:ale_javascript_standard_executable
 372   Type: |String|
 373   Default: `'standard'`
 374
 375   See |ale-integrations-local-executables|
 376
 377                                       *ale-options.javascript_standard_options*
 378                                             *g:ale_javascript_standard_options*
 379                                             *b:ale_javascript_standard_options*
 380 javascript_standard_options
 381 g:ale_javascript_standard_options
 382   Type: |String|
 383   Default: `''`
 384
 385   This variable can be set to pass additional options to standard.
 386
 387                                    *ale-options.javascript_standard_use_global*
 388                                          *g:ale_javascript_standard_use_global*
 389                                          *b:ale_javascript_standard_use_global*
 390 javascript_standard_use_global
 391 g:ale_javascript_standard_use_global
 392   Type: |Number|
 393   Default: `get(g:, 'ale_use_global_executables', 0)`
 394
 395   See |ale-integrations-local-executables|
 396
 397
 398 ===============================================================================
 399 xo                                                          *ale-javascript-xo*
 400
 401                                          *ale-options.javascript_xo_executable*
 402                                                *g:ale_javascript_xo_executable*
 403                                                *b:ale_javascript_xo_executable*
 404 javascript_xo_executable
 405 g:ale_javascript_xo_executable
 406   Type: |String|
 407   Default: `'xo'`
 408
 409   See |ale-integrations-local-executables|
 410
 411                                             *ale-options.javascript_xo_options*
 412                                                   *g:ale_javascript_xo_options*
 413                                                   *b:ale_javascript_xo_options*
 414 javascript_xo_options
 415 g:ale_javascript_xo_options
 416   Type: |String|
 417   Default: `''`
 418
 419   This variable can be set to pass additional options to xo.
 420
 421                                          *ale-options.javascript_xo_use_global*
 422                                                *g:ale_javascript_xo_use_global*
 423                                                *b:ale_javascript_xo_use_global*
 424 javascript_xo_use_global
 425 g:ale_javascript_xo_use_global
 426   Type: |Number|
 427   Default: `get(g:, 'ale_use_global_executables', 0)`
 428
 429   See |ale-integrations-local-executables|
 430
 431
 432 ===============================================================================
 433   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: