lint: Add spell check linter (codespell)

cosanta · Sep 4, 2018 · f8a81f7 · f8a81f7
1 parent ada3562
commit f8a81f7
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/.travis/lint_04_install.sh b/.travis/lint_04_install.sh
@@ -6,4 +6,5 @@
 
 export LC_ALL=C
 
+travis_retry pip install codespell
 travis_retry pip install flake8
diff --git a/test/lint/lint-spelling.ignore-words.txt b/test/lint/lint-spelling.ignore-words.txt
@@ -2,4 +2,5 @@ cas
 hights
 mor
 objext
+unselect
 useable
diff --git a/test/lint/lint-spelling.sh b/test/lint/lint-spelling.sh
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2018 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+# Warn in case of spelling errors.
+# Note: Will exit successfully regardless of spelling errors.
+
+export LC_ALL=C
+
+IGNORE_WORDS_FILE=test/lint/lint-spelling.ignore-words.txt
+if ! codespell --check-filenames --disable-colors --quiet-level=7 --ignore-words=${IGNORE_WORDS_FILE} $(git ls-files -- ":(exclude)build-aux/m4/" ":(exclude)contrib/seeds/*.txt" ":(exclude)depends/" ":(exclude)doc/release-notes/" ":(exclude)src/leveldb/" ":(exclude)src/qt/locale/" ":(exclude)src/secp256k1/" ":(exclude)src/univalue/"); then
+    echo "^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in ${IGNORE_WORDS_FILE}"
+fi
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,5 @@

		export LC_ALL=C

		travis_retry pip install codespell
		travis_retry pip install flake8
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,5 @@ cas @@
     hights
     mor
     objext
+    unselect
     useable