Skip to content

Commit 0c4080f

Browse files
Merge pull request #32 from cooperwalbrun/dependency-report
Add Support for the "cargo make dependency-report" Command
2 parents 0e2774a + d71009b commit 0c4080f

3 files changed

Lines changed: 23 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,19 @@ cargo install cargo-make
1919

2020
With `cargo-make`, all of this project's commands will become available to you:
2121

22-
```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
33-
```
22+
| Command | Description/Function |
23+
|--------------------------------|--------------------------------------------------------------------------------------------|
24+
| `cargo make clean` | Clean up temporary files |
25+
| `cargo make build` | Lint and build the project |
26+
| `cargo make run` | Run the application |
27+
| `cargo make test` | Run all unit tests |
28+
| `cargo make test-coverage` | Run all unit tests and write a code coverage report to STDOUT |
29+
| `cargo make test-coverage-ci` | Run all unit tests and write a code coverage report to a text file in LCOV format |
30+
| `cargo make format` | Format (rewrite) every applicable file in the project |
31+
| `cargo make format-ci` | Format (report only) every applicable file in the project |
32+
| `cargo make lint` | Lint (report only) every applicable file in the project |
33+
| `cargo make lint-watch` | Lint (report only) every applicable file in the project and re-lints whenever files change |
34+
| `cargo make dependency-report` | Show outdated dependencies in the project, if any |
3435

3536
`cargo-make` will automatically fetch crates and toolchain components as needed when you run these
3637
commands. Between this and what is defined in `Cargo.toml`, you should never need to issue a
@@ -45,8 +46,8 @@ settings in [rustfmt.toml](./rustfmt.toml).
4546
This project uses [rust-clippy](https://github.com/rust-lang/rust-clippy) to handle linting, and
4647
contributions 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

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "rust-template"
33
edition = "2024"
44
version = "0.1.0"
5-
rust-version = "1.89.0"
5+
rust-version = "1.90.0"
66
authors = ["FirstName LastName <email@domain.com>"]
77
description = "A short description of your project."
88
documentation = "https://github.com/cooperwalbrun/rust-template/blob/master/README.md"

Makefile.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
[tasks.dependency-report]
2+
description = "Show outdated dependency versions."
3+
env = { CARGO_MAKE_RUST_DEFAULT_TOOLCHAIN = "stable" } # See: https://github.com/sagiegurari/cargo-make/discussions/767
4+
install_crate = "cargo-outdated"
5+
command = "cargo"
6+
args = ["outdated", "--root-deps-only"]
7+
18
[tasks.format]
29
description = "Format all source files."
310
env = { CARGO_MAKE_RUST_DEFAULT_TOOLCHAIN = "stable" } # See: https://github.com/sagiegurari/cargo-make/discussions/767

0 commit comments

Comments
 (0)