diff --git a/Justfile b/Justfile index 05140c0..de0712a 100644 --- a/Justfile +++ b/Justfile @@ -13,6 +13,7 @@ clean: fmt: cargo fmt + git ls-files | grep '\.py$' | xargs isort git ls-files | grep '\.py$' | xargs black git ls-files | grep '\.sh$' | xargs -L 1 shfmt --indent 4 --write @@ -23,6 +24,7 @@ fmt-check: lint: cargo clippy --no-deps -- -Dwarnings + git ls-files | grep '\.py$' | xargs ruff --ignore E501 git ls-files | grep '\.sh$' | xargs -L 1 shellcheck --norc lint-fix: diff --git a/docs/src/developing.md b/docs/src/developing.md index 33eb147..df32a6f 100644 --- a/docs/src/developing.md +++ b/docs/src/developing.md @@ -34,8 +34,8 @@ You will need the following tools: [here](https://github.com/casey/just#installation) for installation instructions (it's most likely just a simple `cargo install just`). * Docker & docker-compose for the e2e tests -* `black` and `shfmt` for formatting. -* `shellcheck` for shell script linting +* `isort`, `black` and `shfmt` for formatting. +* `ruff` and `shellcheck` for linting. * `mdbook` for the documentation Here are the tools: diff --git a/docs/src/testing.md b/docs/src/testing.md index c3c2c4c..4dcedad 100644 --- a/docs/src/testing.md +++ b/docs/src/testing.md @@ -49,7 +49,7 @@ Note: You will most likely not need to read this. Each test parameter will exponentially increase the number of tests that will be run. As a general rule, comprehensiveness is more important than test suite runtime (so if in doubt, better to add another parameter to catch every edge -case). But try to keep the total runtime sane. Currently, the whole `just e2e` +case). But try to keep the total runtime sane. Currently, the whole `just test-e2e` target runs ~8'000 tests and takes around 5 minutes on my machine, exlucding binary and docker build time. I'd say that keeping it under 10 minutes is a good idea.