lint: convert spell check lint test to python
This commit is contained in:
2 files changed
+40
-21
No files matched your search
Executable
+40
@@ -0,0 +1,40 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
#
|
||||||
|
# Copyright (c) 2022 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.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from subprocess import check_output, STDOUT, CalledProcessError
|
||||||
|
|
||||||
|
IGNORE_WORDS_FILE = 'test/lint/spelling.ignore-words.txt'
|
||||||
|
FILES_ARGS = ['git', 'ls-files', '--', ":(exclude)build-aux/m4/", ":(exclude)contrib/seeds/*.txt", ":(exclude)depends/", ":(exclude)doc/release-notes/", ":(exclude)src/leveldb/", ":(exclude)src/crc32c/", ":(exclude)src/qt/locale/", ":(exclude)src/qt/*.qrc", ":(exclude)src/secp256k1/", ":(exclude)src/minisketch/", ":(exclude)src/univalue/", ":(exclude)contrib/builder-keys/keys.txt", ":(exclude)contrib/guix/patches"]
|
||||||
|
|
||||||
|
|
||||||
|
def check_codespell_install():
|
||||||
|
try:
|
||||||
|
check_output(["codespell", "--version"])
|
||||||
|
except FileNotFoundError:
|
||||||
|
print("Skipping spell check linting since codespell is not installed.")
|
||||||
|
exit(0)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
check_codespell_install()
|
||||||
|
|
||||||
|
files = check_output(FILES_ARGS).decode("utf-8").splitlines()
|
||||||
|
codespell_args = ['codespell', '--check-filenames', '--disable-colors', '--quiet-level=7', '--ignore-words={}'.format(IGNORE_WORDS_FILE)] + files
|
||||||
|
|
||||||
|
try:
|
||||||
|
check_output(codespell_args, stderr=STDOUT)
|
||||||
|
except CalledProcessError as e:
|
||||||
|
print(e.output.decode("utf-8"), end="")
|
||||||
|
print('^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in {}'.format(IGNORE_WORDS_FILE))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
#
|
|
||||||
# Copyright (c) 2018-2021 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
|
|
||||||
|
|
||||||
if ! command -v codespell > /dev/null; then
|
|
||||||
echo "Skipping spell check linting since codespell is not installed."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
IGNORE_WORDS_FILE="test/lint/spelling.ignore-words.txt"
|
|
||||||
mapfile -t FILES < <(git ls-files -- ":(exclude)build-aux/m4/" ":(exclude)contrib/seeds/*.txt" ":(exclude)depends/" ":(exclude)doc/release-notes/" ":(exclude)src/leveldb/" ":(exclude)src/crc32c/" ":(exclude)src/qt/locale/" ":(exclude)src/qt/*.qrc" ":(exclude)src/secp256k1/" ":(exclude)src/minisketch/" ":(exclude)src/univalue/" ":(exclude)contrib/builder-keys/keys.txt" ":(exclude)contrib/guix/patches")
|
|
||||||
if ! codespell --check-filenames --disable-colors --quiet-level=7 --ignore-words=${IGNORE_WORDS_FILE} "${FILES[@]}"; then
|
|
||||||
echo "^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in ${IGNORE_WORDS_FILE}"
|
|
||||||
fi
|
|
||||||
Reference in new issue
Block a user