just/justfile
2024-07-16 11:27:29 -07:00

277 lines
5.8 KiB
Makefile
Executable File

#!/usr/bin/env -S just --justfile
# ^ A shebang isn't required, but allows a justfile to be executed
# like a script, with `./justfile test`, for example.
alias t := test
alias c := check
log := "warn"
export JUST_LOG := log
watch +args='test':
cargo watch --clear --exec '{{ args }}'
[group: "testing"]
[doc: "Run just test suite"]
test:
cargo test
ci: lint build-book
cargo test --all
# Run lint checks
[group: "code-checking"]
lint:
cargo clippy --all --all-targets -- --deny warnings
./bin/forbid
cargo fmt --all -- --check
cargo update --locked --package just
[group: "testing"]
[doc: "Run fuzz tests"]
fuzz:
cargo +nightly fuzz run fuzz-compiler
run:
cargo run
# only run tests matching PATTERN
[group: "testing"]
filter PATTERN:
cargo test {{PATTERN}}
# Build just
[group: "developer-workflow"]
build:
cargo build
[group: "code-checking"]
fmt:
cargo fmt --all
[group: "code-checking"]
shellcheck:
shellcheck www/install.sh
# Generate the just manpage
[group: "documentation"]
man:
mkdir -p man
cargo run -- --man > man/just.1
# View the Just manpage
[group: "documentation"]
view-man: man
man man/just.1
# add git log messages to changelog
[group: "developer-workflow"]
update-changelog:
echo >> CHANGELOG.md
git log --pretty='format:- %s' >> CHANGELOG.md
# Update the contributors file
[group: "developer-workflow"]
update-contributors:
cargo run --release --package update-contributors
[group: "code-checking"]
check: fmt clippy test forbid
#!/usr/bin/env bash
set -euxo pipefail
git diff --no-ext-diff --quiet --exit-code
VERSION=`sed -En 's/version[[:space:]]*=[[:space:]]*"([^"]+)"/\1/p' Cargo.toml | head -1`
grep "^\[$VERSION\]" CHANGELOG.md
outdated:
cargo outdated -R
# publish current GitHub master branch
[group: "developer-workflow"]
publish:
#!/usr/bin/env bash
set -euxo pipefail
rm -rf tmp/release
git clone git@github.com:casey/just.git tmp/release
cd tmp/release
! grep '<sup>master</sup>' README.md
VERSION=`sed -En 's/version[[:space:]]*=[[:space:]]*"([^"]+)"/\1/p' Cargo.toml | head -1`
git tag -a $VERSION -m "Release $VERSION"
git push origin $VERSION
cargo publish
cd ../..
rm -rf tmp/release
[group: "documentation"]
[doc: "Search for master version note subscripts in the README"]
readme-version-notes:
grep '<sup>master</sup>' README.md
[group: "developer-workflow"]
[doc: "Push to GitHub"]
push: check
! git branch | grep '* master'
git push github
[group: "developer-workflow"]
[doc: "Create a pull request"]
pr: push
gh pr create --web
# clean up feature branch BRANCH
done BRANCH=`git rev-parse --abbrev-ref HEAD`:
git checkout master
git diff --no-ext-diff --quiet --exit-code
git pull --rebase github master
git diff --no-ext-diff --quiet --exit-code {{BRANCH}}
git branch -D {{BRANCH}}
# install just from crates.io
install:
cargo install -f just
# install development dependencies
install-dev-deps:
rustup install nightly
rustup update nightly
cargo +nightly install cargo-fuzz
cargo install cargo-check
cargo install cargo-watch
cargo install mdbook mdbook-linkcheck
# everyone's favorite animate paper clip
[group: "code-checking"]
clippy:
cargo clippy --all --all-targets --all-features
forbid:
./bin/forbid
# count non-empty lines of code
[group: "developer-workflow"]
sloc:
@cat src/*.rs | sed '/^\s*$/d' | wc -l
replace FROM TO:
sd '{{FROM}}' '{{TO}}' src/*.rs
[group: "demo-recipes"]
test-quine:
cargo run -- quine
# make a quine, compile it, and verify it
[group: "demo-recipes"]
quine:
mkdir -p tmp
@echo '{{quine-text}}' > tmp/gen0.c
cc tmp/gen0.c -o tmp/gen0
./tmp/gen0 > tmp/gen1.c
cc tmp/gen1.c -o tmp/gen1
./tmp/gen1 > tmp/gen2.c
diff tmp/gen1.c tmp/gen2.c
rm -r tmp
@echo 'It was a quine!'
quine-text := '
int printf(const char*, ...);
int main() {
char *s =
"int printf(const char*, ...);"
"int main() {"
" char *s = %c%s%c;"
" printf(s, 34, s, 34);"
" return 0;"
"}";
printf(s, 34, s, 34);
return 0;
}
'
[group: "documentation"]
render-readme:
#!/usr/bin/env ruby
require 'github/markup'
$rendered = GitHub::Markup.render("README.adoc", File.read("README.adoc"))
File.write('tmp/README.html', $rendered)
[group: "documentation"]
watch-readme:
just render-readme
fswatch -ro README.adoc | xargs -n1 -I{} just render-readme
# Test shell completions
[group: "testing"]
test-completions:
./tests/completions/just.bash
[group: "documentation"]
build-book:
cargo run --package generate-book
mdbook build book/en
mdbook build book/zh
convert-integration-test test:
cargo expand --test integration {{test}} | \
sed \
-E \
-e 's/#\[cfg\(test\)\]/#\[test\]/' \
-e 's/^ *let test = //' \
-e 's/^ *test[.]/./' \
-e 's/;$//' \
-e 's/crate::test::Test/Test/' \
-e 's/\.run\(\)/.run();/'
# run all polyglot recipes
[group: "demo-recipes"]
polyglot: _python _js _perl _sh _ruby
_python:
#!/usr/bin/env python3
print('Hello from python!')
_js:
#!/usr/bin/env node
console.log('Greetings from JavaScript!')
_perl:
#!/usr/bin/env perl
print "Larry Wall says Hi!\n";
_sh:
#!/usr/bin/env sh
hello='Yo'
echo "$hello from a shell script!"
_nu:
#!/usr/bin/env nu
let hellos = ["Greetings", "Yo", "Howdy"]
$hellos | each {|el| print $"($el) from a nushell script!" }
_ruby:
#!/usr/bin/env ruby
puts "Hello from ruby!"
# Print working directory, for demonstration purposes!
[group: "demo-recipes"]
pwd:
echo {{invocation_directory()}}
[group: "testing"]
test-bash-completions:
rm -rf tmp
mkdir -p tmp/bin
cargo build
cp target/debug/just tmp/bin
./tmp/bin/just --completions bash > tmp/just.bash
echo 'mod foo' > tmp/justfile
echo 'bar:' > tmp/foo.just
cd tmp && PATH="`realpath bin`:$PATH" bash --init-file just.bash
# Local Variables:
# mode: makefile
# End:
# vim: set ft=make :