Release 0.1.0.0

Author: TravisCardwell

.gitignore

@@ -4,6 +4,12 @@
 # stack
 .stack-work
 *.yaml.lock
+stack-nix*
+
+# cabal
+cabal.project.local
+cabal.project.local~
+/dist-newstyle/
 
 # vi
 .*.swp

.travis.yml

@@ -19,13 +19,17 @@ matrix:
   - ghc: 8.2.2
   - ghc: 8.4.4
   - ghc: 8.6.5
+  #- ghc: 8.8.3
+  #- ghc: 8.10.1
 
   # Stack
   - ghc: 8.2.2
     env: STACK_YAML="$TRAVIS_BUILD_DIR/stack-8.2.2.yaml"
   - ghc: 8.4.4
     env: STACK_YAML="$TRAVIS_BUILD_DIR/stack-8.4.4.yaml"
   - ghc: 8.6.5
+    env: STACK_YAML="$TRAVIS_BUILD_DIR/stack-8.6.5.yaml"
+  - ghc: 8.8.3
     env: STACK_YAML="$TRAVIS_BUILD_DIR/stack.yaml"
 
 install:

CHANGELOG.md

@@ -24,6 +24,20 @@ following conventions:
 
 [KaC]: <https://keepachangelog.com/en/1.0.0/>
 
+## 0.1.0.0 (2020-07-25)
+
+### Breaking
+
+* Configure sections and queues in a single YAML file
+
+### Non-Breaking
+
+* Add a template option
+* Add an output option
+* Refactor `Makefile`, add `STACK_NIX_PATH` support
+* Add `test-all` command to `Makefile`
+* Add Nix configuration
+
 ## 0.0.1.0 (2020-01-22)
 
 ### Breaking

Makefile

@@ -20,6 +20,13 @@ SHELL := bash
 MAKEFLAGS += --no-builtin-rules
 MAKEFLAGS += --warn-undefined-variables
 
+.DEFAULT_GOAL := build
+
+NIX_PATH_ARGS :=
+ifneq ($(origin STACK_NIX_PATH), undefined)
+  NIX_PATH_ARGS := "--nix-path=$(STACK_NIX_PATH)"
+endif
+
 RESOLVER_ARGS :=
 ifneq ($(origin RESOLVER), undefined)
   RESOLVER_ARGS := "--resolver" "$(RESOLVER)"
@@ -48,75 +55,59 @@ endef
 ##############################################################################
 # Rules
 
-_default: build
-.PHONY: _default
-
-build:
+build: # build package *
 > @command -v hr >/dev/null 2>&1 && hr -t || true
-> @stack build $(RESOLVER_ARGS) $(STACK_YAML_ARGS)
+> @stack build $(RESOLVER_ARGS) $(STACK_YAML_ARGS) $(NIX_PATH_ARGS)
 .PHONY: build
 
-clean:
+clean: # clean package
 > @stack clean
 .PHONY: clean
 
-clean-all: clean
+clean-all: clean # clean package and remove artifacts
 > @rm -rf .stack-work
 > @rm -rf build
 > @rm -f *.yaml.lock
 .PHONY: clean-all
 
-grep:
+grep: # grep all non-hidden files for expression E
 > $(eval E:= "")
 > @test -n "$(E)" || $(call die,"usage: make grep E=expression")
 > @$(call all_files) | xargs grep -Hn '$(E)' || true
 .PHONY: grep
 
-help:
-> @echo "make build       build package (default) *"
-> @echo "make clean       clean package"
-> @echo "make clean-all   clean package and remove artifacts"
-> @echo "make grep        grep all non-hidden files for expression E"
-> @echo "make help        show this help"
-> @echo "make hlint       run hlint on all Haskell source"
-> @echo "make hsgrep      grep all Haskell source for expression E"
-> @echo "make hsrecent    show N most recently modified Haskell files"
-> @echo "make hssloc      count lines of Haskell source"
-> @echo "make man         build man page"
-> @echo "make recent      show N most recently modified files"
-> @echo "make repl        enter a REPL *"
-> @echo "make source-git  create source tarball of git TREE"
-> @echo "make source-tar  create source tarball using tar"
-> @echo "make test        run tests, optionally for pattern P *"
-> @echo "make todo        search for TODO items"
-> @echo "make version     show current version"
+help: # show this help
+> @grep '^[a-zA-Z0-9_-]\+:[^#]*# ' $(MAKEFILE_LIST) \
+>   | sed 's/^\([^:]\+\):[^#]*# \(.*\)/make \1\t\2/' \
+>   | column -t -s $$'\t'
 > @echo
