Skip to content

Commit fc0d3ed

Browse files
committed
dd dprint documentation
1 parent a08374a commit fc0d3ed

File tree

10 files changed

+113
-3
lines changed

10 files changed

+113
-3
lines changed

doc/ale-dockerfile.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ g:ale_dockerfile_dockerfile_lint_options
2525
the dockerfile lint invocation - like custom rule file definitions.
2626

2727

28+
===============================================================================
29+
dprint *ale-dockerfile-dprint*
30+
31+
See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
32+
33+
2834
===============================================================================
2935
hadolint *ale-dockerfile-hadolint*
3036

doc/ale-javascript.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ deno *ale-javascript-deno*
3535
Check the docs over at |ale-typescript-deno|.
3636

3737

38+
===============================================================================
39+
dprint *ale-javascript-dprint*
40+
41+
See |ale-dprint-options| and https://dprint.dev/plugins/typescript
42+
43+
3844
===============================================================================
3945
eslint *ale-javascript-eslint*
4046

doc/ale-json.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ cspell *ale-json-cspell*
88
See |ale-cspell-options|
99

1010

11+
===============================================================================
12+
dprint *ale-json-dprint*
13+
14+
See |ale-dprint-options| and https://dprint.dev/plugins/json
15+
16+
1117
===============================================================================
1218
eslint *ale-json-eslint*
1319

doc/ale-markdown.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ cspell *ale-markdown-cspell*
88
See |ale-cspell-options|
99

1010

11+
===============================================================================
12+
dprint *ale-markdown-dprint*
13+
14+
See |ale-dprint-options| and https://dprint.dev/plugins/markdown
15+
16+
1117
===============================================================================
1218
markdownlint *ale-markdown-markdownlint*
1319

doc/ale-sql.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
ALE SQL Integration *ale-sql-options*
33

44

5+
===============================================================================
6+
dprint *ale-sql-dprint*
7+
8+
See |ale-dprint-options|
9+
and https://github.com/dprint/dprint-plugin-sql/releases
10+
11+
512
===============================================================================
613
pgformatter *ale-sql-pgformatter*
714

doc/ale-supported-languages-and-tools.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ Notes:
147147
* `dhall-lint`
148148
* Dockerfile
149149
* `dockerfile_lint`
150+
* `dprint`
150151
* `hadolint`
151152
* Elixir
152153
* `credo`
@@ -281,6 +282,7 @@ Notes:
281282
* `xo`
282283
* JSON
283284
* `cspell`
285+
* `dprint`
284286
* `eslint`
285287
* `fixjson`
286288
* `jq`
@@ -538,6 +540,7 @@ Notes:
538540
* `solhint`
539541
* `solium`
540542
* SQL
543+
* `dprint`
541544
* `pgformatter`
542545
* `sql-lint`
543546
* `sqlfmt`
@@ -584,6 +587,8 @@ Notes:
584587
* Thrift
585588
* `thrift`
586589
* `thriftcheck`
590+
* TOML
591+
* `dprint`
587592
* TypeScript
588593
* `cspell`
589594
* `deno`

doc/ale-toml.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
===============================================================================
2+
ALE TOML Integration *ale-toml-options*
3+
4+
5+
===============================================================================
6+
dprint *ale-toml-dprint*
7+
8+
See |ale-dprint-options| and https://dprint.dev/plugins/toml
9+
10+
11+
===============================================================================
12+
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

doc/ale-typescript.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ g:ale_deno_importMap *g:ale_deno_importMap*
5050
Specify the import map filename to load url maps in a deno project.
5151

5252

53+
===============================================================================
54+
dprint *ale-typescript-dprint*
55+
56+
See |ale-dprint-options| and https://dprint.dev/plugins/typescript
57+
58+
5359
===============================================================================
5460
eslint *ale-typescript-eslint*
5561

doc/ale.txt

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2597,7 +2597,50 @@ g:ale_cspell_use_global *g:ale_cspell_use_global*
25972597

25982598

25992599
-------------------------------------------------------------------------------
2600-
7.3. Options for languagetool *ale-languagetool-options*
2600+
7.3. Options for dprint *ale-dprint-options*
2601+
2602+
`dprint` is a fixer for many file types, including: (java|type)script,
2603+
json(c?), markdown, and more. See https://dprint.dev/plugins for an up-to-date
2604+
list of supported plugins and their configuration options.
2605+
2606+
g:ale_dprint_executable *g:ale_dprint_executable*
2607+
*b:ale_dprint_executable*
2608+
Type: |String|
2609+
Default: `'dprint'`
2610+
2611+
See |ale-integrations-local-executables|
2612+
2613+
2614+
g:ale_dprint_config *g:ale_dprint_config*
2615+
*b:ale_dprint_config*
2616+
Type: |String|
2617+
Default: `'dprint.json'`
2618+
2619+
This variable can be changed to provide a config file to `dprint`. The
2620+
default is the nearest `dprint.json` searching upward from the current
2621+
buffer.
2622+
2623+
See https://dprint.dev/config and https://plugins.dprint.dev
2624+
2625+
2626+
g:ale_dprint_options *g:ale_dprint_options*
2627+
*b:ale_dprint_options*
2628+
Type: |String|
2629+
Default: `''`
2630+
2631+
This variable can be set to pass additional options to `dprint`.
2632+
2633+
2634+
g:ale_dprint_use_global *g:ale_dprint_use_global*
2635+
*b:ale_dprint_use_global*
2636+
Type: |Number|
2637+
Default: `get(g: 'ale_use_global_executables', 0)`
2638+
2639+
See |ale-integrations-local-executables|
2640+
2641+
2642+
-------------------------------------------------------------------------------
2643+
7.4. Options for languagetool *ale-languagetool-options*
26012644

