Skip to content

Commit 8bcbb29

Browse files
authored
fix: #4356 Missing racket documentation (#4384)
This commit adds vim help docs for `raco_fmt` and `racket-langserver`.
1 parent 42a17de commit 8bcbb29

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

doc/ale-racket.txt

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
===============================================================================
2+
ALE Racket Integration *ale-racket-options*
3+
4+
===============================================================================
5+
racket_langserver *ale-racket-langserver*
6+
7+
1. Install racket-langserver as described here:
8+
https://github.com/jeapostrophe/racket-langserver
9+
2. Have `racket` available in the `$PATH` environment variable, currently there
10+
is no way to specify path to custom location of `racket`.
11+
3. set `racket_langserver` as a linter for `racket` like: >
12+
let g:ale_linters['racket'] += ['racket_langserver']
13+
14+
You should be able to see linter results and use LSP features of `ALE` like
15+
`ALEGoToDefinition` with `racket-langserver`.
16+
17+
===============================================================================
18+
raco_fmt *ale-racket-raco-fmt*
19+
20+
g:ale_racket_raco_fmt_executable *g:ale_racket_raco_fmt_executable*
21+
*b:ale_racket_raco_fmt_executable*
22+
Type: |String|
23+
Default: `'raco'`
24+
25+
If the `raco` excutable is not in the `$PATH` environment variable, or you
26+
prefer to use one installed in a custom location, set this option to the
27+
path to the specific `raco` executable.
28+
29+
g:ale_racket_raco_fmt_options *g:ale_racket_raco_fmt_options*
30+
*b:ale_racket_raco_fmt_options*
31+
Type: |String|
32+
Default: `''`
33+
34+
Use this variable to pass command-line flags/parameters to `raco_fmt`
35+
36+
For example, set the page width limit to 40 >
37+
let g:ale_racket_raco_fmt_options = '--width 40'
38+
39+
40+
===============================================================================
41+
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

doc/ale.txt

+3
Original file line numberDiff line numberDiff line change
@@ -3180,6 +3180,9 @@ documented in additional help files.
31803180
languageserver........................|ale-r-languageserver|
31813181
lintr.................................|ale-r-lintr|
31823182
styler................................|ale-r-styler|
3183+
racket..................................|ale-racket-options|
3184+
racket_langserver.....................|ale-racket-langserver|
3185+
raco_fmt..............................|ale-racket-raco-fmt|
31833186
reasonml................................|ale-reasonml-options|
31843187
merlin................................|ale-reasonml-merlin|
31853188
ols...................................|ale-reasonml-ols|

0 commit comments

Comments
 (0)