diff options
author | Nathan <me@nathanherald.com> | 2022-01-04 13:49:03 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-04 21:49:03 +0900 |
commit | ac0495df6ef44deff556ed450f503875370f0812 (patch) | |
tree | 698e7d781c176843afaebe7b6d4a0865ca68a089 /doc | |
parent | 48f68598cb49c5711f31d9ed204a4f0fdc390330 (diff) | |
download | ale-ac0495df6ef44deff556ed450f503875370f0812.zip |
Add dprint fixer (#4024)
* Add dprint fixer
* Fix windows tests
* dd dprint documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ale-dockerfile.txt | 6 | ||||
-rw-r--r-- | doc/ale-javascript.txt | 6 | ||||
-rw-r--r-- | doc/ale-json.txt | 6 | ||||
-rw-r--r-- | doc/ale-markdown.txt | 6 | ||||
-rw-r--r-- | doc/ale-sql.txt | 7 | ||||
-rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 7 | ||||
-rw-r--r-- | doc/ale-toml.txt | 12 | ||||
-rw-r--r-- | doc/ale-typescript.txt | 6 | ||||
-rw-r--r-- | doc/ale.txt | 57 |
9 files changed, 110 insertions, 3 deletions
diff --git a/doc/ale-dockerfile.txt b/doc/ale-dockerfile.txt index 284c6a10..b6e87623 100644 --- a/doc/ale-dockerfile.txt +++ b/doc/ale-dockerfile.txt @@ -26,6 +26,12 @@ g:ale_dockerfile_dockerfile_lint_options =============================================================================== +dprint *ale-dockerfile-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile + + +=============================================================================== hadolint *ale-dockerfile-hadolint* hadolint can be found at: https://github.com/hadolint/hadolint diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 087909c8..7d626efe 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -36,6 +36,12 @@ Check the docs over at |ale-typescript-deno|. =============================================================================== +dprint *ale-javascript-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/typescript + + +=============================================================================== eslint *ale-javascript-eslint* g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable* diff --git a/doc/ale-json.txt b/doc/ale-json.txt index a79add81..67db0b74 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -9,6 +9,12 @@ See |ale-cspell-options| =============================================================================== +dprint *ale-json-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/json + + +=============================================================================== eslint *ale-json-eslint* The `eslint` linter for JSON uses the JavaScript options for `eslint`; see: diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt index 25065b55..6ba78ff0 100644 --- a/doc/ale-markdown.txt +++ b/doc/ale-markdown.txt @@ -9,6 +9,12 @@ See |ale-cspell-options| =============================================================================== +dprint *ale-markdown-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/markdown + + +=============================================================================== markdownlint *ale-markdown-markdownlint* g:ale_markdown_markdownlint_options *g:ale_markdown_markdownlint_options* diff --git a/doc/ale-sql.txt b/doc/ale-sql.txt index 398e24d3..80929264 100644 --- a/doc/ale-sql.txt +++ b/doc/ale-sql.txt @@ -3,6 +3,13 @@ ALE SQL Integration *ale-sql-options* =============================================================================== +dprint *ale-sql-dprint* + +See |ale-dprint-options| +and https://github.com/dprint/dprint-plugin-sql/releases + + +=============================================================================== pgformatter *ale-sql-pgformatter* g:ale_sql_pgformatter_executable *g:ale_sql_pgformatter_executable* diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index f12e0c87..16f18074 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -147,6 +147,7 @@ Notes: * `dhall-lint` * Dockerfile * `dockerfile_lint` + * `dprint` * `hadolint` * Elixir * `credo` @@ -267,6 +268,7 @@ Notes: * JavaScript * `cspell` * `deno` + * `dprint` * `eslint` * `fecs` * `flow` @@ -280,6 +282,7 @@ Notes: * `xo` * JSON * `cspell` + * `dprint` * `eslint` * `fixjson` * `jq` @@ -537,6 +540,7 @@ Notes: * `solhint` * `solium` * SQL + * `dprint` * `pgformatter` * `sql-lint` * `sqlfmt` @@ -583,9 +587,12 @@ Notes: * Thrift * `thrift` * `thriftcheck` +* TOML + * `dprint` * TypeScript * `cspell` * `deno` + * `dprint` * `eslint` * `fecs` * `prettier` diff --git a/doc/ale-toml.txt b/doc/ale-toml.txt new file mode 100644 index 00000000..222a91f4 --- /dev/null +++ b/doc/ale-toml.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE TOML Integration *ale-toml-options* + + +=============================================================================== +dprint *ale-toml-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/toml + + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt index eefcfed1..788a7a5c 100644 --- a/doc/ale-typescript.txt +++ b/doc/ale-typescript.txt @@ -51,6 +51,12 @@ g:ale_deno_importMap *g:ale_deno_importMap* =============================================================================== +dprint *ale-typescript-dprint* + +See |ale-dprint-options| and https://dprint.dev/plugins/typescript + + +=============================================================================== eslint *ale-typescript-eslint* Because of how TypeScript compiles code to JavaScript and how interrelated diff --git a/doc/ale.txt b/doc/ale.txt index 8d98d511..65439fb1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2597,7 +2597,50 @@ g:ale_cspell_use_global *g:ale_cspell_use_global* ------------------------------------------------------------------------------- -7.3. Options for languagetool *ale-languagetool-options* +7.3. Options for dprint *ale-dprint-options* + +`dprint` is a fixer for many file types, including: (java|type)script, +json(c?), markdown, and more. See https://dprint.dev/plugins for an up-to-date +list of supported plugins and their configuration options. + +g:ale_dprint_executable *g:ale_dprint_executable* + *b:ale_dprint_executable* + Type: |String| + Default: `'dprint'` + + See |ale-integrations-local-executables| + + +g:ale_dprint_config *g:ale_dprint_config* + *b:ale_dprint_config* + Type: |String| + Default: `'dprint.json'` + + This variable can be changed to provide a config file to `dprint`. The + default is the nearest `dprint.json` searching upward from the current + buffer. + + See https://dprint.dev/config and https://plugins.dprint.dev + + +g:ale_dprint_options *g:ale_dprint_options* + *b:ale_dprint_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to `dprint`. + + +g:ale_dprint_use_global *g:ale_dprint_use_global* + *b:ale_dprint_use_global* + Type: |Number| + Default: `get(g: 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| + + +------------------------------------------------------------------------------- +7.4. Options for languagetool *ale-languagetool-options* g:ale_languagetool_executable *g:ale_languagetool_executable* *b:ale_languagetool_executable* @@ -2617,7 +2660,7 @@ g:ale_languagetool_options *g:ale_languagetool_options* ------------------------------------------------------------------------------- -7.4. Options for write-good *ale-write-good-options* +7.5. Options for write-good *ale-write-good-options* The options for `write-good` are shared between all filetypes, so options can be configured once. @@ -2647,7 +2690,7 @@ g:ale_writegood_use_global *g:ale_writegood_use_global* ------------------------------------------------------------------------------- -7.5. Other Linter/Fixer Options *ale-other-integration-options* +7.6. Other Linter/Fixer Options *ale-other-integration-options* ALE supports a very wide variety of tools. Other linter or fixer options are documented in additional help files. @@ -2752,6 +2795,7 @@ documented in additional help files. dhall-lint............................|ale-dhall-lint| dockerfile..............................|ale-dockerfile-options| dockerfile_lint.......................|ale-dockerfile-dockerfile_lint| + dprint................................|ale-dockerfile-dprint| hadolint..............................|ale-dockerfile-hadolint| elixir..................................|ale-elixir-options| mix...................................|ale-elixir-mix| @@ -2863,6 +2907,7 @@ documented in additional help files. javascript..............................|ale-javascript-options| cspell................................|ale-javascript-cspell| deno..................................|ale-javascript-deno| + dprint................................|ale-javascript-dprint| eslint................................|ale-javascript-eslint| fecs..................................|ale-javascript-fecs| flow..................................|ale-javascript-flow| @@ -2876,6 +2921,7 @@ documented in additional help files. xo....................................|ale-javascript-xo| json....................................|ale-json-options| cspell................................|ale-json-cspell| + dprint................................|ale-json-dprint| eslint................................|ale-json-eslint| fixjson...............................|ale-json-fixjson| jsonlint..............................|ale-json-jsonlint| @@ -2914,6 +2960,7 @@ documented in additional help files. stylua................................|ale-lua-stylua| markdown................................|ale-markdown-options| cspell................................|ale-markdown-cspell| + dprint................................|ale-markdown-dprint| markdownlint..........................|ale-markdown-markdownlint| mdl...................................|ale-markdown-mdl| pandoc................................|ale-markdown-pandoc| @@ -3095,6 +3142,7 @@ documented in additional help files. spec....................................|ale-spec-options| rpmlint...............................|ale-spec-rpmlint| sql.....................................|ale-sql-options| + dprint................................|ale-sql-dprint| pgformatter...........................|ale-sql-pgformatter| sqlfmt................................|ale-sql-sqlfmt| sqlformat.............................|ale-sql-sqlformat| @@ -3136,9 +3184,12 @@ documented in additional help files. thrift..................................|ale-thrift-options| thrift................................|ale-thrift-thrift| thriftcheck...........................|ale-thrift-thriftcheck| + toml....................................|ale-toml-options| + dprint................................|ale-toml-dprint| typescript..............................|ale-typescript-options| cspell................................|ale-typescript-cspell| deno..................................|ale-typescript-deno| + dprint................................|ale-typescript-dprint| eslint................................|ale-typescript-eslint| prettier..............................|ale-typescript-prettier| standard..............................|ale-typescript-standard| |