Skip to content

Add a Justfile #5636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
neongreen wants to merge 1 commit into from
Closed

Add a Justfile #5636

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[private]
default:
@just --list

# Format all code
format:
cargo +nightly fmt

Copy link
Copy Markdown
Member

@emesterhazy emesterhazy Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A clippy alias matching CI would also be helpful:

cargo +stable clippy --all-features --workspace --all-targets

# Update generated CLI help (cli/tests/cli-reference@.md.snap)
update-cli-reference:
cargo insta test --accept --workspace -- test_generate_md_cli_help

# Preview documentation with live reloading
[group('docs')]
serve-docs:
uv run mkdocs serve

# Build documentation into rendered-docs/ for offline use
[group('docs')]
build-docs:
uv run mkdocs build -f mkdocs-offline.yml