+> @echo "* Use STACK_NIX_PATH to specify a Nix path."
 > @echo "* Use RESOLVER to specify a resolver."
 > @echo "* Use CONFIG to specify a Stack configuration file."
 .PHONY: help
 
-hlint:
+hlint: # run hlint on all Haskell source
 > @$(call hs_files) | xargs hlint
 .PHONY: hlint
 
-hsgrep:
+hsgrep: # grep all Haskell source for expression E
 > $(eval E := "")
 > @test -n "$(E)" || $(call die,"usage: make hsgrep E=expression")
 > @$(call hs_files) | xargs grep -Hn '$(E)' || true
 .PHONY: hsgrep
 
-hsrecent:
+hsrecent: # show N most recently modified Haskell files
 > $(eval N := "10")
 > @find . -not -path '*/\.*' -type f -name '*.hs' -printf '%T+ %p\n' \
 >   | sort --reverse \
 >   | head -n $(N)
 .PHONY: hsrecent
 
-hssloc:
+hssloc: # count lines of Haskell source
 > @$(call hs_files) | xargs wc -l | tail -n 1 | sed 's/^ *\([0-9]*\).*$$/\1/'
 .PHONY: hssloc
 
-man:
+man: # build man page
 > $(eval VERSION := $(shell \
     grep '^version:' $(CABAL_FILE) | sed 's/^version: *//'))
 > $(eval DATE := $(shell date --rfc-3339=date))
@@ -127,18 +118,18 @@ man:
 >   doc/$(BINARY).1.md
 .PHONY: man
 
-recent:
+recent: # show N most recently modified files
 > $(eval N := "10")
 > @find . -not -path '*/\.*' -type f -printf '%T+ %p\n' \
 >   | sort --reverse \
 >   | head -n $(N)
 .PHONY: recent
 
-repl:
-> @stack exec ghci $(RESOLVER_ARGS) $(STACK_YAML_ARGS)
+repl: # enter a REPL *
+> @stack exec ghci $(RESOLVER_ARGS) $(STACK_YAML_ARGS) $(NIX_PATH_ARGS)
 .PHONY: repl
 
-source-git:
+source-git: # create source tarball of git TREE
 > $(eval TREE := "HEAD")
 > $(eval BRANCH := $(shell git rev-parse --abbrev-ref $(TREE)))
 > @test "${BRANCH}" = "master" || echo "WARNING: Not in master branch!" >&2
@@ -150,7 +141,7 @@ source-git:
 >   > build/$(PROJECT)-$(VERSION).tar.xz
 .PHONY: source-git
 
-source-tar:
+source-tar: # create source tarball using tar
 > $(eval VERSION := $(shell \
     grep '^version:' $(CABAL_FILE) | sed 's/^version: *//'))
 > @mkdir -p build
@@ -164,16 +155,51 @@ source-tar:
 > @rm -f build/.gitignore
 .PHONY: source-tar
 
-test:
+test: # run tests, optionally for pattern P *
 > $(eval P := "")
 > @command -v hr >/dev/null 2>&1 && hr -t || true
 > @test -z "$(P)" \
->   && stack test $(RESOLVER_ARGS) $(STACK_YAML_ARGS) \
->   || stack test $(RESOLVER_ARGS) $(STACK_YAML_ARGS) \
+>   && stack test $(RESOLVER_ARGS) $(STACK_YAML_ARGS) $(NIX_PATH_ARGS) \
+>   || stack test $(RESOLVER_ARGS) $(STACK_YAML_ARGS) $(NIX_PATH_ARGS) \
 >       --test-arguments '--pattern $(P)'
 .PHONY: test
 
