Skip to content

Testing

This projects provides a few different tests and checks.

In general, we have two files which defines all the tests:

To easily run these tests locally, use:

./scripts/test.sh

If you only want to run the pre-commit hooks manually, use:

uv run prek run --all-files

Static code checks using ruff:

# linter
uv run ruff check src
uv run ruff check scripts
# formatter
uv run ruff format --diff src
uv run ruff format --diff scripts

To run automatic static code fixes, use:

# linter
uv run ruff check --fix src
uv run ruff check --fix tests
uv run ruff check --fix scripts
# formatter
uv run ruff format src
uv run ruff format tests
uv run ruff format scripts

Static code analysis using pylint:

uv run pylint --fail-under=6 src
uv run pylint --exit-zero tests
uv run pylint --exit-zero scripts

Static type checks using ty:

uv run ty src
uv run ty tests
uv run ty scripts

General typo checking using typos:

uv run typos

Bash Script Checks

find scripts -type f -name "*.sh" -exec uv run shellcheck --external-sources --shell bash --source-path scripts {} +

Markdown Checks

Verify documentation (markdown) compliance w.r.t. markdown linting rules further specified inside the .markdownlint-cli2.jsonc configuration file.

npm exec markdownlint-cli2 -- "./docs/**/*.md" "./README.md"

License Checks

uv run licensecheck
uv run reuse lint

Vulnerability Checks

uv audit