chore: Add fmt in justfile; Update doc
This commit is contained in:
2
Justfile
2
Justfile
@@ -13,6 +13,7 @@ clean:
|
|||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
cargo fmt
|
cargo fmt
|
||||||
|
git ls-files | grep '\.py$' | xargs isort
|
||||||
git ls-files | grep '\.py$' | xargs black
|
git ls-files | grep '\.py$' | xargs black
|
||||||
git ls-files | grep '\.sh$' | xargs -L 1 shfmt --indent 4 --write
|
git ls-files | grep '\.sh$' | xargs -L 1 shfmt --indent 4 --write
|
||||||
|
|
||||||
@@ -23,6 +24,7 @@ fmt-check:
|
|||||||
|
|
||||||
lint:
|
lint:
|
||||||
cargo clippy --no-deps -- -Dwarnings
|
cargo clippy --no-deps -- -Dwarnings
|
||||||
|
git ls-files | grep '\.py$' | xargs ruff --ignore E501
|
||||||
git ls-files | grep '\.sh$' | xargs -L 1 shellcheck --norc
|
git ls-files | grep '\.sh$' | xargs -L 1 shellcheck --norc
|
||||||
|
|
||||||
lint-fix:
|
lint-fix:
|
||||||
|
|||||||
@@ -34,8 +34,8 @@ You will need the following tools:
|
|||||||
[here](https://github.com/casey/just#installation) for installation
|
[here](https://github.com/casey/just#installation) for installation
|
||||||
instructions (it's most likely just a simple `cargo install just`).
|
instructions (it's most likely just a simple `cargo install just`).
|
||||||
* Docker & docker-compose for the e2e tests
|
* Docker & docker-compose for the e2e tests
|
||||||
* `black` and `shfmt` for formatting.
|
* `isort`, `black` and `shfmt` for formatting.
|
||||||
* `shellcheck` for shell script linting
|
* `ruff` and `shellcheck` for linting.
|
||||||
* `mdbook` for the documentation
|
* `mdbook` for the documentation
|
||||||
|
|
||||||
Here are the tools:
|
Here are the tools:
|
||||||
|
|||||||
@@ -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
|
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
|
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
|
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
|
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
|
binary and docker build time. I'd say that keeping it under 10 minutes is a good
|
||||||
idea.
|
idea.
|
||||||
|
|||||||
Reference in New Issue
Block a user