Skip to content

Commit

Permalink
chore: Add usage instructions and command examples to justfile.
Browse files Browse the repository at this point in the history
  • Loading branch information
pavadeli committed May 30, 2024
1 parent 8d391b0 commit 31d469f
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
2 changes: 1 addition & 1 deletion crates/emulator-tracing/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ctreg = { workspace = true }
itertools = { workspace = true }
once_cell = { workspace = true }
thiserror = { workspace = true }
time = { workspace = true }
time = { workspace = true, features = ["macros"] }
tracing = { workspace = true }
tracing-subscriber = { workspace = true, features = [
"local-time",
Expand Down
2 changes: 1 addition & 1 deletion crates/googleapis/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ doctest = false
[dependencies]
time = { workspace = true, features = ["formatting", "macros"] }
prost = { workspace = true }
serde = { workspace = true }
serde = { workspace = true, features = ["serde_derive"] }
thiserror = { workspace = true }
tonic = { workspace = true }

Expand Down
2 changes: 1 addition & 1 deletion crates/hybrid-axum-tonic/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tonic-build = { workspace = true }

[dev-dependencies]
prost = { workspace = true }
tokio = { workspace = true }
tokio = { workspace = true, features = ["macros"] }

# Do not use workspace lints here, because generated code is not that clean.
[lints.rust]
Expand Down
12 changes: 12 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Usage:
# Most recipes can re-run automatically on file change by prepending "watch" to the command. For example: `just lint` runs linting once, `just watch lint` runs linting on file change.
# Some commands:
# just - Run test and linting once
# just watch - Watch test and lint, re-run on filechange
# just [watch] test [crate] - Run tests on workspace or the specified crate, e.g. `just test` or `just watch test emulator-tracing`
# just [watch] lint [crate] - Run linting on workspace or the specified crate
# just [watch] clean - Clean the repo, removing all compiled and generated artifacts
# just [watch] run [args..] - Run the application, passing the provided args to `cargo run`
# just [watch] build [args..] - Build the application, passing the provided args to `cargo build`

set quiet

# Default action is to test and lint once.
Expand All @@ -23,6 +34,7 @@ doctest target: (
}
)

# Trick to be able to use `if` statement for conditional execution above
[private]
exec +cmd:
{{ cmd }}
Expand Down

0 comments on commit 31d469f

Please sign in to comment.