summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartek thindil Jasicki <thindil@laeran.pl>2021-01-15 09:42:14 +0100
committerBartek thindil Jasicki <thindil@laeran.pl>2021-01-15 09:42:14 +0100
commit45a28383a2da3d28bdc5e7d3a0deb6365680980d (patch)
tree8c6a0d4f84a6534325e4854ef520c663eb3b81c7 /doc
parent7b1ed2733e2b73a74149f300d5400225f535f490 (diff)
parent6fbdec8587ad918dccf13546418904d3f2c38a46 (diff)
downloadale-45a28383a2da3d28bdc5e7d3a0deb6365680980d.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-erlang.txt8
-rw-r--r--doc/ale-inko.txt22
-rw-r--r--doc/ale-python.txt2
-rw-r--r--doc/ale-supported-languages-and-tools.txt26
-rw-r--r--doc/ale.txt37
5 files changed, 81 insertions, 14 deletions
diff --git a/doc/ale-erlang.txt b/doc/ale-erlang.txt
index 38762f08..9ee9a51d 100644
--- a/doc/ale-erlang.txt
+++ b/doc/ale-erlang.txt
@@ -46,6 +46,14 @@ g:ale_erlang_elvis_executable *g:ale_erlang_elvis_executable*
-------------------------------------------------------------------------------
erlc *ale-erlang-erlc*
+g:ale_erlang_erlc_executable *g:ale_erlang_erlc_executable*
+ *b:ale_erlang_erlc_executable*
+ Type: |String|
+ Default: `'erlc'`
+
+ This variable can be changed to specify the erlc executable.
+
+
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
*b:ale_erlang_erlc_options*
Type: |String|
diff --git a/doc/ale-inko.txt b/doc/ale-inko.txt
new file mode 100644
index 00000000..5ca14af6
--- /dev/null
+++ b/doc/ale-inko.txt
@@ -0,0 +1,22 @@
+===============================================================================
+ALE Inko Integration *ale-inko-options*
+ *ale-integration-inko*
+
+===============================================================================
+Integration Information
+
+ Currently, the only supported linter for Inko is the Inko compiler itself.
+
+===============================================================================
+inko *ale-inko-inko*
+
+g:ale_inko_inko_executable *g:ale_inko_inko_executable*
+ *b:ale_inko_inko_executable*
+ Type: |String|
+ Default: `'inko'`
+
+ This variable can be modified to change the executable path for `inko`.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 504705f2..1f263e84 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -36,6 +36,8 @@ ALE will look for configuration files with the following filenames. >
.pylintrc
Pipfile
Pipfile.lock
+ poetry.lock
+ pyproject.toml
<
The first directory containing any of the files named above will be used.
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 3d6c50d1..5bbe6097 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -50,8 +50,8 @@ Notes:
* `astyle`
* `ccls`
* `clang` (`cc`)
- * `clangd`
* `clang-format`
+ * `clangd`
* `clangtidy`!!
* `cppcheck`
* `cpplint`!!
@@ -68,9 +68,9 @@ Notes:
* `astyle`
* `ccls`
* `clang` (`cc`)
+ * `clang-format`
* `clangcheck`!!
* `clangd`
- * `clang-format`
* `clangtidy`!!
* `clazy`!!
* `cppcheck`
@@ -141,9 +141,9 @@ Notes:
* `erubis`
* `ruumba`
* Erlang
+ * `SyntaxErl`
* `elvis`!!
* `erlc`
- * `SyntaxErl`
* Fish
* `fish` (-n flag)
* Fortran
@@ -161,17 +161,17 @@ Notes:
* Go
* `bingo`
* `go build`!!
+ * `go mod`!!
+ * `go vet`!!
* `gofmt`
* `goimports`
* `golangci-lint`!!
* `golangserver`
* `golint`
* `gometalinter`!!
- * `go mod`!!
* `gopls`
* `gosimple`!!
* `gotype`!!
- * `go vet`!!
* `revive`!!
* `staticcheck`!!
* GraphQL
@@ -204,10 +204,10 @@ Notes:
* HCL
* `terraform-fmt`
* HTML
+ * `HTMLHint`
* `alex`!!
* `fecs`
* `html-beautify`
- * `HTMLHint`
* `prettier`
* `proselint`
* `tidy`
@@ -216,15 +216,17 @@ Notes:
* `idris`
* Ink
* `ink-language-server`
+* Inko
+ * `inko` !!
* ISPC
* `ispc`!!
* Java
+ * `PMD`
* `checkstyle`
* `eclipselsp`
* `google-java-format`
* `javac`
* `javalsp`
- * `PMD`
* `uncrustify`
* JavaScript
* `eslint`
@@ -331,10 +333,10 @@ Notes:
* `intelephense`
* `langserver`
* `phan`
+ * `php -l`
+ * `php-cs-fixer`
* `phpcbf`
* `phpcs`
- * `php-cs-fixer`
- * `php -l`
* `phpmd`
* `phpstan`
* `psalm`!!
@@ -395,6 +397,8 @@ Notes:
* `styler`
* Racket
* `raco`
+* Re:VIEW
+ * `redpen`
* ReasonML
* `merlin`
* `ols`
@@ -408,8 +412,6 @@ Notes:
* `textlint`
* `vale`
* `write-good`
-* Re:VIEW
- * `redpen`
* RPM spec
* `rpmlint`
* Ruby
@@ -456,10 +458,10 @@ Notes:
* `solium`
* SQL
* `pgformatter`
+ * `sql-lint`
* `sqlfmt`
* `sqlformat`
* `sqlint`
- * `sql-lint`
* Stylus
* `stylelint`
* SugarSS
diff --git a/doc/ale.txt b/doc/ale.txt
index 28f6902f..fe94baf2 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -646,6 +646,9 @@ problem will be displayed in a balloon instead of hover information.
Hover information can be displayed in the preview window instead by setting
|g:ale_hover_to_preview| to `1`.
+When using Neovim, if |g:ale_hover_to_floating_preview| or |g:ale_floating_preview|
+is set to 1, the hover information will show in a floating window.
+
For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|balloonexpr| commands in terminals can cause scrolling issues in terminals,
so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to
@@ -954,6 +957,15 @@ g:ale_default_navigation *g:ale_default_navigation*
buffer, such as for |ALEFindReferences|, or |ALEGoToDefinition|.
+g:ale_detail_to_floating_preview *g:ale_detail_to_floating_preview*
+ *b:ale_detail_to_floating_preview*
+ Type: |Number|
+ Default: `0`
+
+ When this option is set to `1`, Neovim will use a floating window for
+ ALEDetail output.
+
+
g:ale_disable_lsp *g:ale_disable_lsp*
*b:ale_disable_lsp*
@@ -1177,6 +1189,16 @@ g:ale_fix_on_save_ignore *g:ale_fix_on_save_ignore*
let g:ale_fix_on_save_ignore = [g:AddBar]
<
+g:ale_floating_preview *g:ale_floating_preview*
+
+ Type: |Number|
+ Default: `0`
+
+ When set to `1`, Neovim will use a floating window for ale's preview window.
+ This is equivalent to setting |g:ale_hover_to_floating_preview| and
+ |g:ale_detail_to_floating_preview| to `1`.
+
+
g:ale_history_enabled *g:ale_history_enabled*
Type: |Number|
@@ -1235,6 +1257,14 @@ g:ale_hover_to_preview *g:ale_hover_to_preview*
instead of in balloons or the message line.
+g:ale_hover_to_floating_preview *g:ale_hover_to_floating_preview*
+ *b:ale_hover_to_floating_preview*
+ Type: |Number|
+ Default: `0`
+
+ If set to `1`, Neovim will use floating windows for hover messages.
+
+
g:ale_keep_list_window_open *g:ale_keep_list_window_open*
*b:ale_keep_list_window_open*
Type: |Number|
@@ -1531,6 +1561,7 @@ g:ale_linters *g:ale_linters*
\ 'go': ['gofmt', 'golint', 'go vet'],
\ 'hack': ['hack'],
\ 'help': [],
+ \ 'inko': ['inko'],
\ 'perl': ['perlcritic'],
\ 'perl6': [],
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright'],
@@ -2709,6 +2740,8 @@ documented in additional help files.
idris.................................|ale-idris-idris|
ink.....................................|ale-ink-options|
ink-language-server...................|ale-ink-language-server|
+ inko....................................|ale-inko-options|
+ inko..................................|ale-inko-inko|
ispc....................................|ale-ispc-options|
ispc..................................|ale-ispc-ispc|
java....................................|ale-java-options|
@@ -2959,11 +2992,11 @@ documented in additional help files.
hdl-checker...........................|ale-vhdl-hdl-checker|
vcom..................................|ale-vhdl-vcom|
xvhdl.................................|ale-vhdl-xvhdl|
+ vim help................................|ale-vim-help-options|
+ write-good............................|ale-vim-help-write-good|
vim.....................................|ale-vim-options|
vimls.................................|ale-vim-vimls|
vint..................................|ale-vim-vint|
- vim help................................|ale-vim-help-options|
- write-good............................|ale-vim-help-write-good|
vue.....................................|ale-vue-options|
prettier..............................|ale-vue-prettier|
vls...................................|ale-vue-vls|