summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartek thindil Jasicki <thindil@laeran.pl>2020-08-14 19:38:09 +0200
committerBartek thindil Jasicki <thindil@laeran.pl>2020-08-14 19:38:09 +0200
commit04bd84e914af02e1c7d61ccf8f8368de85eab30e (patch)
treeda622d456ce01358a85a680f9fc8d802bc61ff01 /doc
parent973c4ea053f78d4daa6eceff36da0bbecd788077 (diff)
parent5ceda0164c5fae0d61fd51d4c9e083b27abdc9d2 (diff)
downloadale-04bd84e914af02e1c7d61ccf8f8368de85eab30e.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-c.txt18
-rw-r--r--doc/ale-powershell.txt7
-rw-r--r--doc/ale-ruby.txt12
-rw-r--r--doc/ale-rust.txt12
-rw-r--r--doc/ale.txt22
5 files changed, 53 insertions, 18 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index efc26f93..fc0d941a 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -37,7 +37,7 @@ g:ale_c_build_dir *g:ale_c_build_dir*
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
*b:ale_c_parse_compile_commands*
Type: |Number|
- Default: `0`
+ Default: `1`
If set to `1`, ALE will parse `compile_commands.json` files to automatically
determine flags for C or C++ compilers. ALE will first search for the
@@ -45,9 +45,6 @@ g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
`compile_commands.json` files in the directories for
|g:ale_c_build_dir_names|.
- If |g:ale_c_parse_makefile| or |b:ale_c_parse_makefile| is set to `1`, the
- output of `make -n` will be preferred over `compile_commands.json` files.
-
g:ale_c_parse_makefile *g:ale_c_parse_makefile*
*b:ale_c_parse_makefile*
@@ -58,6 +55,19 @@ g:ale_c_parse_makefile *g:ale_c_parse_makefile*
set for C or C++ compilers. This can make it easier to determine the correct
build flags to use for different files.
+ WARNING: Running `make -n` automatically can execute arbitrary code, even
+ though it's supposed to be a dry run, so enable this option with care. You
+ might prefer to use the buffer-local version of the option instead with
+ |g:ale_pattern_options|, or you own code for checking which project you're
+ in.
+
+ You might want to disable this option if `make -n` takes too long to run for
+ projects you work on.
+
+ If |g:ale_c_parse_compile_commands| or |b:ale_c_parse_compile_commands| is
+ set to `1`, flags taken from `compile_commands.json` will be preferred over
+ `make -n` output.
+
===============================================================================
astyle *ale-c-astyle*
diff --git a/doc/ale-powershell.txt b/doc/ale-powershell.txt
index c28ef9ea..485c9bd0 100644
--- a/doc/ale-powershell.txt
+++ b/doc/ale-powershell.txt
@@ -25,13 +25,6 @@ Installation
Install PSScriptAnalyzer by any means, so long as it can be automatically
imported in PowerShell.
-Some PowerShell plugins set the filetype of files to `ps1`. To continue using
-these plugins, use the ale_linter_aliases global to alias `ps1` to `powershell`
-
->
- " Allow ps1 filetype to work with powershell linters
- let g:ale_linter_aliases = {'ps1': 'powershell'}
-<
g:ale_powershell_psscriptanalyzer_executable
*g:ale_powershell_psscriptanalyzer_executable*
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index a27a20b2..8815404a 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -114,6 +114,14 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
This variable can be changed to modify flags given to rubocop.
+g:ale_ruby_rubocop_auto_correct_all *g:ale_ruby_rubocop_auto_correct_all*
+ *b:ale_ruby_rubocop_auto_correct_all*
+ Type: Number
+ Default: `0`
+
+ This variable can be changed to make rubocop to correct all offenses (unsafe).
+
+
===============================================================================
ruby *ale-ruby-ruby*
@@ -172,8 +180,8 @@ g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
===============================================================================
standardrb *ale-ruby-standardrb*
-g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
- *b:ale_ruby_standardrb_executable*
+g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
+ *b:ale_ruby_standardrb_executable*
Type: String
Default: `'standardrb'`
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 46d4714b..2c0222b7 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -174,6 +174,18 @@ g:ale_rust_cargo_clippy_options
only `cargo clippy` supports (e.g. `--deny`).
+g:ale_rust_cargo_target_dir
+ *g:ale_rust_cargo_target_dir*
+ *b:ale_rust_cargo_target_dir*
+
+ Type: |String|
+ Default: `''`
+
+ Use a custom target directory when running the commands for ALE. This can
+ help to avoid "waiting for file lock on build directory" messages when
+ running `cargo` commands manually while ALE is performing its checks.
+
+
===============================================================================
rls *ale-rust-rls*
diff --git a/doc/ale.txt b/doc/ale.txt
index a19c6060..1951d7bd 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -246,7 +246,7 @@ A plugin might integrate its own checks with ALE like so: >
function! WorkDone(buffer, results) abort
" Send results to ALE after they have been collected.
- call ale#other_source#ShowResults(buffer, 'some-name', a:results)
+ call ale#other_source#ShowResults(a:buffer, 'some-name', a:results)
endfunction
<
@@ -418,9 +418,12 @@ The |ALEComplete| command can be used to show completion suggestions manually,
even when |g:ale_completion_enabled| is set to `0`. For manually requesting
completion information with Deoplete, consult Deoplete's documentation.
-When working with TypeScript files, ALE by can support automatic imports
-from external modules. This behavior can be enabled by setting the
-|g:ale_completion_tsserver_autoimport| variable to `1`.
+ALE by can support automatic imports from external modules. This behavior can
+be enabled by setting the |g:ale_completion_autoimport| variable to `1`.
+
+When working with TypeScript files, ALE can remove warnings from your
+completions by setting the |g:ale_completion_tsserver_remove_warnings|
+variable to 1.
*ale-completion-completeopt-bug*
@@ -681,8 +684,16 @@ g:ale_completion_enabled *g:ale_completion_enabled*
See |ale-completion|
+g:ale_completion_tsserver_remove_warnings *g:ale_completion_tsserver_remove_warnings*
+
+ Type: Number
+ Default: `0`
+
+ When this option is set to `0`, ALE will return all completion items,
+ including those that are a warning. Warnings can be excluded from completed
+ items by setting it to `1`.
-g:ale_completion_tsserver_autoimport *g:ale_completion_tsserver_autoimport*
+g:ale_completion_autoimport *g:ale_completion_autoimport*
Type: Number
Default: `0`
@@ -1227,6 +1238,7 @@ g:ale_linter_aliases *g:ale_linter_aliases*
\ 'csh': 'sh',
\ 'javascriptreact': ['javascript', 'jsx'],
\ 'plaintex': 'tex',
+ \ 'ps1': 'powershell',
\ 'rmarkdown': 'r',
\ 'rmd': 'r',
\ 'systemverilog': 'verilog',