1
1
mirror of https://github.com/anoma/juvix.git synced 2024-12-12 14:28:08 +03:00
juvix/justfile
Jan Mas Rovira 3609b213f6
Use ormolu from stackage in the CI (#2900)
1. Adds the command `just format check`, which checks that all Haskell
files are formatted.
2. In CI, we use install ormolu from stackage and run it. This will
facilitate consistency between CI and local setups.

---------

Co-authored-by: Paul Cadman <git@paulcadman.dev>
2024-07-19 09:38:39 +01:00

162 lines
4.6 KiB
Makefile

# set to non-empty string to disable parallel builds and tests
#
# e.g:
# just disableParallel=yes test
disableParallel := ''
# set to non-empty string to disable optimized build
#
# e.g:
# just disableOptimized=yes install
disableOptimized := ''
# set to non-empty string to enable command debugging
enableDebug := ''
# set to non-empty string to enable pedantic mode
pedantic := ''
# set to number of parallel jobs
numParallelJobs := ''
# the command used to run stack
stack := "stack"
# the command used to run ormolu
ormolu := "ormolu"
# The CC argument to the runtime Makefile
runtimeCcArg := ''
# The LIBTOOL argument to the runtime Makefile
runtimeLibtoolArg := ''
# The flags used in the runtime make commands
runtimeCcFlag := if runtimeCcArg == '' { '' } else { "CC=" + runtimeCcArg }
runtimeLibtoolFlag := if runtimeLibtoolArg == '' { '' } else { "LIBTOOL=" + runtimeLibtoolArg }
runtimeArgs := trim(runtimeCcFlag + ' ' + runtimeLibtoolFlag)
# flags used in the stack command
stackOptFlag := (if disableOptimized == '' { '' } else { '--fast' }) + ' ' + (if pedantic == '' { '' } else { '--pedantic' })
# The ghc `-j` flag defaults to number of cpus when no argument is passed
stackGhcParallelFlag := if disableParallel == '' { "--ghc-options=-j" + numParallelJobs } else { '' }
# The stack `-j` options requires an argument
stackParallelFlagJobs := if numParallelJobs == '' { num_cpus() } else { numParallelJobs }
stackParallelFlag := if disableParallel == '' { '-j' + stackParallelFlagJobs } else { '' }
stackArgs := stackOptFlag + ' ' + stackParallelFlag + ' ' + stackGhcParallelFlag
# flags used in the stack test command
testArgs := "--hide-successes"
rtsFlag := if disableParallel == '' { '+RTS -N' + numParallelJobs + ' -RTS' } else { '' }
# flag used to enable tracing of bash commands
bashDebugArg := if enableDebug == '' { '' } else { 'x' }
[private]
default:
@just --list
@_ormoluCmd filesCmd mode:
{{ trim(filesCmd) }} \
| xargs -r {{ ormolu }} --mode {{ mode }}
# Formats all Haskell files in the project. `format changed` formats only changed files. `format FILES` formats individual files.
format *opts:
#!/usr/bin/env bash
set -euo{{ bashDebugArg }} pipefail
if [ ! -e "juvix.cabal" ]; then
echo "Error: juvix.cabal does not exist. Please, run 'just install' or 'stack setup' first"
exit 1
fi
opts='{{ trim(opts) }}'
case $opts in
"")
just _ormoluCmd "git ls-files '*.hs'" inplace
;;
changed)
just _ormoluCmd \
"(git --no-pager diff --name-only --diff-filter=AM && git --no-pager diff --cached --name-only --diff-filter=AM) | grep '\\.hs\$'" \
inplace
;;
check)
just _ormoluCmd "git ls-files '*.hs'" check
;;
*)
just _ormoluCmd "echo {{ opts }}"
;;
esac
# Run the tests in the project. Use the filter arg to set a Tasty pattern.
[no-exit-message]
test *filter:
#!/usr/bin/env bash
set -euo{{ bashDebugArg }} pipefail
filter='{{ trim(filter) }}'
if [ -n "$filter" ]; then
filter="-p \"$filter\""
fi
set -x
{{ stack }} test {{ stackArgs }} --ta "{{ testArgs }} {{ rtsFlag }} $filter"
# Run a juvix command and profile it
run-profile +cmd:
cabal run --enable-profiling juvix -- {{ cmd }} +RTS -p
# Build the juvix runtime
_buildRuntime:
cd runtime && make {{ runtimeArgs }}
# Build the project. `build runtime` builds only the runtime.
[no-exit-message]
build *opts:
#!/usr/bin/env bash
set -euo{{ bashDebugArg }} pipefail
opts='{{ trim(opts) }}'
case $opts in
runtime)
just runtimeArgs="{{ runtimeArgs }}" _buildRuntime
;;
*)
just runtimeArgs="{{ runtimeArgs }}" _buildRuntime
set -x
{{ stack }} build {{ stackArgs }}
;;
esac
# Install juvix
[no-exit-message]
install: _buildRuntime
{{ stack }} install {{ stackArgs }}
# Clean all .juvix-build directories in the project
_cleanJuvixBuild:
@find . -type d -name '.juvix-build' | xargs rm -rf
# Clean the juvix runtime build directory
_cleanRuntime:
@cd runtime && make clean
# Clean the project. `clean runtime` cleans only the runtime. `clean juvix-build` cleans only juvix-build dirs.
clean *opts:
#!/usr/bin/env bash
set -euo{{ bashDebugArg }} pipefail
opts='{{ trim(opts) }}'
case $opts in
runtime)
just _cleanRuntime
;;
juvix-build)
just _cleanJuvixBuild
;;
*)
just _cleanRuntime
just _cleanJuvixBuild
{{ stack }} clean --full
;;
esac