diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index c505063..16f6d0a 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -31,7 +31,7 @@ jobs: echo "::group::Begin snap install" echo "Installing snaps in the background while running apt and pip..." sudo snap install --no-wait --classic pyright - sudo snap install --no-wait shellcheck ruff + sudo snap install --no-wait codespell shellcheck ruff echo "::endgroup::" echo "::group::pip install" python -m pip install tox diff --git a/HACKING.rst b/HACKING.rst index 4477e26..08a6768 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -22,6 +22,7 @@ you with tox, but you'll need to install: deadsnakes_ PPA) with setuptools. - tox_ version 3.8 or later - ShellCheck_ (also available via snap: ``snap install shellcheck``) +- Codespell_ (also available via snap: ``snap install codespell``) - ruff_ (also available via snap: ``snap install ruff``) Once you have all of those installed, you can install the necessary virtual @@ -267,6 +268,7 @@ Example footers:: .. _Black: https://black.readthedocs.io .. _`Canonical contributor licence agreement`: http://www.ubuntu.com/legal/contributors/ +.. _Codespell: https://github.com/codespell-project/codespell .. _`conventional commit`: https://www.conventionalcommits.org/en/v1.0.0/#summary .. _deadsnakes: https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa .. _`git submodules`: https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules diff --git a/pyproject.toml b/pyproject.toml index 77bdb73..3c68f60 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,8 +26,7 @@ dev = [ ] lint = [ "black~=24.1", - "codespell[toml]~=2.2", - "yamllint~=1.34" + "yamllint~=1.34", ] types = [ "mypy[reports]~=1.9.0", diff --git a/tox.ini b/tox.ini index b3a1d6b..58811bf 100644 --- a/tox.ini +++ b/tox.ini @@ -63,6 +63,7 @@ extras = lint env_dir = {work_dir}/linting runner = ignore_env_name_mismatch allowlist_externals = + codespell: codespell shellcheck: bash, xargs ruff: ruff