"Just" vs. Makefiles

After spending another 10 minutes trying to figure out more Makefile idiosyncrasies just to try and automate (and document) both oft and seldom issued commands, I recently found and decided to give the Just command-line runner a try.

The Just package took less than 10 minutes to understand what was necessary to change my complex Makefile to a far-simpler justfile.

TL;DR; -> Why has it taken me so long to find this! If you don't need to worry about dependencies, unreservedly recommended.

Sample `justfile`

Here is the automation file that I used to build a previous implementation of my site (specifically, with Hugo):

# Setup local variables
CONTENT    := justfile_directory() + "/content" 
 You can have local variables to represent common  strings within the justfile (I treat them like shell variables). Similarly, there are a set of just specific methods, here, I'm getting the directory containing the justfile itself.

DEPLOY     := justfile_directory() + "/deploy"
COMMIT_TAG := `date "+%Y-%m-%dT%H:%M:%S"`

# This list of available targets # 
 A comment above a target will be the contents of the respective "help" command (see sample execution below).

default: # 
 The default target will be executed when no target is specified on the invocation of just. In this case, we simply list the commands available in this justfile.

    @just --list

# Build local content *and* deploy to public github repo.
deploy: build push  # 
 To execute other targets, simply list them! In this case, a deploy action is actually composed of a build followed by a push target.


# Build local content to public directory
build:
    @echo "Generating site..." # 
 The @ symbol doesn't display the text of the command executed.

    @cd {{CONTENT}} && hugo --quiet --minify --gc --cleanDestinationDir -d {{DEPLOY}}  # 
 Good example of running a command in another directory (there's no state carried from one command-line to the next).

    @cp {{CONTENT}}/CNAME {{DEPLOY}}

# Commit current version of local public directory and push to github
push:
    #!/usr/bin/env fish  # 
 Commands can be run using any interpreter! Here, I'm using fish to take advantage of redirecting both stdout and stderr to the same file.

    echo "Committing and pushing to github..."
    echo "{{COMMIT_TAG}}"                            > git.log
    cd {{DEPLOY}} && git add --all .                >> git.log 2>&1
    cd {{DEPLOY}} && git commit -m "{{COMMIT_TAG}}" >> git.log 2>&1
    cd {{DEPLOY}} && git push -u origin main        >> git.log 2>&1

# Run a local server (including drafts)
server:
    @cd {{CONTENT}} && hugo server --buildDrafts --disableFastRender # 
 Commands don't have to "end", here, the hugo server will continue to run until a CTRL-C.

$ just
Available recipes:
    build   # Build local content to public directory.
    default # This list of available targets
    deploy  # Build local content *and* deploy to public github repo.
    push    # Commit current version of local public directory and push to github.
    server  # Run a local server (including drafts).
$ just build
  ...

...no more PHONY's!

Now, obviously, since you're able to see the footer, you can tell I don't use Hugo anymore...thus, the need to do all the rigamorale above has gone away but justfiles continue to be a core component of every one of my projects.

To see the current justfile used for this site, follow the github link in the upper-right corner of this page and look for justfile in the root directory.

"Just" vs. Makefiles

Sample justfile

Sample `justfile`