vignesh/dolibarr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: codespell - Add some more instructions

Browse source 
# Qual: Add some more instructions to the 'codespell' ignore script.

As codespell will likely be run from pre-commit where codespell
is installed in a venv for the user, running addCodespellIgnores.sh
from the CLI requires installation of codespell for the developer's
environment.
This add some information inside the script about that.
This commit is contained in:
MDW 2024-01-17 11:06:12 +01:00
parent 1d00d90872
commit 91a648fa3e
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
dev/tools/codespell/addCodespellIgnores.sh
View file

@ -11,10 +11,22 @@
# ```shell
# echo > dev/tools/codespell/codespell-lines-ignore.txt
# ```
# and then execute this script
# and then execute this script.
#
# author: https://github.com/mdeweerd
#
# :warning:
#
# This script only works properly if codespell is install for your CLI.
# As the configuration is in pyproject.toml, you also need tomli.
#
# ```shell
# python -m pip install codespell tomli
# # or
# pip install codespell tomli
# ```
codespell_ignore_file=dev/tools/codespell/codespell-lines-ignore.txt
if [ -z "${0##*.sh}" ] ; then
# Suppose running from inside script