@@ -20,16 +20,17 @@ cargo install cargo-make
2020With ` cargo-make ` , all of this project's commands will become available to you:
2121
2222``` bash
23- cargo make clean # Clean up temporary files
24- cargo make build # Lint and build the project
25- cargo make run # Run the application
26- cargo make test # Run all unit tests
27- cargo make test-coverage # Run all unit tests and write a code coverage report to STDOUT
28- cargo make test-coverage-ci # Run all unit tests and write a code coverage report to a text file in LCOV format
29- cargo make format # Format (rewrite) every applicable file in the project
30- cargo make format-ci # Format (report only) every applicable file in the project
31- cargo make lint # Lint (report only) every applicable file in the project
32- cargo make lint-watch # Lint (report only) every applicable file in the project and re-lints whenever files change
23+ cargo make clean # Clean up temporary files
24+ cargo make build # Lint and build the project
25+ cargo make run # Run the application
26+ cargo make test # Run all unit tests
27+ cargo make test-coverage # Run all unit tests and write a code coverage report to STDOUT
28+ cargo make test-coverage-ci # Run all unit tests and write a code coverage report to a text file in LCOV format
29+ cargo make format # Format (rewrite) every applicable file in the project
30+ cargo make format-ci # Format (report only) every applicable file in the project
31+ cargo make lint # Lint (report only) every applicable file in the project
32+ cargo make lint-watch # Lint (report only) every applicable file in the project and re-lints whenever files change
33+ cargo make dependency-report # Show outdated dependencies in the project, if any
3334```
3435
3536` cargo-make ` will automatically fetch crates and toolchain components as needed when you run these
@@ -45,8 +46,8 @@ settings in [rustfmt.toml](./rustfmt.toml).
4546This project uses [ rust-clippy] ( https://github.com/rust-lang/rust-clippy ) to handle linting, and
4647contributions are expected to be checked using the settings in [ clippy.toml] ( ./clippy.toml ) .
4748
48- > Note: ` rustfmt ` and ` rust-clippy ` each have many built-in defaults that will be used in the
49- > absence of a corresponding rule in ` rustfmt.toml ` /` clippy.toml ` .
49+ > Note: ` rustfmt ` and ` rust-clippy ` each have many built-in defaults to which this project will defer
50+ > in the absence of a corresponding rule in ` rustfmt.toml ` /` clippy.toml ` .
5051
5152## Code Policy
5253
0 commit comments