deck/justfile at main · hellno/deck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# Deck — task runner. Install `just`: brew install just
# (Everything here is plain cargo + macOS built-ins; you can run the commands by hand too.)

# List available recipes.
default:
    @just --list

# Run the app (debug). This is the one you'll use 99% of the time.
run:
    cargo run

# Run optimized.
run-release:
    cargo run --release

# Run as a menu-bar / tray app (no dock icon).
run-tray:
    cargo run --features tray

# Run with the floating overlay surface (transparent always-on-top window).
run-overlay:
    cargo run --features overlay

# Screenshot the running app → an image. macOS only; grant your terminal Screen
# Recording + Accessibility once (System Settings → Privacy & Security). Launches the
# app, captures, quits. What's captured depends on the feature you pass (arg 2):
#   just screenshot                                          # welcome → docs/screenshot.png
#   just screenshot docs/screenshot-settings.png "" cmd+,    # settings page (window)
#   just screenshot docs/screenshot-palette.png  "" cmd+k    # command palette (window)
#   just screenshot docs/overlay.png overlay                 # rail + pill → -rail/-pill (alpha)
#   SHOT_BACKDROP=zed just screenshot docs/tray.png tray     # menu-bar status item + menu
# Overlay panels capture with transparency (leak-proof). Hover states still need a cursor
# tool (e.g. `cliclick`) and are out of scope.
screenshot out="docs/screenshot.png" features="" keys="":
    bash scripts/screenshot.sh "{{out}}" "{{features}}" "{{keys}}"

# Format the code.
fmt:
    cargo fmt

# Lint both feature configurations (clippy, warnings = errors). For the FULL gate use `just ci`.
check:
    cargo clippy --locked --all-targets -- -D warnings
    cargo clippy --locked --all-targets --features tray -- -D warnings
    cargo clippy --locked --all-targets --features overlay -- -D warnings
    cargo clippy --locked --all-targets --features tray,overlay -- -D warnings

# The full CI gate, locally — the whole Definition of Done in one command. Run this before you
# call a change done; it mirrors .github/workflows/ci.yml so green here == green in CI.
ci:
    cargo fmt --all --check
    cargo clippy --locked --all-targets -- -D warnings
    cargo clippy --locked --all-targets --features tray -- -D warnings
    cargo clippy --locked --all-targets --features overlay -- -D warnings
    cargo clippy --locked --all-targets --features tray,overlay -- -D warnings
    cargo test --locked
    cargo test --locked --features overlay

# Verify the TEMPLATE itself: this repo's source carries {{ }} tokens and does NOT build
# directly, so render a throwaway project (outside the repo, like CI) and lint + test that.
# Needs cargo-generate (`cargo install cargo-generate`). Inside a generated fork, use `just ci`.
check-template:
    rm -rf "${TMPDIR:-/tmp}/deck-template-check"
    cargo generate --path "{{justfile_directory()}}" --name app --silent --vcs none --destination "${TMPDIR:-/tmp}/deck-template-check"
    cd "${TMPDIR:-/tmp}/deck-template-check/app" && cargo clippy --all-targets --features tray,overlay -- -D warnings && cargo test && cargo test --features overlay

# Auto-fix everything fixable: clippy's machine-applicable suggestions + formatting.
# Re-run `just ci` afterwards to confirm green. (--allow-dirty so it works mid-edit.)
fix:
    cargo clippy --fix --allow-dirty --allow-staged --all-targets
    cargo clippy --fix --allow-dirty --allow-staged --all-targets --features tray
    cargo clippy --fix --allow-dirty --allow-staged --all-targets --features overlay
    cargo clippy --fix --allow-dirty --allow-staged --all-targets --features tray,overlay
    cargo fmt

# Bump the git GPUI stack to the latest upstream commits, then rebuild.
# Reproducibility lives in Cargo.lock — commit it (and rust-toolchain.toml if you
# bumped it) after this succeeds. If the build fails on an unstable-feature error,
# match rust-toolchain.toml to Zed's: https://github.com/zed-industries/zed/blob/main/rust-toolchain.toml
# Full procedure + the crates.io fallback channel: docs/UPGRADING.md
bump-gpui:
    cargo update -p gpui -p gpui_platform -p gpui-component -p gpui-component-assets
    cargo build
    @echo "→ Bumped. Run the app to smoke-test, then commit Cargo.lock (+ rust-toolchain.toml if changed)."

# Build a distributable Deck.app (needs: cargo install cargo-bundle).
# Output: target/release/bundle/osx/Deck.app
bundle:
    cargo bundle --release
    @echo "→ target/release/bundle/osx/Deck.app"

# Open the bundled app.
open: bundle
    open "target/release/bundle/osx/Deck.app"

# Regenerate assets/icon.png + assets/icon.icns from assets/icon-source.png.
# Drop your own 1024x1024 image at assets/icon-source.png first (any square art —
# a render, photo, or logo; an .svg source is rasterized automatically).
# Bakes in the macOS squircle tile + padding + shadow (macOS does NOT auto-mask).
# Needs Pillow (pip install pillow); the .icns step uses macOS iconutil.
icon:
    python3 scripts/make-app-icon.py

# Same, plus a freedesktop hicolor tree + .desktop entry under dist/linux/.
icon-linux:
    python3 scripts/make-app-icon.py --linux --web