mirror of
https://github.com/amix/vimrc
synced 2025-08-30 02:44:59 +08:00
Updated plugins
This commit is contained in:
Amir
@ -21,5 +21,24 @@ g:ale_asm_gcc_options *g:ale_asm_gcc_options*
|
||||
This variable can be set to pass additional options to gcc.
|
||||
|
||||
|
||||
===============================================================================
|
||||
llvm_mc *ale-asm-llvm_mc*
|
||||
|
||||
g:ale_asm_clang_executable *g:ale_asm_llvm_mc_executable*
|
||||
*b:ale_asm_llvm_mc_executable*
|
||||
Type: |String|
|
||||
Default: `'llvm-mc'`
|
||||
|
||||
This variable can be changed to use a different executable for llvm-mc.
|
||||
|
||||
|
||||
g:ale_asm_clang_options *g:ale_asm_llvm_mc_options*
|
||||
*b:ale_asm_llvm_mc_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to llvm-mc.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
||||
@ -168,7 +168,7 @@ g:ale_c_cc_header_exts *g:ale_c_cc_header_exts*
|
||||
considered as header files.
|
||||
|
||||
This variable is only used when `'-x c-header'` is used instead of `'-x c'`,
|
||||
see |ale_c_cc_use_header_lang_flag|.
|
||||
see |g:ale_c_cc_use_header_lang_flag|.
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
||||
@ -97,7 +97,7 @@ g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts*
|
||||
considered as header files.
|
||||
|
||||
This variable is only used when `'-x c++-header'` is used instead of `'-x c++'`,
|
||||
see |ale_cpp_cc_use_header_lang_flag|.
|
||||
see |g:ale_cpp_cc_use_header_lang_flag|.
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
||||
@ -15,6 +15,7 @@ CONTENTS *ale-development-contents*
|
||||
4.2. Writing Fixer Tests..............|ale-development-fixer-tests|
|
||||
4.3. Running Tests in a Windows VM....|ale-development-windows-tests|
|
||||
5. Contributing.........................|ale-development-contributing|
|
||||
5.1. Preparing a Release..............|ale-development-release|
|
||||
|
||||
===============================================================================
|
||||
1. Introduction *ale-development-introduction*
|
||||
@ -154,7 +155,7 @@ ALE runs tests with the following versions of Vim in the following
|
||||
environments.
|
||||
|
||||
1. Vim 8.0.0027 on Linux via GitHub Actions.
|
||||
2. Vim 9.0.0133 on Linux via GitHub Actions.
|
||||
2. Vim 9.0.0297 on Linux via GitHub Actions.
|
||||
3. NeoVim 0.2.0 on Linux via GitHub Actions.
|
||||
4. NeoVim 0.8.0 on Linux via GitHub Actions.
|
||||
6. Vim 8 (stable builds) on Windows via AppVeyor.
|
||||
@ -325,7 +326,6 @@ given the above setup are as follows.
|
||||
`AssertLSPProject project_root` - Check the root given to an LSP server.
|
||||
`AssertLSPAddress address` - Check the address to an LSP server.
|
||||
|
||||
|
||||
===============================================================================
|
||||
4.2 Writing Fixer Tests *ale-development-fixer-tests*
|
||||
|
||||
@ -367,7 +367,6 @@ given the above setup are as follows.
|
||||
`AssertFixer results` - Check the fixer results
|
||||
`AssertFixerNotExecuted` - Check that fixers will not be executed.
|
||||
|
||||
|
||||
===============================================================================
|
||||
4.3 Running Tests in a Windows VM *ale-development-windows-tests*
|
||||
|
||||
@ -462,5 +461,76 @@ and profile settings. See: https://docs.github.com/en/account-and-profile/
|
||||
Unless configuring GitHub to expose contact details, commits will be rewritten
|
||||
to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` .
|
||||
|
||||
===============================================================================
|
||||
5.1 Preparing a Release *ale-development-release*
|
||||
|
||||
ALE offers release packages through GitHub, for two reasons:
|
||||
|
||||
1. Some users like to target specific release versions rather than simply
|
||||
installing the plugin from `master`. This includes users who create Linux
|
||||
distribution specific packages from GitHub releases.
|
||||
2. The releases provide a nice way to get an overview of what has changed in
|
||||
ALE over time.
|
||||
|
||||
ALE has no fixed release schedule. Release versions are created whenever the
|
||||
ALE developers feel the need to create one. ALE release versions follow the
|
||||
typical Semantic Versioning scheme. See: https://semver.org/
|
||||
|
||||
Minor version releases for ALE should be the most common, followed by patch
|
||||
releases. Every minor version release should be followed by a `vA.B.x` branch
|
||||
such as `v2.0.x` for version `2.0.0` and every following patch version before
|
||||
`2.1.0`. The `git` branch strategy for patches is to first merge a bug fix to
|
||||
`master`, and then `git cherry-pick` a patch to a branch for a specific
|
||||
version. ALE developers do not generally support anything but `master` or the
|
||||
last minor version.
|
||||
|
||||
Generally ALE releases hit a major version only when there are breaking
|
||||
changes to a public ALE setting or function. A "public" setting or function is
|
||||
defined as any setting or function documented in the `:help` |ale| text file.
|
||||
Major ALE versions ought to be so rare that they only come once a year at
|
||||
most. ALE should not typically introduce any breaking changes.
|
||||
|
||||
If there are ever to be any breaking changes made for ALE, there should first
|
||||
come a minor version release for ALE documenting all of the coming breaking
|
||||
changes to ALE. It should be described how users can prepare for a breaking
|
||||
change that is coming before it is done.
|
||||
|
||||
To create a release for ALE, you will need sufficient permissions in GitHub.
|
||||
Once you do, follow these steps.
|
||||
|
||||
1. Create a new release draft, or edit an existing one. It helps to craft
|
||||
drafts ahead of time and write the last commit ID checked for release notes
|
||||
on the last update to a draft.
|
||||
See the releases page: https://github.com/dense-analysis/ale/releases
|
||||
2. Examine `git log` and read changes made between the last ID checked, or the
|
||||
git tag of the previous release, and the current commit in `master`.
|
||||
3. Write updates in separate sections (except where empty) for:
|
||||
3.a. Breaking Changes
|
||||
3.b. Deprecated Features
|
||||
3.c. New Features
|
||||
3.d. New Linters
|
||||
3.e. New Fixers
|
||||
3.f. Linter Enhancements
|
||||
3.g. Fixer Enhancements
|
||||
3.h. Bugs Fixed
|
||||
4. Once you've finished writing the draft for the release, bump
|
||||
`s:current_ale_version` in `autoload/ale.vim` to the current version, and
|
||||
add a line to `test/test_ale_has.vader` to test for the version. See
|
||||
|ale#Has()| documentation for more information.
|
||||
5. Commit the changes after `./run-tests --fast -q` passes.
|
||||
6. Tag the release with `git tag vA.B.C`, replacing `A`, `B`, and `C` with the
|
||||
version numbers. See `git tag --list` for examples.
|
||||
7. Run `git push` and `git push --tags` to push the commit and the tag.
|
||||
8. Edit the release draft in GitHub, select the tag you just pushed, and
|
||||
publish the draft.
|
||||
9. If you're creating a new major or minor version: `git checkout -b vA.B.x`,
|
||||
replacing `A` and `B` with the major and minor versions. `git push` the new
|
||||
branch, and the GitHub branch protection settings should automatically
|
||||
apply to the new release branch.
|
||||
10. You have already completed the last step.
|
||||
|
||||
Have fun creating ALE releases. Drink responsibly, or not at all, which is the
|
||||
preference of w0rp.
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
||||
@ -269,6 +269,21 @@ g:ale_go_gopls_options *g:ale_go_gopls_options*
|
||||
Command-line options passed to the gopls executable. See `gopls -h`.
|
||||
|
||||
|
||||
g:ale_go_gopls_fix_executable *g:ale_go_gopls_fix_executable*
|
||||
*b:ale_go_gopls_fix_executable*
|
||||
Type: |String|
|
||||
Default: `'gopls'`
|
||||
|
||||
Executable to run to use as the gopls fixer.
|
||||
|
||||
g:ale_go_gopls_fix_options *g:ale_go_gopls_fix_options*
|
||||
*b:ale_go_gopls_fix_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
Options to pass to the gopls fixer.
|
||||
|
||||
|
||||
g:ale_go_gopls_init_options *g:ale_go_gopls_init_options*
|
||||
*b:ale_go_gopls_init_options*
|
||||
Type: |Dictionary|
|
||||
|
||||
@ -102,6 +102,25 @@ prettier *ale-html-prettier*
|
||||
See |ale-javascript-prettier| for information about the available options.
|
||||
|
||||
|
||||
===============================================================================
|
||||
rustywind *ale-html-rustywind*
|
||||
|
||||
g:ale_html_rustywind_executable *g:ale_html_rustywind_executable*
|
||||
*b:ale_html_rustywind_executable*
|
||||
Type: |String|
|
||||
Default: `'rustywind'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_html_rustywind_options *g:ale_html_rustywind_options*
|
||||
*b:ale_html_rustywind_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to modify flags given to rustywind.
|
||||
|
||||
|
||||
===============================================================================
|
||||
stylelint *ale-html-stylelint*
|
||||
|
||||
|
||||
@ -27,6 +27,30 @@ g:ale_lua_lua_format_options *g:ale_lua_lua_format_options*
|
||||
This variable can be set to pass additional options to lua-format.
|
||||
|
||||
|
||||
===============================================================================
|
||||
lua-language-server *ale-lua-lua-language-server*
|
||||
*ale-lua-language-server*
|
||||
|
||||
g:ale_lua_language_server_executable *g:ale_lua_language_server_executable*
|
||||
*b:ale_lua_language_server_executable*
|
||||
Type: |String|
|
||||
Default: `'lua-language-server'`
|
||||
|
||||
This variable can be changed to set the path to lua-language-server.
|
||||
|
||||
If you have compiled the language server yourself in `/some/path`, the path
|
||||
will be `'/some/path/bin/lua-language-server'`.
|
||||
|
||||
|
||||
g:ale_lua_lua_language_server_config *g:ale_lua_lua_language_server_config*
|
||||
*b:ale_lua_lua_language_server_config*
|
||||
Type: |Dictionary|
|
||||
Default: `{}`
|
||||
|
||||
Dictionary containing configuration settings that will be passed to the
|
||||
language server.
|
||||
|
||||
|
||||
===============================================================================
|
||||
luac *ale-lua-luac*
|
||||
|
||||
|
||||
@ -17,13 +17,13 @@ See |ale-dprint-options| and https://dprint.dev/plugins/markdown
|
||||
===============================================================================
|
||||
markdownlint *ale-markdown-markdownlint*
|
||||
|
||||
g:ale_markdown_markdown_executable *g:ale_markdown_markdownlint_executable*
|
||||
g:ale_markdown_markdownlint_executable *g:ale_markdown_markdownlint_executable*
|
||||
*b:ale_markdown_markdownlint_executable*
|
||||
Type: |String|
|
||||
Default: `'markdownlint'`
|
||||
|
||||
Override the invoked markdownlint binary. You can use other binaries such as
|
||||
markdownlint-cli2.
|
||||
Override the invoked `markdownlint` binary. You can use other binaries such as
|
||||
`markdownlint-cli2`.
|
||||
|
||||
|
||||
g:ale_markdown_markdownlint_options *g:ale_markdown_markdownlint_options*
|
||||
|
||||
@ -2,6 +2,24 @@
|
||||
ALE Nix Integration *ale-nix-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
alejandra *ale-nix-alejandra*
|
||||
|
||||
g:ale_nix_alejandra_executable *g:ale_nix_alejandra_executable*
|
||||
*b:ale_nix_alejandra_executable*
|
||||
Type: |String|
|
||||
Default: `'alejandra'`
|
||||
|
||||
This variable sets the executable used for alejandra.
|
||||
|
||||
g:ale_nix_alejandra_options *g:ale_nix_alejandra_options*
|
||||
*b:ale_nix_alejandra_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to the alejandra fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
nixfmt *ale-nix-nixfmt*
|
||||
|
||||
@ -75,5 +93,23 @@ g:ale_nix_statix_fix_options *g:ale_nix_statix_fix_options*
|
||||
it as a fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
deadnix *ale-nix-deadnix*
|
||||
|
||||
g:ale_nix_deadnix_executable *g:ale_nix_deadnix_executable*
|
||||
*b:ale_nix_deadnix_executable*
|
||||
Type: |String|
|
||||
Default: `'deadnix'`
|
||||
|
||||
This variable sets the executable used for deadnix.
|
||||
|
||||
g:ale_nix_deadnix_options *g:ale_nix_deadnix_options*
|
||||
*b:ale_nix_deadnix_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be used to pass additional options to deadnix.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
||||
@ -20,6 +20,17 @@ g:ale_python_auto_poetry *g:ale_python_auto_poetry*
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
g:ale_python_auto_virtualenv *g:ale_python_auto_virtualenv*
|
||||
*b:ale_python_auto_virtualenv*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
If set to `1`, ALE will automatically set environment variables for commands
|
||||
such as `PATH` to attempt to make the experience of running Python linters
|
||||
via virtualenv easier, without the need for another plugin or some
|
||||
specialised setup.
|
||||
|
||||
|
||||
===============================================================================
|
||||
ALE Python Project Root Behavior *ale-python-root*
|
||||
|
||||
@ -88,24 +99,24 @@ g:ale_python_autoflake_use_global *g:ale_python_autoflake_use_global*
|
||||
===============================================================================
|
||||
autoimport *ale-python-autoimport*
|
||||
|
||||
g:ale_python_autoimport_executable *g:ale_python_autoimport_executable*
|
||||
*b:ale_python_autoimport_executable*
|
||||
g:ale_python_autoimport_executable *g:ale_python_autoimport_executable*
|
||||
*b:ale_python_autoimport_executable*
|
||||
Type: |String|
|
||||
Default: `'autoimport'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_python_autoimport_options *g:ale_python_autoimport_options*
|
||||
*b:ale_python_autoimport_options*
|
||||
g:ale_python_autoimport_options *g:ale_python_autoimport_options*
|
||||
*b:ale_python_autoimport_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass extra options to autoimport.
|
||||
|
||||
|
||||
g:ale_python_autoimport_use_global *g:ale_python_autoimport_use_global*
|
||||
*b:ale_python_autoimport_use_global*
|
||||
g:ale_python_autoimport_use_global *g:ale_python_autoimport_use_global*
|
||||
*b:ale_python_autoimport_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
@ -338,7 +349,7 @@ g:ale_python_flake8_auto_poetry *g:ale_python_flake8_auto_poetry*
|
||||
flakehell *ale-python-flakehell*
|
||||
|
||||
g:ale_python_flakehell_change_directory*g:ale_python_flakehell_change_directory*
|
||||
*b:ale_python_flakehell_change_directory*
|
||||
*b:ale_python_flakehell_change_directory*
|
||||
Type: |String|
|
||||
Default: `project`
|
||||
|
||||
@ -349,8 +360,8 @@ g:ale_python_flakehell_change_directory*g:ale_python_flakehell_change_directory*
|
||||
Python is executed from yourself.
|
||||
|
||||
|
||||
g:ale_python_flakehell_executable *g:ale_python_flakehell_executable*
|
||||
*b:ale_python_flakehell_executable*
|
||||
g:ale_python_flakehell_executable *g:ale_python_flakehell_executable*
|
||||
*b:ale_python_flakehell_executable*
|
||||
Type: |String|
|
||||
Default: `'flakehell'`
|
||||
|
||||
@ -360,8 +371,8 @@ g:ale_python_flakehell_executable *g:ale_python_flakehell_executable*
|
||||
invoke `'python` `-m` `flakehell'`.
|
||||
|
||||
|
||||
g:ale_python_flakehell_options *g:ale_python_flakehell_options*
|
||||
*b:ale_python_flakehell_options*
|
||||
g:ale_python_flakehell_options *g:ale_python_flakehell_options*
|
||||
*b:ale_python_flakehell_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
@ -369,8 +380,8 @@ g:ale_python_flakehell_options *g:ale_python_flakehell_options*
|
||||
lint invocation.
|
||||
|
||||
|
||||
g:ale_python_flakehell_use_global *g:ale_python_flakehell_use_global*
|
||||
*b:ale_python_flakehell_use_global*
|
||||
g:ale_python_flakehell_use_global *g:ale_python_flakehell_use_global*
|
||||
*b:ale_python_flakehell_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
@ -381,8 +392,8 @@ g:ale_python_flakehell_use_global *g:ale_python_flakehell_use_global*
|
||||
Both variables can be set with `b:` buffer variables instead.
|
||||
|
||||
|
||||
g:ale_python_flakehell_auto_pipenv *g:ale_python_flakehell_auto_pipenv*
|
||||
*b:ale_python_flakehell_auto_pipenv*
|
||||
g:ale_python_flakehell_auto_pipenv *g:ale_python_flakehell_auto_pipenv*
|
||||
*b:ale_python_flakehell_auto_pipenv*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
@ -580,6 +591,78 @@ g:ale_python_prospector_auto_poetry *g:ale_python_prospector_auto_poetry*
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
===============================================================================
|
||||
pycln *ale-python-pycln*
|
||||
|
||||
g:ale_python_pycln_change_directory *g:ale_python_pycln_change_directory*
|
||||
*b:ale_python_pycln_change_directory*
|
||||
Type: |Number|
|
||||
Default: `1`
|
||||
|
||||
If set to `1`, `pycln` will be run from a detected project root, per
|
||||
|ale-python-root|. if set to `0` or no project root detected,
|
||||
`pycln` will be run from the buffer's directory.
|
||||
|
||||
|
||||
g:ale_python_pycln_executable *g:ale_python_pycln_executable*
|
||||
*b:ale_python_pycln_executable*
|
||||
Type: |String|
|
||||
Default: `'pycln'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pycln'`.
|
||||
Set this to `'poetry'` to invoke `'poetry` `run` `pycln'`.
|
||||
|
||||
|
||||
g:ale_python_pycln_options *g:ale_python_pycln_options*
|
||||
*b:ale_python_pycln_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to add command-line arguments to the pycln
|
||||
invocation.
|
||||
|
||||
For example, to select/enable and/or disable some error codes,
|
||||
you may want to set >
|
||||
let g:ale_python_pycln_options = '--expand-stars'
|
||||
|
||||
|
||||
g:ale_python_pycln_config_file *g:ale_python_pycln_config_file*
|
||||
*b:ale_python_pycln_config_file*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
Use this variable to set the configuration file.
|
||||
If `'--config' ` is found in the |g:ale_python_pycln_options|, then that
|
||||
option value will override the value in this variable.
|
||||
|
||||
g:ale_python_pycln_use_global *g:ale_python_pycln_use_global*
|
||||
*b:ale_python_pycln_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_python_pycln_auto_pipenv *g:ale_python_pycln_auto_pipenv*
|
||||
*b:ale_python_pycln_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.
|
||||
|
||||
|
||||
g:ale_python_pycln_auto_poetry *g:ale_python_pycln_auto_poetry*
|
||||
*b:ale_python_pycln_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.
|
||||
|
||||
|
||||
===============================================================================
|
||||
pycodestyle *ale-python-pycodestyle*
|
||||
|
||||
@ -903,13 +986,13 @@ g:ale_python_pylint_use_msg_id *g:ale_python_pylint_use_msg_id*
|
||||
|
||||
|
||||
===============================================================================
|
||||
pylsp *ale-python-pylsp*
|
||||
pylsp *ale-python-pylsp*
|
||||
|
||||
`pylsp` will be run from a detected project root, per |ale-python-root|.
|
||||
|
||||
|
||||
g:ale_python_pylsp_executable *g:ale_python_pylsp_executable*
|
||||
*b:ale_python_pylsp_executable*
|
||||
g:ale_python_pylsp_executable *g:ale_python_pylsp_executable*
|
||||
*b:ale_python_pylsp_executable*
|
||||
Type: |String|
|
||||
Default: `'pylsp'`
|
||||
|
||||
@ -919,16 +1002,16 @@ g:ale_python_pylsp_executable *g:ale_python_pylsp_executable
|
||||
Set this to `'poetry'` to invoke `'poetry` `run` `pyls'`.
|
||||
|
||||
|
||||
g:ale_python_pylsp_use_global *g:ale_python_pylsp_use_global*
|
||||
*b:ale_python_pylsp_use_global*
|
||||
g:ale_python_pylsp_use_global *g:ale_python_pylsp_use_global*
|
||||
*b:ale_python_pylsp_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_python_pylsp_auto_pipenv *g:ale_python_pylsp_auto_pipenv*
|
||||
*b:ale_python_pylsp_auto_pipenv*
|
||||
g:ale_python_pylsp_auto_pipenv *g:ale_python_pylsp_auto_pipenv*
|
||||
*b:ale_python_pylsp_auto_pipenv*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
@ -936,8 +1019,8 @@ g:ale_python_pylsp_auto_pipenv *g:ale_python_pylsp_auto_pipenv
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
g:ale_python_pylsp_auto_poetry *g:ale_python_pylsp_auto_poetry*
|
||||
*b:ale_python_pylsp_auto_poetry*
|
||||
g:ale_python_pylsp_auto_poetry *g:ale_python_pylsp_auto_poetry*
|
||||
*b:ale_python_pylsp_auto_poetry*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
@ -945,8 +1028,8 @@ g:ale_python_pylsp_auto_poetry *g:ale_python_pylsp_auto_poetry
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
g:ale_python_pylsp_config *g:ale_python_pylsp_config*
|
||||
*b:ale_python_pylsp_config*
|
||||
g:ale_python_pylsp_config *g:ale_python_pylsp_config*
|
||||
*b:ale_python_pylsp_config*
|
||||
Type: |Dictionary|
|
||||
Default: `{}`
|
||||
|
||||
@ -963,8 +1046,8 @@ g:ale_python_pylsp_config *g:ale_python_pylsp_config
|
||||
\ }
|
||||
<
|
||||
|
||||
g:ale_python_pylsp_options *g:ale_python_pylsp_options*
|
||||
*b:ale_python_pylsp_options*
|
||||
g:ale_python_pylsp_options *g:ale_python_pylsp_options*
|
||||
*b:ale_python_pylsp_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
@ -1085,6 +1168,67 @@ g:ale_python_pyright_config *g:ale_python_pyright_config*
|
||||
\}
|
||||
<
|
||||
|
||||
===============================================================================
|
||||
refurb *ale-python-refurb*
|
||||
|
||||
g:ale_python_refurb_change_directory *g:ale_python_refurb_change_directory*
|
||||
*b:ale_python_refurb_change_directory*
|
||||
Type: |Number|
|
||||
Default: `1`
|
||||
|
||||
If set to `1`, `refurb` will be run from a detected project root, per
|
||||
|ale-python-root|. if set to `0` or no project root detected,
|
||||
`refurb` will be run from the buffer's directory.
|
||||
|
||||
|
||||
g:ale_python_refurb_executable *g:ale_python_refurb_executable*
|
||||
*b:ale_python_refurb_executable*
|
||||
Type: |String|
|
||||
Default: `'refurb'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `refurb'`.
|
||||
Set this to `'poetry'` to invoke `'poetry` `run` `refurb'`.
|
||||
|
||||
|
||||
g:ale_python_refurb_options *g:ale_python_refurb_options*
|
||||
*b:ale_python_refurb_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to add command-line arguments to the refurb
|
||||
invocation.
|
||||
|
||||
For example, to select/enable and/or disable some error codes,
|
||||
you may want to set >
|
||||
let g:ale_python_refurb_options = '--ignore 100'
|
||||
g:ale_python_refurb_use_global *g:ale_python_refurb_use_global*
|
||||
*b:ale_python_refurb_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_python_refurb_auto_pipenv *g:ale_python_refurb_auto_pipenv*
|
||||
*b:ale_python_refurb_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.
|
||||
|
||||
|
||||
g:ale_python_refurb_auto_poetry *g:ale_python_refurb_auto_poetry*
|
||||
*b:ale_python_refurb_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.
|
||||
|
||||
|
||||
===============================================================================
|
||||
reorder-python-imports *ale-python-reorder_python_imports*
|
||||
|
||||
@ -1202,8 +1346,8 @@ g:ale_python_unimport_auto_poetry *g:ale_python_unimport_auto_poetry*
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
g:ale_python_unimport_executable *g:ale_python_unimport_executable*
|
||||
*b:ale_python_unimport_executable*
|
||||
g:ale_python_unimport_executable *g:ale_python_unimport_executable*
|
||||
*b:ale_python_unimport_executable*
|
||||
Type: |String|
|
||||
Default: `'unimport'`
|
||||
|
||||
@ -1213,8 +1357,8 @@ g:ale_python_unimport_executable *g:ale_python_unimport_executable*
|
||||
Set this to `'poetry'` to invoke `'poetry` `run` `unimport'`.
|
||||
|
||||
|
||||
g:ale_python_unimport_options *g:ale_python_unimport_options*
|
||||
*b:ale_python_unimport_options*
|
||||
g:ale_python_unimport_options *g:ale_python_unimport_options*
|
||||
*b:ale_python_unimport_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
@ -1222,8 +1366,8 @@ g:ale_python_unimport_options *g:ale_python_unimport_options*
|
||||
invocation.
|
||||
|
||||
|
||||
g:ale_python_unimport_use_global *g:ale_python_unimport_use_global*
|
||||
*b:ale_python_unimport_use_global*
|
||||
g:ale_python_unimport_use_global *g:ale_python_unimport_use_global*
|
||||
*b:ale_python_unimport_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
|
||||
41
sources_non_forked/ale/doc/ale-racket.txt
Normal file
41
sources_non_forked/ale/doc/ale-racket.txt
Normal file
@ -0,0 +1,41 @@
|
||||
===============================================================================
|
||||
ALE Racket Integration *ale-racket-options*
|
||||
|
||||
===============================================================================
|
||||
racket_langserver *ale-racket-langserver*
|
||||
|
||||
1. Install racket-langserver as described here:
|
||||
https://github.com/jeapostrophe/racket-langserver
|
||||
2. Have `racket` available in the `$PATH` environment variable, currently there
|
||||
is no way to specify path to custom location of `racket`.
|
||||
3. set `racket_langserver` as a linter for `racket` like: >
|
||||
let g:ale_linters['racket'] += ['racket_langserver']
|
||||
|
||||
You should be able to see linter results and use LSP features of `ALE` like
|
||||
`ALEGoToDefinition` with `racket-langserver`.
|
||||
|
||||
===============================================================================
|
||||
raco_fmt *ale-racket-raco-fmt*
|
||||
|
||||
g:ale_racket_raco_fmt_executable *g:ale_racket_raco_fmt_executable*
|
||||
*b:ale_racket_raco_fmt_executable*
|
||||
Type: |String|
|
||||
Default: `'raco'`
|
||||
|
||||
If the `raco` excutable is not in the `$PATH` environment variable, or you
|
||||
prefer to use one installed in a custom location, set this option to the
|
||||
path to the specific `raco` executable.
|
||||
|
||||
g:ale_racket_raco_fmt_options *g:ale_racket_raco_fmt_options*
|
||||
*b:ale_racket_raco_fmt_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
Use this variable to pass command-line flags/parameters to `raco_fmt`
|
||||
|
||||
For example, set the page width limit to 40 >
|
||||
let g:ale_racket_raco_fmt_options = '--width 40'
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
@ -36,6 +36,7 @@ Notes:
|
||||
* `write-good`
|
||||
* ASM
|
||||
* `gcc`
|
||||
* `llvm-mc`
|
||||
* AVRA
|
||||
* `avra`
|
||||
* Awk
|
||||
@ -255,11 +256,13 @@ Notes:
|
||||
* `alex`
|
||||
* `angular`
|
||||
* `cspell`
|
||||
* `eslint`
|
||||
* `fecs`
|
||||
* `html-beautify`
|
||||
* `htmlhint`
|
||||
* `prettier`
|
||||
* `proselint`
|
||||
* `rustywind`
|
||||
* `tidy`
|
||||
* `write-good`
|
||||
* Idris
|
||||
@ -340,6 +343,7 @@ Notes:
|
||||
* Lua
|
||||
* `cspell`
|
||||
* `lua-format`
|
||||
* `lua-language-server`
|
||||
* `luac`
|
||||
* `luacheck`
|
||||
* `luafmt`
|
||||
@ -377,6 +381,7 @@ Notes:
|
||||
* `nimlsp`
|
||||
* `nimpretty`
|
||||
* nix
|
||||
* `alejandra`
|
||||
* `nix-instantiate`
|
||||
* `nixfmt`
|
||||
* `nixpkgs-fmt`
|
||||
@ -481,6 +486,7 @@ Notes:
|
||||
* `isort`
|
||||
* `mypy`
|
||||
* `prospector`!!
|
||||
* `pycln`
|
||||
* `pycodestyle`
|
||||
* `pydocstyle`
|
||||
* `pyflakes`
|
||||
@ -490,6 +496,7 @@ Notes:
|
||||
* `pylsp`
|
||||
* `pyre`
|
||||
* `pyright`
|
||||
* `refurb`
|
||||
* `reorder-python-imports`
|
||||
* ruff
|
||||
* `unimport`
|
||||
|
||||
@ -17,7 +17,7 @@ CONTENTS *ale-contents*
|
||||
5.1 Completion........................|ale-completion|
|
||||
5.2 Go To Definition..................|ale-go-to-definition|
|
||||
5.3 Go To Type Definition.............|ale-go-to-type-definition|
|
||||
5.4 Go To Implementation..............|ale-go-to-type-implementation|
|
||||
5.4 Go To Implementation..............|ale-go-to-implementation|
|
||||
5.5 Find References...................|ale-find-references|
|
||||
5.6 Hovering..........................|ale-hover|
|
||||
5.7 Symbol Search.....................|ale-symbol-search|
|
||||
@ -121,6 +121,7 @@ circumstances.
|
||||
ALE will report problems with your code in the following ways, listed with
|
||||
their relevant options.
|
||||
|
||||
* Via the Neovim diagnostics API (Off by default) - |g:ale_use_neovim_diagnostics_api|
|
||||
* By updating loclist. (On by default) - |g:ale_set_loclist|
|
||||
* By updating quickfix. (Off by default) - |g:ale_set_quickfix|
|
||||
* By setting error highlights. - |g:ale_set_highlights|
|
||||
@ -1063,7 +1064,8 @@ g:ale_echo_msg_format *g:ale_echo_msg_format*
|
||||
`%s` - replaced with the text for the problem
|
||||
`%...code...% `- replaced with the error code
|
||||
`%linter%` - replaced with the name of the linter
|
||||
`%severity%` - replaced with the severity of the problem
|
||||
`%severity%` - replaced with the severity of the problem (e.g. `Error`)
|
||||
`%type%` - replaced with the type of the problem (e.g. `E`)
|
||||
|
||||
The strings for `%severity%` can be configured with the following options.
|
||||
|
||||
@ -1234,7 +1236,7 @@ g:ale_floating_preview *g:ale_floating_preview*
|
||||
|g:ale_detail_to_floating_preview| to `1`.
|
||||
|
||||
|
||||
g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts*
|
||||
g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts*
|
||||
|
||||
Type: |String| or |Dictionary|
|
||||
Default: `''`
|
||||
@ -1250,14 +1252,16 @@ g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts
|
||||
|
||||
For example, to enhance popups with a title: >
|
||||
|
||||
function! CustomOpts() abort {
|
||||
function! CustomOpts() abort
|
||||
let [l:info, l:loc] = ale#util#FindItemAtCursor(bufnr(''))
|
||||
return {'title': ' ALE: ' . (l:loc.linter_name) . ' '}
|
||||
endfunction
|
||||
|
||||
let g:ale_floating_preview_popup_opts = 'g:CustomOpts'
|
||||
<
|
||||
|
||||
|
||||
g:ale_floating_window_border *g:ale_floating_window_border*
|
||||
g:ale_floating_window_border *g:ale_floating_window_border*
|
||||
|
||||
Type: |List|
|
||||
Default: `['|', '-', '+', '+', '+', '+', '|', '-']`
|
||||
@ -1647,7 +1651,7 @@ g:ale_linters *g:ale_linters*
|
||||
\ 'jsonc': [],
|
||||
\ 'perl': ['perlcritic'],
|
||||
\ 'perl6': [],
|
||||
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright'],
|
||||
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright', 'ruff'],
|
||||
\ 'rust': ['cargo', 'rls'],
|
||||
\ 'spec': [],
|
||||
\ 'text': [],
|
||||
@ -2287,23 +2291,41 @@ g:ale_use_global_executables *g:ale_use_global_executables*
|
||||
options.
|
||||
|
||||
|
||||
g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
|
||||
g:ale_use_neovim_diagnostics_api *g:ale_use_neovim_diagnostics_api*
|
||||
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
When this option is set to `1`, a message will be shown when a cursor is
|
||||
near a warning or error. ALE will attempt to find the warning or error at a
|
||||
column nearest to the cursor when the cursor is resting on a line which
|
||||
contains a warning or error. This option can be set to `0` to disable this
|
||||
behavior.
|
||||
When this option is set to `2`, then all warnings will be shown for the
|
||||
whole buffer, regardless of if the cursor is currently positioned in that
|
||||
line.
|
||||
If enabled, this option will disable ALE's standard UI, and instead send
|
||||
all linter output to Neovim's diagnostics API. This allows you to collect
|
||||
errors from nvim-lsp, ALE, and anything else that uses diagnostics all in
|
||||
one place. The following options are ignored when using the diagnostics API:
|
||||
|
||||
- |g:ale_set_highlights|
|
||||
- |g:ale_set_signs|
|
||||
- |g:ale_virtualtext_cursor|
|
||||
|
||||
To enable this option, set the value to `1`.
|
||||
|
||||
This option requires Neovim 0.6+, as that version introduces the diagnostics
|
||||
API.
|
||||
|
||||
|
||||
g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
|
||||
|
||||
Type: |Number|
|
||||
Default: `'all'` (if supported, otherwise `'disabled'`)
|
||||
|
||||
This option controls how ALE will display problems using |virtual-text|.
|
||||
The following values can be used.
|
||||
|
||||
`'all'`, `'2'`, or `2` - Show problems for all lines.
|
||||
`'current'`, `'1'`, or `1` - Show problems for the current line.
|
||||
`'disabled'`, `'0'`, or `0` - Do not show problems with virtual-text.
|
||||
|
||||
Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|.
|
||||
|
||||
Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|.
|
||||
Messages can be prefixed with a string. See |g:ale_virtualtext_prefix|.
|
||||
|
||||
ALE will use the following highlight groups for problems:
|
||||
|
||||
@ -2316,7 +2338,6 @@ g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
|
||||
|
||||
g:ale_virtualtext_delay *g:ale_virtualtext_delay*
|
||||
*b:ale_virtualtext_delay*
|
||||
|
||||
Type: |Number|
|
||||
Default: `10`
|
||||
|
||||
@ -2328,12 +2349,58 @@ g:ale_virtualtext_delay *g:ale_virtualtext_delay*
|
||||
|
||||
|
||||
g:ale_virtualtext_prefix *g:ale_virtualtext_prefix*
|
||||
|
||||
*b:ale_virtualtext_prefix*
|
||||
Type: |String|
|
||||
Default: `'> '`
|
||||
Default: `'%comment% %type%: '`
|
||||
|
||||
Prefix to be used with |g:ale_virtualtext_cursor|.
|
||||
|
||||
This setting can be changed in each buffer with `b:ale_virtualtext_prefix`.
|
||||
|
||||
All of the same format markers used for |g:ale_echo_msg_format| can be used
|
||||
for defining the prefix, including some additional sequences of characters.
|
||||
|
||||
`%comment%` - replaced with comment characters in the current language
|
||||
|
||||
ALE will read the comment characters from |&commentstring|, reading only the
|
||||
part before `%s`, with whitespace trimmed. If comment syntax cannot be
|
||||
pulled from |&commentstring|, ALE will default to `'#'`.
|
||||
|
||||
|
||||
g:ale_virtualtext_column *g:ale_virtualtext_column*
|
||||
*b:ale_virtualtext_column*
|
||||
g:ale_virtualtext_maxcolumn *g:ale_virtualtext_maxcolumn*
|
||||
*b:ale_virtualtext_maxcolumn*
|
||||
Type: |String| or |Number|
|
||||
Default: `0`
|
||||
|
||||
Virtualtext column range, from `column` to `maxcolumn`. If a line is
|
||||
`column` or less characters long, the virtualtext message is shifted right
|
||||
to `column`.
|
||||
|
||||
Where the line is greater than `column` characters long, but less than
|
||||
`maxcolumn`, the virtualtext message is placed at the end of the line.
|
||||
|
||||
Where the line is greater than `maxcolumn` the virtualtext message is
|
||||
omitted.
|
||||
|
||||
A |Number| greater than `0` is used as the fixed column position, however
|
||||
a |String| ending in `%` represents a percentage of the window width.
|
||||
When `column` is set to zero, column positioning is disabled, when `maxcolumn`
|
||||
is set to zero, no maximum line length is enforced.
|
||||
|
||||
g:ale_virtualtext_single *g:ale_virtualtext_single*
|
||||
*b:ale_virtualtext_single*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
Enable or disable concatenation of multiple virtualtext messages on a single
|
||||
line. By default, if a line has multiple errors or warnings, each will be
|
||||
appended in turn.
|
||||
|
||||
With `single` set to a non-zero value, only the first message appears.
|
||||
(No attempt is made to prefer message types such as errors over warnings)
|
||||
|
||||
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
|
||||
*b:ale_virtualenv_dir_names*
|
||||
|
||||
@ -2510,7 +2577,7 @@ ALEStyleWarningSignLineNr *ALEStyleWarningSignLineNr*
|
||||
|
||||
ALEVirtualTextError *ALEVirtualTextError*
|
||||
|
||||
Default: `highlight link ALEVirtualTextError ALEError`
|
||||
Default: `highlight link ALEVirtualTextError Comment`
|
||||
|
||||
The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
@ -2538,7 +2605,7 @@ ALEVirtualTextStyleWarning *ALEVirtualTextStyleWarning*
|
||||
|
||||
ALEVirtualTextWarning *ALEVirtualTextWarning*
|
||||
|
||||
Default: `highlight link ALEVirtualTextWarning ALEWarning`
|
||||
Default: `highlight link ALEVirtualTextWarning Comment`
|
||||
|
||||
The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
@ -2778,6 +2845,7 @@ documented in additional help files.
|
||||
textlint..............................|ale-asciidoc-textlint|
|
||||
asm.....................................|ale-asm-options|
|
||||
gcc...................................|ale-asm-gcc|
|
||||
llvm_mc...............................|ale-asm-llvm_mc|
|
||||
avra....................................|ale-avra-options|
|
||||
avra..................................|ale-avra-avra|
|
||||
awk.....................................|ale-awk-options|
|
||||
@ -2962,6 +3030,7 @@ documented in additional help files.
|
||||
html-beautify.........................|ale-html-beautify|
|
||||
htmlhint..............................|ale-html-htmlhint|
|
||||
prettier..............................|ale-html-prettier|
|
||||
rustywind.............................|ale-html-rustywind|
|
||||
stylelint.............................|ale-html-stylelint|
|
||||
tidy..................................|ale-html-tidy|
|
||||
vscodehtml............................|ale-html-vscode|
|
||||
@ -3037,6 +3106,7 @@ documented in additional help files.
|
||||
lua.....................................|ale-lua-options|
|
||||
cspell................................|ale-lua-cspell|
|
||||
lua-format............................|ale-lua-lua-format|
|
||||
lua-language-server...................|ale-lua-lua-language-server|
|
||||
luac..................................|ale-lua-luac|
|
||||
luacheck..............................|ale-lua-luacheck|
|
||||
luafmt................................|ale-lua-luafmt|
|
||||
@ -3063,9 +3133,11 @@ documented in additional help files.
|
||||
nimlsp................................|ale-nim-nimlsp|
|
||||
nimpretty.............................|ale-nim-nimpretty|
|
||||
nix.....................................|ale-nix-options|
|
||||
alejandra.............................|ale-nix-alejandra|
|
||||
nixfmt................................|ale-nix-nixfmt|
|
||||
nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
|
||||
statix................................|ale-nix-statix|
|
||||
deadnix...............................|ale-nix-deadnix|
|
||||
nroff...................................|ale-nroff-options|
|
||||
write-good............................|ale-nroff-write-good|
|
||||
objc....................................|ale-objc-options|
|
||||
@ -3159,6 +3231,7 @@ documented in additional help files.
|
||||
isort.................................|ale-python-isort|
|
||||
mypy..................................|ale-python-mypy|
|
||||
prospector............................|ale-python-prospector|
|
||||
pycln.................................|ale-python-pycln|
|
||||
pycodestyle...........................|ale-python-pycodestyle|
|
||||
pydocstyle............................|ale-python-pydocstyle|
|
||||
pyflakes..............................|ale-python-pyflakes|
|
||||
@ -3168,6 +3241,7 @@ documented in additional help files.
|
||||
pylsp.................................|ale-python-pylsp|
|
||||
pyre..................................|ale-python-pyre|
|
||||
pyright...............................|ale-python-pyright|
|
||||
refurb................................|ale-python-refurb|
|
||||
reorder-python-imports................|ale-python-reorder_python_imports|
|
||||
ruff..................................|ale-python-ruff|
|
||||
unimport..............................|ale-python-unimport|
|
||||
@ -3179,6 +3253,9 @@ documented in additional help files.
|
||||
languageserver........................|ale-r-languageserver|
|
||||
lintr.................................|ale-r-lintr|
|
||||
styler................................|ale-r-styler|
|
||||
racket..................................|ale-racket-options|
|
||||
racket_langserver.....................|ale-racket-langserver|
|
||||
raco_fmt..............................|ale-racket-raco-fmt|
|
||||
reasonml................................|ale-reasonml-options|
|
||||
merlin................................|ale-reasonml-merlin|
|
||||
ols...................................|ale-reasonml-ols|
|
||||
|
||||
Reference in New Issue
Block a user