mirror of
https://github.com/dense-analysis/ale.git
synced 2026-07-29 11:16:46 +08:00
40cbe2121b
* fix(tests): fix ale_c_build_dir_names being unset in tests (#5109) - Use ale#Set() to set the ale_c_build_dir_names variable. - Ensure SetUpLinterTest() is called before any Save commands in tests. - Add c.vim to runtime before non-linter tests are executed. - Remove workarounds in c.vim. * feat: Load Prettier from cjs also * Add support for mdformat --------- Co-authored-by: w0rp <devw0rp@gmail.com>
372 lines
15 KiB
Plaintext
372 lines
15 KiB
Plaintext
===============================================================================
|
|
ALE Markdown Integration *ale-markdown-options*
|
|
|
|
|
|
===============================================================================
|
|
cspell *ale-markdown-cspell*
|
|
|
|
See |ale-cspell-options|
|
|
|
|
|
|
===============================================================================
|
|
dprint *ale-markdown-dprint*
|
|
|
|
See |ale-dprint-options| and https://dprint.dev/plugins/markdown/.
|
|
|
|
|
|
===============================================================================
|
|
harper *ale-markdown-harper*
|
|
|
|
*ale-options.markdown_harper_config*
|
|
*g:ale_markdown_harper_config*
|
|
*b:ale_markdown_harper_config*
|
|
markdown_harper_config
|
|
g:ale_markdown_harper_config
|
|
Type: |Dictionary|
|
|
Default: `{'harper-ls': {'diagnosticSeverity': 'hint', 'dialect': 'American', ...}}`
|
|
|
|
Dictionary passed to harper-ls as LSP workspace configuration. The default
|
|
enables spell check, sentence capitalization, repeated words, long
|
|
sentences, a/an errors, and spacing rules, and disables spelled-out numbers
|
|
and wrong-quote checks.
|
|
|
|
Example: >
|
|
let g:ale_markdown_harper_config = {
|
|
\ 'harper-ls': {
|
|
\ 'diagnosticSeverity': 'warning',
|
|
\ 'linters': {
|
|
\ 'SpellCheck': v:true,
|
|
\ 'LongSentences': v:false,
|
|
\ },
|
|
\ },
|
|
\}
|
|
<
|
|
|
|
|
|
===============================================================================
|
|
markdownlint *ale-markdown-markdownlint*
|
|
|
|
*ale-options.markdown_markdownlint_executable*
|
|
*g:ale_markdown_markdownlint_executable*
|
|
*b:ale_markdown_markdownlint_executable*
|
|
markdown_markdownlint_executable
|
|
g:ale_markdown_markdownlint_executable
|
|
Type: |String|
|
|
Default: `'markdownlint'`
|
|
|
|
Override the invoked `markdownlint` binary. You can use other binaries such as
|
|
`markdownlint-cli2`.
|
|
|
|
*ale-options.markdown_markdownlint_options*
|
|
*g:ale_markdown_markdownlint_options*
|
|
*b:ale_markdown_markdownlint_options*
|
|
markdown_markdownlint_options
|
|
g:ale_markdown_markdownlint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to markdownlint.
|
|
|
|
|
|
===============================================================================
|
|
marksman *ale-markdown-marksman*
|
|
|
|
*ale-options.markdown_marksman_executable*
|
|
*g:ale_markdown_marksman_executable*
|
|
*b:ale_markdown_marksman_executable*
|
|
markdown_marksman_executable
|
|
g:ale_markdown_marksman_executable
|
|
Type: |String|
|
|
Default: `'marksman'`
|
|
|
|
Override the invoked `marksman` binary.
|
|
|
|
|
|
===============================================================================
|
|
mdformat *ale-markdown-mdformat*
|
|
|
|
*ale-options.markdown_mdformat_executable*
|
|
*g:ale_markdown_mdformat_executable*
|
|
*b:ale_markdown_mdformat_executable*
|
|
markdown_mdformat_executable
|
|
g:ale_markdown_mdformat_executable
|
|
Type: |String|
|
|
Default: `'mdformat'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
Set this to `'pipenv'` to invoke `pipenv run mdformat`.
|
|
Set this to `'poetry'` to invoke `poetry run mdformat`.
|
|
Set this to `'uv'` to invoke `uv run mdformat`.
|
|
|
|
*ale-options.markdown_mdformat_options*
|
|
*g:ale_markdown_mdformat_options*
|
|
*b:ale_markdown_mdformat_options*
|
|
markdown_mdformat_options
|
|
g:ale_markdown_mdformat_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to add command-line arguments to mdformat.
|
|
|
|
*ale-options.markdown_mdformat_use_global*
|
|
*g:ale_markdown_mdformat_use_global*
|
|
*b:ale_markdown_mdformat_use_global*
|
|
markdown_mdformat_use_global
|
|
g:ale_markdown_mdformat_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.markdown_mdformat_auto_pipenv*
|
|
*g:ale_markdown_mdformat_auto_pipenv*
|
|
*b:ale_markdown_mdformat_auto_pipenv*
|
|
markdown_mdformat_auto_pipenv
|
|
g:ale_markdown_mdformat_auto_pipenv
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Detect whether the file is inside a pipenv, and set the executable to
|
|
`pipenv` if true. This is overridden by a manually-set executable.
|
|
|
|
*ale-options.markdown_mdformat_auto_poetry*
|
|
*g:ale_markdown_mdformat_auto_poetry*
|
|
*b:ale_markdown_mdformat_auto_poetry*
|
|
markdown_mdformat_auto_poetry
|
|
g:ale_markdown_mdformat_auto_poetry
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Detect whether the file is inside a Poetry project, and set the executable
|
|
to `poetry` if true. This is overridden by a manually-set executable.
|
|
|
|
*ale-options.markdown_mdformat_auto_uv*
|
|
*g:ale_markdown_mdformat_auto_uv*
|
|
*b:ale_markdown_mdformat_auto_uv*
|
|
markdown_mdformat_auto_uv
|
|
g:ale_markdown_mdformat_auto_uv
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Detect whether the file is inside a uv project, and set the executable to
|
|
`uv` if true. This is overridden by a manually-set executable.
|
|
|
|
|
|
===============================================================================
|
|
mdl *ale-markdown-mdl*
|
|
|
|
*ale-options.markdown_mdl_executable*
|
|
*g:ale_markdown_mdl_executable*
|
|
*b:ale_markdown_mdl_executable*
|
|
markdown_mdl_executable
|
|
g:ale_markdown_mdl_executable
|
|
Type: |String|
|
|
Default: `'mdl'`
|
|
|
|
Override the invoked mdl binary. This is useful for running mdl from
|
|
binstubs or a bundle.
|
|
|
|
*ale-options.markdown_mdl_options*
|
|
*g:ale_markdown_mdl_options*
|
|
*b:ale_markdown_mdl_options*
|
|
markdown_mdl_options
|
|
g:ale_markdown_mdl_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to mdl.
|
|
|
|
|
|
===============================================================================
|
|
pandoc *ale-markdown-pandoc*
|
|
|
|
*ale-options.markdown_pandoc_executable*
|
|
*g:ale_markdown_pandoc_executable*
|
|
*b:ale_markdown_pandoc_executable*
|
|
markdown_pandoc_executable
|
|
g:ale_markdown_pandoc_executable
|
|
Type: |String|
|
|
Default: `'pandoc'`
|
|
|
|
This variable can be set to specify where to find the pandoc executable
|
|
|
|
*ale-options.markdown_pandoc_options*
|
|
*g:ale_markdown_pandoc_options*
|
|
*b:ale_markdown_pandoc_options*
|
|
markdown_pandoc_options
|
|
g:ale_markdown_pandoc_options
|
|
Type: |String|
|
|
Default: `'-f gfm -t gfm -s -'`
|
|
|
|
This variable can be set to change the default options passed to pandoc
|
|
|
|
|
|
===============================================================================
|
|
prettier *ale-markdown-prettier*
|
|
|
|
See |ale-javascript-prettier| for information about the available options.
|
|
|
|
|
|
===============================================================================
|
|
pymarkdown *ale-markdown-pymarkdown*
|
|
|
|
pymarkdown can be used both as a linter and a fixer for Markdown files.
|
|
|
|
*ale-options.markdown_pymarkdown_executable*
|
|
*g:ale_markdown_pymarkdown_executable*
|
|
*b:ale_markdown_pymarkdown_executable*
|
|
markdown_pymarkdown_executable
|
|
g:ale_markdown_pymarkdown_executable
|
|
Type: |String|
|
|
Default: `'pymarkdown'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
Set this to `'pipenv'` to invoke `'pipenv` `run` `pymarkdown'`.
|
|
Set this to `'poetry'` to invoke `'poetry` `run` `pymarkdown'`.
|
|
|
|
*ale-options.markdown_pymarkdown_options*
|
|
*g:ale_markdown_pymarkdown_options*
|
|
*b:ale_markdown_pymarkdown_options*
|
|
markdown_pymarkdown_options
|
|
g:ale_markdown_pymarkdown_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to add command-line arguments to the
|
|
pymarkdown invocation.
|
|
|
|
*ale-options.markdown_pymarkdown_use_global*
|
|
*g:ale_markdown_pymarkdown_use_global*
|
|
*b:ale_markdown_pymarkdown_use_global*
|
|
markdown_pymarkdown_use_global
|
|
g:ale_markdown_pymarkdown_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.markdown_pymarkdown_auto_pipenv*
|
|
*g:ale_markdown_pymarkdown_auto_pipenv*
|
|
*b:ale_markdown_pymarkdown_auto_pipenv*
|
|
markdown_pymarkdown_auto_pipenv
|
|
g:ale_markdown_pymarkdown_auto_pipenv
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
if true. This is overridden by a manually-set executable.
|
|
|
|
*ale-options.markdown_pymarkdown_auto_poetry*
|
|
*g:ale_markdown_pymarkdown_auto_poetry*
|
|
*b:ale_markdown_pymarkdown_auto_poetry*
|
|
markdown_pymarkdown_auto_poetry
|
|
g:ale_markdown_pymarkdown_auto_poetry
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Detect whether the file is inside a poetry, and set the executable to `poetry`
|
|
if true. This is overridden by a manually-set executable.
|
|
|
|
*ale-options.markdown_pymarkdown_auto_uv*
|
|
*g:ale_markdown_pymarkdown_auto_uv*
|
|
*b:ale_markdown_pymarkdown_auto_uv*
|
|
markdown_pymarkdown_auto_uv
|
|
g:ale_markdown_pymarkdown_auto_uv
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
Set the executable to `uv` if true. This is overridden by a manually-set
|
|
executable.
|
|
|
|
|
|
===============================================================================
|
|
remark-lint *ale-markdown-remark-lint*
|
|
|
|
*ale-options.markdown_remark_lint_executable*
|
|
*g:ale_markdown_remark_lint_executable*
|
|
*b:ale_markdown_remark_lint_executable*
|
|
markdown_remark_lint_executable
|
|
g:ale_markdown_remark_lint_executable
|
|
Type: |String|
|
|
Default: `'remark'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.markdown_remark_lint_options*
|
|
*g:ale_markdown_remark_lint_options*
|
|
*b:ale_markdown_remark_lint_options*
|
|
markdown_remark_lint_options
|
|
g:ale_markdown_remark_lint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to remark-lint.
|
|
|
|
*ale-options.markdown_remark_lint_use_global*
|
|
*g:ale_markdown_remark_lint_use_global*
|
|
*b:ale_markdown_remark_lint_use_global*
|
|
markdown_remark_lint_use_global
|
|
g:ale_markdown_remark_lint_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
|
|
===============================================================================
|
|
rumdl *ale-markdown-rumdl*
|
|
|
|
*ale-options.markdown_rumdl_executable*
|
|
*g:ale_markdown_rumdl_executable*
|
|
*b:ale_markdown_rumdl_executable*
|
|
markdown_rumdl_executable
|
|
g:ale_markdown_rumdl_executable
|
|
Type: |String|
|
|
Default: `'rumdl'`
|
|
|
|
Override the invoked `rumdl` binary.
|
|
|
|
*ale-options.markdown_rumdl_options*
|
|
*g:ale_markdown_rumdl_options*
|
|
*b:ale_markdown_rumdl_options*
|
|
markdown_rumdl_options
|
|
g:ale_markdown_rumdl_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to `rumdl server`.
|
|
|
|
*ale-options.markdown_rumdl_fmt_options*
|
|
*g:ale_markdown_rumdl_fmt_options*
|
|
*b:ale_markdown_rumdl_fmt_options*
|
|
markdown_rumdl_fmt_options
|
|
g:ale_markdown_rumdl_fmt_options
|
|
Type: |String|
|
|
Default: `'--silent'`
|
|
|
|
This variable can be set to pass additional options to `rumdl fmt`.
|
|
|
|
|
|
===============================================================================
|
|
textlint *ale-markdown-textlint*
|
|
|
|
See |ale-text-textlint|
|
|
|
|
|
|
===============================================================================
|
|
write-good *ale-markdown-write-good*
|
|
|
|
See |ale-write-good-options|
|
|
|
|
|
|
===============================================================================
|
|
redpen *ale-markdown-redpen*
|
|
|
|
See |ale-redpen-options|
|
|
|
|
|
|
===============================================================================
|
|
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|