26022645
g:ale_languagetool_executable *g:ale_languagetool_executable*
26032646
*b:ale_languagetool_executable*
@@ -2617,7 +2660,7 @@ g:ale_languagetool_options *g:ale_languagetool_options*
26172660

26182661

26192662
-------------------------------------------------------------------------------
2620-
7.4. Options for write-good *ale-write-good-options*
2663+
7.5. Options for write-good *ale-write-good-options*
26212664

26222665
The options for `write-good` are shared between all filetypes, so options can
26232666
be configured once.
@@ -2647,7 +2690,7 @@ g:ale_writegood_use_global *g:ale_writegood_use_global*
26472690

26482691

26492692
-------------------------------------------------------------------------------
2650-
7.5. Other Linter/Fixer Options *ale-other-integration-options*
2693+
7.6. Other Linter/Fixer Options *ale-other-integration-options*
26512694

26522695
ALE supports a very wide variety of tools. Other linter or fixer options are
26532696
documented in additional help files.
@@ -2752,6 +2795,7 @@ documented in additional help files.
27522795
dhall-lint............................|ale-dhall-lint|
27532796
dockerfile..............................|ale-dockerfile-options|
27542797
dockerfile_lint.......................|ale-dockerfile-dockerfile_lint|
2798+
dprint................................|ale-dockerfile-dprint|
27552799
hadolint..............................|ale-dockerfile-hadolint|
27562800
elixir..................................|ale-elixir-options|
27572801
mix...................................|ale-elixir-mix|
@@ -2863,6 +2907,7 @@ documented in additional help files.
28632907
javascript..............................|ale-javascript-options|
28642908
cspell................................|ale-javascript-cspell|
28652909
deno..................................|ale-javascript-deno|
2910+
dprint................................|ale-javascript-dprint|
28662911
eslint................................|ale-javascript-eslint|
28672912
fecs..................................|ale-javascript-fecs|
28682913
flow..................................|ale-javascript-flow|
@@ -2876,6 +2921,7 @@ documented in additional help files.
28762921
xo....................................|ale-javascript-xo|
28772922
json....................................|ale-json-options|
28782923
cspell................................|ale-json-cspell|
2924+
dprint................................|ale-json-dprint|
28792925
eslint................................|ale-json-eslint|
28802926
fixjson...............................|ale-json-fixjson|
28812927
jsonlint..............................|ale-json-jsonlint|
@@ -2914,6 +2960,7 @@ documented in additional help files.
29142960
stylua................................|ale-lua-stylua|
29152961
markdown................................|ale-markdown-options|
29162962
cspell................................|ale-markdown-cspell|
2963+
dprint................................|ale-markdown-dprint|
29172964
markdownlint..........................|ale-markdown-markdownlint|
29182965
mdl...................................|ale-markdown-mdl|
29192966
pandoc................................|ale-markdown-pandoc|
@@ -3095,6 +3142,7 @@ documented in additional help files.
30953142
spec....................................|ale-spec-options|
30963143
rpmlint...............................|ale-spec-rpmlint|
30973144
sql.....................................|ale-sql-options|
3145+
dprint................................|ale-sql-dprint|
30983146
pgformatter...........................|ale-sql-pgformatter|
30993147
sqlfmt................................|ale-sql-sqlfmt|
31003148
sqlformat.............................|ale-sql-sqlformat|
@@ -3136,9 +3184,12 @@ documented in additional help files.
31363184
thrift..................................|ale-thrift-options|
31373185
thrift................................|ale-thrift-thrift|
31383186
thriftcheck...........................|ale-thrift-thriftcheck|
3187+
toml....................................|ale-toml-options|
3188+
dprint................................|ale-toml-dprint|
31393189
typescript..............................|ale-typescript-options|
31403190
cspell................................|ale-typescript-cspell|
31413191
deno..................................|ale-typescript-deno|
3192+
dprint................................|ale-typescript-dprint|
31423193
eslint................................|ale-typescript-eslint|
31433194
prettier..............................|ale-typescript-prettier|
31443195
standard..............................|ale-typescript-standard|

supported-tools.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ formatting.
156156
* [dhall-lint](https://github.com/dhall-lang/dhall-lang)
157157
* Dockerfile
158158
* [dockerfile_lint](https://github.com/projectatomic/dockerfile_lint)
159+
* [dprint](https://dprint.dev)
159160
* [hadolint](https://github.com/hadolint/hadolint)
160161
* Elixir
161162
* [credo](https://github.com/rrrene/credo)
@@ -290,6 +291,7 @@ formatting.
290291
* [xo](https://github.com/sindresorhus/xo)
291292
* JSON
292293
* [cspell](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)
294+
* [dprint](https://dprint.dev)
293295
* [eslint](http://eslint.org/)
294296
* [fixjson](https://github.com/rhysd/fixjson)
295297
* [jq](https://stedolan.github.io/jq/)
@@ -547,6 +549,7 @@ formatting.
547549
* [solhint](https://github.com/protofire/solhint)
548550
* [solium](https://github.com/duaraghav8/Solium)
549551
* SQL
552+
* [dprint](https://dprint.dev)
550553
* [pgformatter](https://github.com/darold/pgFormatter)
551554
* [sql-lint](https://github.com/joereynolds/sql-lint)
552555
* [sqlfmt](https://github.com/jackc/sqlfmt)
@@ -593,6 +596,8 @@ formatting.
593596
* Thrift
594597
* [thrift](http://thrift.apache.org/)
595598
* [thriftcheck](https://github.com/pinterest/thriftcheck)
599+
* TOML
600+
* [dprint](https://dprint.dev)
596601
* TypeScript
597602
* [cspell](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)
598603
* [deno](https://deno.land/)

0 commit comments

Comments
 (0)