-todo:
+test-all: # run tests for all versions
+> $(eval CONFIG := $(shell \
+    test -f stack-nix-8.2.2.yaml \
+    && echo stack-nix-8.2.2.yaml \
+    || echo stack-8.2.2.yaml))
+> @command -v hr >/dev/null 2>&1 && hr $(CONFIG) || true
+> @make test CONFIG=$(CONFIG)
+> $(eval CONFIG := $(shell \
+    test -f stack-nix-8.4.4.yaml \
+    && echo stack-nix-8.4.4.yaml \
+    || echo stack-8.4.4.yaml))
+> @command -v hr >/dev/null 2>&1 && hr $(CONFIG) || true
+> @make test CONFIG=$(CONFIG)
+> $(eval CONFIG := $(shell \
+    test -f stack-nix-8.6.5.yaml \
+    && echo stack-nix-8.6.5.yaml \
+    || echo stack-8.6.5.yaml))
+> @command -v hr >/dev/null 2>&1 && hr $(CONFIG) || true
+> @make test CONFIG=$(CONFIG)
+> $(eval CONFIG := $(shell \
+    test -f stack-nix.yaml \
+    && echo stack-nix.yaml \
+    || echo stack.yaml))
+> @command -v hr >/dev/null 2>&1 && hr $(CONFIG) || true
+> @make test CONFIG=$(CONFIG)
+> $(eval STACK_NIX_PATH := $(shell \
+    test -f stack-nix-nightly.path \
+    && cat stack-nix-nightly.path \
+    || true))
+> @command -v hr >/dev/null 2>&1 && hr nightly || true
+> @test -f stack-nix-nightly.path \
+>   && make test RESOLVER=nightly STACK_NIX_PATH="$(STACK_NIX_PATH)" \
+>   || make test RESOLVER=nightly
+.PHONY: test-all
+
+todo: # search for TODO items
 > @find . -type f \
 >   -not -path '*/\.*' \
 >   -not -path './build/*' \
@@ -182,6 +208,6 @@ todo:
 >   | xargs grep -Hn TODO || true
 .PHONY: todo
 
-version:
+version: # show current version
 > @grep '^version:' $(CABAL_FILE) | sed 's/^version: */$(PROJECT) /'
 .PHONY: version

default.nix

@@ -0,0 +1,2 @@
+{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc883" }:
+nixpkgs.pkgs.haskell.packages.${compiler}.callPackage ./queue-sheet.nix { }

doc/queue-sheet.1.md

@@ -25,57 +25,64 @@ used to track progress through the queues when offline.
 \--version
 :   show version and exit
 
+-t, \--template *TEMPLATE.tex*
+:   template file (default: template.tex)
+
+-o, \--output *QUEUES.pdf*
+:   output file
+
 # ARGUMENTS
 
 *QUEUES.yaml*
 :   YAML file specifying queue information
 
 # FILES
 
-## `sections.yaml`
+## `QUEUES.yaml`
 
-This file defines the names and order of sections.  It is a list of section
-names (strings).
+This file is an object with two properties.
 
-## `QUEUES.yaml`
+The *sections* property is a list of section names (strings).  Note that the
+order determines the order in the output.
 
-This file defines the queues.  It is a list of queue objects, which have the
-following properties:
+The *queues* property is a list of queue objects with the following
+properties:
 
-name
+*name*
 :   name of the queue (string, required)
 
-section
+*section*
 :   name of the section (string, required)
 
-split
+*split*
 :   *true* to display items on separate lines (boolean, default *false*)
 
-tags
+*tags*
 :   list of tags (list of string, optional)
 
-date
+*date*
 :   date of last update (string, optional)
 
-prev
+*prev*
 :   previous (complete) item (string, optional)
 
-next
+*next*
 :   list of next items (list of string, optional)
 
 If both *prev* and *next* are specified, then *prev* is ignored.
 
 The following tags are supported:
 
-complete
+*complete*
 :   no new items will be added to the queue
 
-partial
+*partial*
 :   not all items of the source queue are added to the queue
 
-## `template.tex`
+## Template
 
-This file is the LaTeX template used to build the PDF, with XeTeX.
+A LaTeX template is used to build the PDF, using XeTeX.  Unless specified
+otherwise, `template.tex` is used.
 
 It is a Jinja2-style template using the following syntax:
 
@@ -90,44 +97,44 @@ Comments
 
 The context contains a single value:
 
-sections
+*sections*
 :   list of sections
 
 A section is an object with the following properties:
 
-name
+*name*
 :   name of the section (string)
 
-queues
+*queues*
 :   list of queues
 
 A queue is an object with the following properties:
 
-name
+*name*
 :   name of the queue (string)
 
-isSplit
+*isSplit*
 :   *true* to display items on separate lines (boolean)
 
-isPartial
+*isPartial*
 :   *true* if the partial tag is set (boolean)
 
-isComplete
+*isComplete*
 :   *true* if the complete tag is set (boolean)
 
-date
+*date*
 :   date or empty string if no date (string)
 
-prevItem
+*prevItem*
 :   previous item or empty string if not set (string)
 
-nextItems
+*nextItems*
 :   list of next items (list of strings)
 
 ## `QUEUES.pdf`
 
-The output is a file with the same base name as the queues file, but with a
-`.pdf` extension.
+Unless specified otherwise, the built PDF is output to a file with the same
+base name as the queues file but with a `.pdf` extension.
 
 # EXIT CODES