summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2019-09-12 22:57:44 +0100
committerGitHub <noreply@github.com>2019-09-12 22:57:44 +0100
commit58b7c281c5beea4e68436412e68660a89be66e8d (patch)
tree651f5f4ddd2f5e3989bfd338dd8822d2c9c79498
parenta6c59faa0f4b7f6226859c1a9b5bae83b1aef295 (diff)
parent74a43755c6ecc72a33c189d8a50cf594d18f882e (diff)
downloadale-58b7c281c5beea4e68436412e68660a89be66e8d.zip
Merge pull request #2696 from elebow/update-test-docs-for-linter-lists
Update test docs and output for linter tables checked
-rw-r--r--doc/ale-development.txt11
-rwxr-xr-xtest/script/check-supported-tools-tables5
-rwxr-xr-xtest/script/custom-checks4
3 files changed, 10 insertions, 10 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index 16b16483..faa570c1 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -184,13 +184,12 @@ tests: https://github.com/junegunn/vader.vim
See |ale-development-linter-tests| for more information on how to write linter
tests.
-When you add new linters or fixers, make sure to add them into the table in
-the README, and also into the |ale-support| list in the main help file. If you
-forget to keep them both in sync, you should see an error like the following
-in Travis CI. >
-
+When you add new linters or fixers, make sure to add them into the tables in
+supported-tools.md and |ale-supported-languages-and-tools.txt|. If you forget to
+keep them both in sync, you should see an error like the following in Travis CI.
+>
========================================
- diff README.md and doc/ale.txt tables
+ diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
========================================
Differences follow:
diff --git a/test/script/check-supported-tools-tables b/test/script/check-supported-tools-tables
index 65270029..f4305707 100755
--- a/test/script/check-supported-tools-tables
+++ b/test/script/check-supported-tools-tables
@@ -3,8 +3,9 @@
set -e
set -u
-# This script compares the table of supported tools in both the README file
-# and the doc/ale.txt file, so we can complain if they don't match up.
+# This script compares the table of supported tools in both supported-tools.md
+# (for GitHub) and doc/ale-supported-languages-and-tools.txt (for vim), so we
+# can complain if they don't match up.
doc_file="$(mktemp -t doc.XXXXXXXX)"
doc_sorted_file="$(mktemp -t doc-sorted.XXXXXXXX)"
diff --git a/test/script/custom-checks b/test/script/custom-checks
index 20dbfb80..ca9069e4 100755
--- a/test/script/custom-checks
+++ b/test/script/custom-checks
@@ -36,12 +36,12 @@ tag_regex='[gb]\?:\?\(ale\|ALE\)[a-zA-Z_\-]\+'
# Grep for tags and references, and complain if we find a reference without
# a tag for the reference. Only our tags will be included.
diff -u \
- <(grep --exclude=tags -roh "\*$tag_regex\*" doc | sort -u | sed 's/*//g') \
+ <(grep --exclude=tags -roh "\\*$tag_regex\\*" doc | sort -u | sed 's/*//g') \
<(grep --exclude=tags -roh "|$tag_regex|" doc | sort -u | sed 's/|//g') \
| grep '^+[^+]' && exit_code=1
echo '========================================'
-echo 'diff README.md and doc/ale.txt tables'
+echo 'diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables'
echo '========================================'
echo 'Differences follow:'
echo