Skip to content

Commit e406a58

Browse files
committed
add justfile
Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
1 parent 2e9470f commit e406a58

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ share/python-wheels/
3030
*.egg
3131
MANIFEST
3232

33+
# Commands
34+
/justfile
35+
3336
# PyInstaller
3437
# Usually these files are written by a python script from a template
3538
# before PyInstaller builds the exe, so as to inject date/other infos into it.

scripts/justfile

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
# SPDX-FileCopyrightText: Copyright the Vortex contributors
3+
#
4+
# Vortex development shortcuts.
5+
#
6+
# Note that our GitHub CI runs `fmt`, `clippy`, `nextest`, `lint`, and `doc` to gate pull request
7+
# merges, so you may find it helpful to run those locally before pushing!
8+
9+
# Format Rust source files, or including .toml files with `just fmt all`.
10+
fmt *ARGS:
11+
cargo +nightly fmt --all
12+
{{ if ARGS == "all" { "taplo fmt" } else { "" } }}
13+
14+
# Run clippy with --all-targets (additional flags like `--all-features` are passed through).
15+
clippy *ARGS:
16+
cargo clippy --all-targets {{ ARGS }}
17+
18+
# Run tests.
19+
test *ARGS:
20+
cargo test {{ ARGS }}
21+
22+
# Run nextest with --no-fail-fast.
23+
nextest *ARGS:
24+
cargo nextest run --no-fail-fast {{ ARGS }}
25+
26+
# Run any recipe with RUST_BACKTRACE=1 (e.g., `just bt test -p vortex-array`).
27+
bt +ARGS:
28+
RUST_BACKTRACE=1 just {{ ARGS }}
29+
30+
# Run reuse lint.
31+
lint:
32+
reuse lint
33+
34+
# Build docs with --no-deps.
35+
doc *ARGS:
36+
cargo doc --no-deps {{ ARGS }}
37+
38+
# Clean the workspace.
39+
clean:
40+
cargo +nightly clean --workspace

0 commit comments

Comments
 (0)