Skip to content

Commit 98bab2e

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

3 files changed

Lines changed: 41 additions & 1 deletion

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.

REUSE.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ SPDX-FileCopyrightText = "Copyright the Vortex contributors"
3131
SPDX-License-Identifier = "CC-BY-4.0"
3232

3333
[[annotations]]
34-
path = ["**/.gitignore", ".gitmodules", ".python-version", "**/*.lock", "**/*.lockfile", "**/*.toml", "renovate.json", ".idea/**", ".github/**", "codecov.yml", "java/gradle/wrapper/gradle-wrapper.properties"]
34+
path = ["**/.gitignore", ".gitmodules", ".python-version", "**/*.lock", "**/*.lockfile", "**/*.toml", "justfile", "renovate.json", ".idea/**", ".github/**", "codecov.yml", "java/gradle/wrapper/gradle-wrapper.properties"]
3535
precedence = "override"
3636
SPDX-FileCopyrightText = "Copyright the Vortex contributors"
3737
SPDX-License-Identifier = "Apache-2.0"

scripts/justfile

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

0 commit comments

Comments
 (0)