Add cspell Linter (#3981)

* Add cspell linter

Add cspell linter, with the languages it supports.

Signed-off-by: David Houston <houstdav000@gmail.com>

* Add cspell Global Variables Documentation

Add documentation to /doc/ale.txt with cspell configuration options.

Signed-off-by: David Houston <houstdav000@gmail.com>

* Add cspell to docs, Minor Cleanup

Add cspell for each supported language, adding some spaces and removing
others when caught navigating the file.

Signed-off-by: David Houston <houstdav000@gmail.com>

1 files changed, 14 insertions, 5 deletions

diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 10cc2897..7486d0b4 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -10,6 +10,7 @@ g:ale_python_auto_pipenv                             *g:ale_python_auto_pipenv*
   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_auto_poetry                             *g:ale_python_auto_poetry*
                                                      *b:ale_python_auto_poetry*
   Type: |Number|
@@ -18,6 +19,7 @@ g:ale_python_auto_poetry                             *g:ale_python_auto_poetry*
   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 Python Project Root Behavior                              *ale-python-root*
 
@@ -229,6 +231,7 @@ g:ale_python_black_auto_pipenv                 *g:ale_python_black_auto_pipenv*
   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_black_auto_poetry                 *g:ale_python_black_auto_poetry*
                                                *b:ale_python_black_auto_poetry*
   Type: |Number|
@@ -237,6 +240,7 @@ g:ale_python_black_auto_poetry                 *g:ale_python_black_auto_poetry*
   Detect whether the file is inside a poetry, and set the executable to `poetry`
   if true. This is overridden by a manually-set executable.
 
+
 g:ale_python_black_change_directory       *g:ale_python_black_change_directory*
                                           *b:ale_python_black_change_directory*
   Type: |Number|
@@ -249,12 +253,18 @@ g:ale_python_black_change_directory       *g:ale_python_black_change_directory*
 
 
 ===============================================================================
+cspell                                                      *ale-python-cspell*
+
+See |ale-cspell-options|
+
+
+===============================================================================
 flake8                                                      *ale-python-flake8*
 
 g:ale_python_flake8_change_directory     *g:ale_python_flake8_change_directory*
                                          *b:ale_python_flake8_change_directory*
   Type: |String|
-  Default: `project`
+  Default: `'project'`
 
   If set to `project`, ALE will switch to the project root before checking file.
   If set to `file`, ALE will switch to directory the Python file being
@@ -320,6 +330,7 @@ g:ale_python_flake8_auto_poetry               *g:ale_python_flake8_auto_poetry*
   Detect whether the file is inside a poetry, and set the executable to `poetry`
   if true. This is overridden by a manually-set executable.
 
+
 ===============================================================================
 flakehell                                                *ale-python-flakehell*
 
@@ -384,6 +395,7 @@ g:ale_python_flakehell_auto_poetry         *g:ale_python_flakehell_auto_poetry*
   Detect whether the file is inside a poetry, and set the executable to `poetry`
   if true. This is overridden by a manually-set executable.
 
+
 ===============================================================================
 isort                                                        *ale-python-isort*
 
@@ -504,7 +516,6 @@ g:ale_python_mypy_use_global                     *g:ale_python_mypy_use_global*
   See |ale-integrations-local-executables|
 
 
-
 ===============================================================================
 prospector                                              *ale-python-prospector*
 
@@ -569,7 +580,6 @@ g:ale_python_prospector_auto_poetry       *g:ale_python_prospector_auto_poetry*
 ===============================================================================
 pycodestyle                                            *ale-python-pycodestyle*
 
-
 g:ale_python_pycodestyle_executable       *g:ale_python_pycodestyle_executable*
                                           *b:ale_python_pycodestyle_executable*
   Type: |String|
@@ -619,7 +629,6 @@ g:ale_python_pycodestyle_auto_poetry     *g:ale_python_pycodestyle_auto_poetry*
 ===============================================================================
 pydocstyle                                              *ale-python-pydocstyle*
 
-
 g:ale_python_pydocstyle_executable         *g:ale_python_pydocstyle_executable*
                                            *b:ale_python_pydocstyle_executable*
   Type: |String|
@@ -669,7 +678,6 @@ g:ale_python_pydocstyle_auto_poetry       *g:ale_python_pydocstyle_auto_poetry*
 ===============================================================================
 pyflakes                                                  *ale-python-pyflakes*
 
-
 g:ale_python_pyflakes_executable             *g:ale_python_pyflakes_executable*
                                              *b:ale_python_pyflakes_executable*
   Type: |String|
@@ -925,6 +933,7 @@ g:ale_python_pylsp_options                           *g:ale_python_pylsp_options
   An example stragety for installing `pylsp`:
     `python3 -m pip install --user pylsp`
 
+
 ===============================================================================
 pyre                                                          *ale-python-pyre*