Merge pull request #673 from chrisallenlane/win-compat

fix: Windows compatibility

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: gomod
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: github.com/alecthomas/chroma
+    versions:
+    - 0.9.1

.github/workflows/build.yml

@@ -0,0 +1,57 @@
+name: Go
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  # TODO: is it possible to DRY out these jobs? Aside from `runs-on`, they are
+  # identical.
+  build-linux:
+    runs-on: [ ubuntu-latest ] 
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.16
+
+    - name: Set up Revive (linter)
+      run: go get -u github.com/boyter/scc github.com/mgechev/revive
+      env:
+          GO111MODULE: off
+
+
+    - name: Build
+      run: make build
+
+    - name: Test
+      run: make test
+
+  build-osx:
+    runs-on: [ macos-latest ] 
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.16
+
+    - name: Set up Revive (linter)
+      run: go get -u github.com/boyter/scc github.com/mgechev/revive
+      env:
+          GO111MODULE: off
+
+    - name: Build
+      run: make build
+
+    - name: Test
+      run: make test
+
+    # TODO: windows

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,36 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [ master ]
+
+  pull_request:
+    branches: [ master ]
+
+  schedule:
+    - cron: '45 23 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/homebrew.yml

@@ -0,0 +1,17 @@
+name: homebrew
+
+on:
+  push:
+    tags: '*'
+
+jobs:
+  homebrew:
+    name: Bump Homebrew formula
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mislav/bump-homebrew-formula-action@v1
+        with:
+          # A PR will be sent to github.com/Homebrew/homebrew-core to update this formula:
+          formula-name: cheat
+        env:
+          COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}

.travis.yml

@@ -1,15 +0,0 @@
-language: go
-
-go:
-  - 1.13.x
-
-os:
-  - linux
-  - osx
-
-env:
-  - GO111MODULE=on
-
-install: true
-
-script: make ci

CONTRIBUTING.md

@@ -35,6 +35,9 @@ Are you unable to do the above, but still want to contribute? You can help
 `cheat` simply by telling others about it. Share it with friends and coworkers
 that might benefit from using it.
 
+#### Pull Requests ####
+Please open all pull-requests against the `develop` branch.
+
 
 [cheat]: https://github.com/cheat/cheat
 [cheatsheets]: https://github.com/cheat/cheatsheets

Dockerfile

@@ -0,0 +1,8 @@
+# NB: this image isn't used anywhere in the build pipeline. It exists to
+# conveniently facilitate ad-hoc experimentation in a sandboxed environment
+# during development.
+FROM golang:1.15-alpine
+
+RUN apk add git less make
+
+WORKDIR /app

Makefile

@@ -7,17 +7,22 @@ dist_dir := ./dist
 CAT    := cat
 COLUMN := column
 CTAGS  := ctags
+DOCKER := docker
 GO     := go
 GREP   := grep
 GZIP   := gzip --best
 LINT   := revive
+MAN    := man
 MKDIR  := mkdir -p
+PANDOC := pandoc
 RM     := rm
 SCC    := scc
 SED    := sed
 SORT   := sort
 ZIP    := zip -m
 
+docker_image := cheat-devel:latest
+
 # build flags
 BUILD_FLAGS  := -ldflags="-s -w" -mod vendor -trimpath
 GOBIN        :=
@@ -26,30 +31,33 @@ TMPDIR       := /tmp
 # release binaries
 releases :=                        \
 	$(dist_dir)/cheat-darwin-amd64 \
+	$(dist_dir)/cheat-linux-386    \
 	$(dist_dir)/cheat-linux-amd64  \
 	$(dist_dir)/cheat-linux-arm5   \
 	$(dist_dir)/cheat-linux-arm6   \
 	$(dist_dir)/cheat-linux-arm7   \
+	$(dist_dir)/cheat-linux-arm64  \
 	$(dist_dir)/cheat-windows-amd64.exe
 
-## build: builds an executable for your architecture
+## build: build an executable for your architecture
 .PHONY: build
-build: $(dist_dir) clean generate
+build: $(dist_dir) clean fmt lint vet vendor generate man
 	$(GO) build $(BUILD_FLAGS) -o $(dist_dir)/cheat $(cmd_dir)
 
-## build-release: builds release executables
+## build-release: build release executables
 .PHONY: build-release
 build-release: $(releases)
 
-## ci: builds a "release" executable for the current architecture (used in ci)
-.PHONY: ci
-ci: | setup prepare build
-
 # cheat-darwin-amd64
 $(dist_dir)/cheat-darwin-amd64: prepare
 	GOARCH=amd64 GOOS=darwin \
 	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
 
+# cheat-linux-386
+$(dist_dir)/cheat-linux-386: prepare
+	GOARCH=386 GOOS=linux \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
 # cheat-linux-amd64
 $(dist_dir)/cheat-linux-amd64: prepare
 	GOARCH=amd64 GOOS=linux \
@@ -69,11 +77,16 @@ $(dist_dir)/cheat-linux-arm6: prepare
 $(dist_dir)/cheat-linux-arm7: prepare
 	GOARCH=arm GOOS=linux GOARM=7 \
 	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+	
+# cheat-linux-arm64
+$(dist_dir)/cheat-linux-arm64: prepare
+	GOARCH=arm64 GOOS=linux \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
 
 # cheat-windows-amd64
 $(dist_dir)/cheat-windows-amd64.exe: prepare
 	GOARCH=amd64 GOOS=windows \
-	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(ZIP) $@.zip $@
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(ZIP) $@.zip $@ -j
 
 # ./dist
 $(dist_dir):
@@ -83,75 +96,101 @@ $(dist_dir):
 generate:
 	$(GO) generate $(cmd_dir)
 
-## install: builds and installs cheat on your PATH
+## install: build and install cheat on your PATH
 .PHONY: install
-install:
+install: build
 	$(GO) install $(BUILD_FLAGS) $(GOBIN) $(cmd_dir) 
 
-## clean: removes compiled executables
+## clean: remove compiled executables
 .PHONY: clean
 clean: $(dist_dir)
 	$(RM) -f $(dist_dir)/*
 
-## distclean: removes the tags file
+## distclean: remove the tags file
 .PHONY: distclean
 distclean:
 	$(RM) -f tags
+	@$(DOCKER) image rm -f $(docker_image)
 
-## setup: installs revive (linter) and scc (sloc tool)
+## setup: install revive (linter) and scc (sloc tool)
 .PHONY: setup
 setup:
 	GO111MODULE=off $(GO) get -u github.com/boyter/scc github.com/mgechev/revive
 
-## sloc: counts "semantic lines of code"
+## sloc: count "semantic lines of code"
 .PHONY: sloc
 sloc:
 	$(SCC) --exclude-dir=vendor
 
-## tags: builds a tags file
+## tags: build a tags file
 .PHONY: tags
 tags:
 	$(CTAGS) -R --exclude=vendor --languages=go
 
-## vendor: downloads, tidies, and verifies dependencies
+## man: build a man page
+# NB: pandoc may not be installed, so we're ignoring this error on failure
+.PHONY: man
+man:
+	-$(PANDOC) -s -t man doc/cheat.1.md -o doc/cheat.1
+
+## vendor: download, tidy, and verify dependencies
 .PHONY: vendor
 vendor:
 	$(GO) mod vendor && $(GO) mod tidy && $(GO) mod verify
 
-## fmt: runs go fmt
+## vendor-update: update vendored dependencies
+vendor-update:
+	$(GO) get -t -u ./... && $(GO) mod vendor
+
+## fmt: run go fmt
 .PHONY: fmt
 fmt:
 	$(GO) fmt ./...
 
-## lint: lints go source files
+## lint: lint go source files
 .PHONY: lint
 lint: vendor
 	$(LINT) -exclude vendor/... ./...
 
-## vet: vets go source files
+## vet: vet go source files
 .PHONY: vet
 vet:
 	$(GO) vet ./...
 
-## test: runs unit-tests
+## test: run unit-tests
 .PHONY: test
 test: 
 	$(GO) test ./...
 
-## coverage: generates a test coverage report
+## coverage: generate a test coverage report
 .PHONY: coverage
 coverage:
 	$(GO) test ./... -coverprofile=$(TMPDIR)/cheat-coverage.out && \
 	$(GO) tool cover -html=$(TMPDIR)/cheat-coverage.out
 
-## check: formats, lints, vets, vendors, and run unit-tests
+## check: format, lint, vet, vendor, and run unit-tests
 .PHONY: check
 check: | vendor fmt lint vet test
 
 .PHONY: prepare
 prepare: | $(dist_dir) clean generate vendor fmt lint vet test
 
-## help: displays this help text
+## docker-setup: create a docker image for use during development
+.PHONY: docker-setup
+docker-setup:
+	$(DOCKER) build  -t $(docker_image) -f Dockerfile .
+
+## docker-run: shell into the development docker container
+.PHONY: docker-run
+docker-run:
+	$(DOCKER) run -v `pwd`:/app -ti $(docker_image) sh
+
+## docker-sh: shell into the docker development container
+.PHONY: docker-sh
+docker-sh:
+	$(DOCKER) run -v $(shell pwd):/app -ti $(docker_image) /bin/ash
+
+## help: display this help text
 .PHONY: help
 help:
 	@$(CAT) $(makefile) | \

README.md

@@ -1,8 +1,9 @@
+![Workflow status](https://github.com/cheat/cheat/actions/workflows/build.yml/badge.svg)
+
+
 cheat
 =====
 
-[![Build Status](https://travis-ci.com/cheat/cheat.svg?branch=master)](https://travis-ci.com/cheat/cheat)
-
 `cheat` allows you to create and view interactive cheatsheets on the
 command-line. It was designed to help remind \*nix system administrators of
 options for commands that they use frequently, but not frequently enough to
@@ -47,15 +48,17 @@ Installing
 `cheat` has no dependencies. To install it, download the executable from the
 [releases][] page and place it on your `PATH`.
 
+Alternatively, if you have [go][] installed, you may install `cheat` using `go
+get`:
+
+```sh
+go get -u github.com/cheat/cheat/cmd/cheat
+```
 
 Configuring
 -----------
 ### conf.yml ###
-`cheat` is configured by a YAML file that can be generated with `cheat --init`:
-
-```sh
-mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml
-```
+`cheat` is configured by a YAML file that will be auto-generated on first run.
 
 By default, the config file is assumed to exist on an XDG-compliant
 configuration path like `~/.config/cheat/conf.yml`. If you would like to store
@@ -89,13 +92,29 @@ const squares = [1, 2, 3, 4].map(x => x * x);
 ```
 
 The `cheat` executable includes no cheatsheets, but [community-sourced
-cheatsheets are available][cheatsheets].
+cheatsheets are available][cheatsheets]. You will be asked if you would like to
+install the community-sourced cheatsheets the first time you run `cheat`.
 
+### Script ###
+You can manage the cheatsheets via a script `cheatsheets`.
+
+#### Download and install ####
+```sh
+mkdir -p ~/.local/bin
+wget -O ~/.local/bin/cheatsheets https://raw.githubusercontent.com/cheat/cheat/master/scripts/git/cheatsheets
+chmod +x ~/.local/bin/cheatsheets
+```
+
+#### Pull changes ####
+To pull the community and personal cheatsheets call `cheatsheets pull`
+
+#### Push changes ####
+To push your personal cheatsheets call `cheatsheets push`
 
 Cheatpaths
 ----------
 Cheatsheets are stored on "cheatpaths", which are directories that contain
-cheetsheets. Cheatpaths are specified in the `conf.yml` file.
+cheatsheets. Cheatpaths are specified in the `conf.yml` file.
 
 It can be useful to configure `cheat` against multiple cheatpaths. A common
 pattern is to store cheatsheets from multiple repositories on individual
@@ -193,19 +212,19 @@ cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
 
 Advanced Usage
 --------------
-Shell autocompletion is currently available for the `bash` and `fish` shells.
-Copy the relevant [completion script][completion-scripts] into the appropriate
-directory on your filesystem to enable autocompletion. (This directory will
-vary depending on operating system and shell specifics.)
+Shell autocompletion is currently available for `bash`, `fish`, and `zsh`. Copy
+the relevant [completion script][completions] into the appropriate directory on
+your filesystem to enable autocompletion. (This directory will vary depending
+on operating system and shell specifics.)
 
 Additionally, `cheat` supports enhanced autocompletion via integration with
-[fzf][]. (This feature is currently available on bash only.) To enable `fzf`
-integration:
+[fzf][]. To enable `fzf` integration:
 
 1. Ensure that `fzf` is available on your `$PATH`
 2. Set an envvar: `export CHEAT_USE_FZF=true`
 
 [Releases]:    https://github.com/cheat/cheat/releases
-[bash]:        https://github.com/cheat/cheat/blob/master/scripts/fzf.bash
 [cheatsheets]: https://github.com/cheat/cheatsheets
+[completions]: https://github.com/cheat/cheat/tree/master/scripts
 [fzf]:         https://github.com/junegunn/fzf
+[go]:          https://golang.org

build/embed.go

@@ -1,3 +1,4 @@
+//go:build ignore
 // +build ignore
 
 // This script embeds `docopt.txt and `conf.yml` into the binary during at
@@ -5,13 +6,11 @@
 
 package main
 
-
 import (
 	"fmt"
 	"io/ioutil"
 	"log"
 	"os"
-	"path"
 	"path/filepath"
 )
 
@@ -52,10 +51,10 @@ func main() {
 	for _, file := range files {
 
 		// delete the outfile
-		os.Remove(path.Join(root, file.Out))
+		os.Remove(filepath.Join(root, file.Out))
 
 		// read the static template
-		bytes, err := ioutil.ReadFile(path.Join(root, file.In))
+		bytes, err := ioutil.ReadFile(filepath.Join(root, file.In))
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -64,7 +63,7 @@ func main() {
 		data := template(file.Method, string(bytes))
 
 		// write the file to the specified outpath
-		spath := path.Join(root, file.Out)
+		spath := filepath.Join(root, file.Out)
 		err = ioutil.WriteFile(spath, []byte(data), 0644)
 		if err != nil {
 			log.Fatal(err)

cmd/cheat/cmd_directories.go

@@ -1,18 +1,20 @@
 package main
 
 import (
+	"bytes"
 	"fmt"
-	"os"
 	"text/tabwriter"
 
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/display"
 )
 
 // cmdDirectories lists the configured cheatpaths.
 func cmdDirectories(opts map[string]interface{}, conf config.Config) {
 
 	// initialize a tabwriter to produce cleanly columnized output
-	w := tabwriter.NewWriter(os.Stdout, 0, 0, 1, ' ', 0)
+	var out bytes.Buffer
+	w := tabwriter.NewWriter(&out, 0, 0, 1, ' ', 0)
 
 	// generate sorted, columnized output
 	for _, path := range conf.Cheatpaths {
@@ -25,4 +27,5 @@ func cmdDirectories(opts map[string]interface{}, conf config.Config) {
 
 	// write columnized output to stdout
 	w.Flush()
+	display.Write(out.String(), conf)
 }

cmd/cheat/cmd_edit.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
-	"path"
+	"path/filepath"
 	"strings"
 
 	"github.com/cheat/cheat/internal/cheatpath"
@@ -58,10 +58,10 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
 		}
 
 		// compute the new edit path
-		editpath = path.Join(writepath.Path, sheet.Title)
+		editpath = filepath.Join(writepath.Path, sheet.Title)
 
 		// create any necessary subdirectories
-		dirs := path.Dir(editpath)
+		dirs := filepath.Dir(editpath)
 		if dirs != "." {
 			if err := os.MkdirAll(dirs, 0755); err != nil {
 				fmt.Fprintf(os.Stderr, "failed to create directory: %s, %v\n", dirs, err)
@@ -87,10 +87,10 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
 		}
 
 		// compute the new edit path
-		editpath = path.Join(writepath.Path, cheatsheet)
+		editpath = filepath.Join(writepath.Path, cheatsheet)
 
 		// create any necessary subdirectories
-		dirs := path.Dir(editpath)
+		dirs := filepath.Dir(editpath)
 		if dirs != "." {
 			if err := os.MkdirAll(dirs, 0755); err != nil {
 				fmt.Fprintf(os.Stderr, "failed to create directory: %s, %v\n", dirs, err)
@@ -99,8 +99,15 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
 		}
 	}
 
+	// split `conf.Editor` into parts to separate the editor's executable from
+	// any arguments it may have been passed. If this is not done, the nearby
+	// call to `exec.Command` will fail.
+	parts := strings.Fields(conf.Editor)
+	editor := parts[0]
+	args := append(parts[1:], editpath)
+
 	// edit the cheatsheet
-	cmd := exec.Command(conf.Editor, editpath)
+	cmd := exec.Command(editor, args...)
 	cmd.Stdout = os.Stdout
 	cmd.Stdin = os.Stdin
 	cmd.Stderr = os.Stderr

cmd/cheat/cmd_init.go

@@ -2,9 +2,56 @@ package main
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"github.com/mitchellh/go-homedir"
+
+	"github.com/cheat/cheat/internal/config"
 )
 
 // cmdInit displays an example config file.
 func cmdInit() {
-	fmt.Println(configs())
+
+	// get the user's home directory
+	home, err := homedir.Dir()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to get user home directory: %v\n", err)
+		os.Exit(1)
+	}
+
+	// read the envvars into a map of strings
+	envvars := map[string]string{}
+	for _, e := range os.Environ() {
+		pair := strings.SplitN(e, "=", 2)
+		envvars[pair[0]] = pair[1]
+	}
+
+	// load the config template
+	configs := configs()
+
+	// identify the os-specifc paths at which configs may be located
+	confpaths, err := config.Paths(runtime.GOOS, home, envvars)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to read config paths: %v\n", err)
+		os.Exit(1)
+	}
+
+	// determine the appropriate paths for config data and (optional) community
+	// cheatsheets based on the user's platform
+	confpath := confpaths[0]
+	confdir := filepath.Dir(confpath)
+
+	// create paths for community and personal cheatsheets
+	community := filepath.Join(confdir, "cheatsheets", "community")
+	personal := filepath.Join(confdir, "cheatsheets", "personal")
+
+	// template the above paths into the default configs
+	configs = strings.Replace(configs, "COMMUNITY_PATH", community, -1)
+	configs = strings.Replace(configs, "PERSONAL_PATH", personal, -1)
+
+	// output the templated configs
+	fmt.Println(configs)
 }

cmd/cheat/cmd_list.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"bytes"
 	"fmt"
 	"os"
 	"regexp"
@@ -9,6 +10,7 @@ import (
 	"text/tabwriter"
 
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/display"
 	"github.com/cheat/cheat/internal/sheet"
 	"github.com/cheat/cheat/internal/sheets"
 )
@@ -23,7 +25,7 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
 		os.Exit(1)
 	}
 
-	// filter cheatcheats by tag if --tag was provided
+	// filter cheatsheets by tag if --tag was provided
 	if opts["--tag"] != nil {
 		cheatsheets = sheets.Filter(
 			cheatsheets,
@@ -35,8 +37,8 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
 	// sheets with local sheets), here we simply want to create a slice
 	// containing all sheets.
 	flattened := []sheet.Sheet{}
-	for _, pathSheets := range cheatsheets {
-		for _, s := range pathSheets {
+	for _, pathsheets := range cheatsheets {
+		for _, s := range pathsheets {
 			flattened = append(flattened, s)
 		}
 	}
@@ -79,16 +81,19 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
 		flattened = filtered
 	}
 
-	// exit early if no cheatsheets are available
+	// return exit code 2 if no cheatsheets are available
 	if len(flattened) == 0 {
-		os.Exit(0)
+		os.Exit(2)
 	}
 
 	// initialize a tabwriter to produce cleanly columnized output
-	w := tabwriter.NewWriter(os.Stdout, 0, 0, 1, ' ', 0)
+	var out bytes.Buffer
+	w := tabwriter.NewWriter(&out, 0, 0, 1, ' ', 0)
+
+	// write a header row
+	fmt.Fprintln(w, "title:\tfile:\ttags:")
 
 	// generate sorted, columnized output
-	fmt.Fprintln(w, "title:\tfile:\ttags:")
 	for _, sheet := range flattened {
 		fmt.Fprintln(w, fmt.Sprintf(
 			"%s\t%s\t%s",
@@ -100,4 +105,5 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
 
 	// write columnized output to stdout
 	w.Flush()
+	display.Write(out.String(), conf)
 }

cmd/cheat/cmd_remove.go

@@ -37,8 +37,8 @@ func cmdRemove(opts map[string]interface{}, conf config.Config) {
 	// fail early if the requested cheatsheet does not exist
 	sheet, ok := consolidated[cheatsheet]
 	if !ok {
-		fmt.Fprintln(os.Stderr, fmt.Sprintf("no cheatsheet found for '%s'.\n", cheatsheet))
-		os.Exit(1)
+		fmt.Fprintln(os.Stderr, fmt.Sprintf("No cheatsheet found for '%s'.\n", cheatsheet))
+		os.Exit(2)
 	}
 
 	// fail early if the sheet is read-only

cmd/cheat/cmd_search.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/display"
 	"github.com/cheat/cheat/internal/sheets"
 )
 
@@ -30,40 +31,65 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
 		)
 	}
 
-	// consolidate the cheatsheets found on all paths into a single map of
-	// `title` => `sheet` (ie, allow more local cheatsheets to override less
-	// local cheatsheets)
-	consolidated := sheets.Consolidate(cheatsheets)
+	// iterate over each cheatpath
+	out := ""
+	for _, pathcheats := range cheatsheets {
 
-	// sort the cheatsheets alphabetically, and search for matches
-	for _, sheet := range sheets.Sort(consolidated) {
+		// sort the cheatsheets alphabetically, and search for matches
+		for _, sheet := range sheets.Sort(pathcheats) {
 
-		// assume that we want to perform a case-insensitive search for <phrase>
-		pattern := "(?i)" + phrase
-
-		// unless --regex is provided, in which case we pass the regex unaltered
-		if opts["--regex"] == true {
-			pattern = phrase
-		}
-
-		// compile the regex
-		reg, err := regexp.Compile(pattern)
-		if err != nil {
-			fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to compile regexp: %s, %v", pattern, err))
-			os.Exit(1)
-		}
-
-		// search the sheet
-		matches := sheet.Search(reg, conf.Color(opts))
-
-		// display the results
-		if len(matches) > 0 {
-			fmt.Printf("%s:\n", sheet.Title)
-			for _, m := range matches {
-				fmt.Printf("  %d: %s\n", m.Line, m.Text)
+			// if <cheatsheet> was provided, constrain the search only to
+			// matching cheatsheets
+			if opts["<cheatsheet>"] != nil && sheet.Title != opts["<cheatsheet>"] {
+				continue
 			}
-			fmt.Print("\n")
+
+			// assume that we want to perform a case-insensitive search for <phrase>
+			pattern := "(?i)" + phrase
+
+			// unless --regex is provided, in which case we pass the regex unaltered
+			if opts["--regex"] == true {
+				pattern = phrase
+			}
+
+			// compile the regex
+			reg, err := regexp.Compile(pattern)
+			if err != nil {
+				fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to compile regexp: %s, %v", pattern, err))
+				os.Exit(1)
+			}
+
+			// `Search` will return text entries that match the search terms. We're
+			// using it here to overwrite the prior cheatsheet Text, filtering it to
+			// only what is relevant
+			sheet.Text = sheet.Search(reg)
+
+			// if the sheet did not match the search, ignore it and move on
+			if sheet.Text == "" {
+				continue
+			}
+
+			// if colorization was requested, apply it here
+			if conf.Color(opts) {
+				sheet.Colorize(conf)
+			}
+
+			// display the cheatsheet title and path
+			out += fmt.Sprintf("%s %s\n",
+				display.Underline(sheet.Title),
+				display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf),
+			)
+
+			// indent each line of content
+			out += display.Indent(sheet.Text) + "\n"
 		}
 	}
 
+	// trim superfluous newlines
+	out = strings.TrimSpace(out)
+
+	// display the output
+	// NB: resist the temptation to call `display.Display` multiple times in
+	// the loop above. That will not play nicely with the paginator.
+	display.Write(out, conf)
 }

cmd/cheat/cmd_tags.go

@@ -5,6 +5,7 @@ import (
 	"os"
 
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/display"
 	"github.com/cheat/cheat/internal/sheets"
 )
 
@@ -18,8 +19,12 @@ func cmdTags(opts map[string]interface{}, conf config.Config) {
 		os.Exit(1)
 	}
 
-	// write sheet tags to stdout
+	// assemble the output
+	out := ""
 	for _, tag := range sheets.Tags(cheatsheets) {
-		fmt.Println(tag)
+		out += fmt.Sprintln(tag)
 	}
+
+	// display the output
+	display.Write(out, conf)
 }

cmd/cheat/cmd_view.go

@@ -5,9 +5,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/alecthomas/chroma/quick"
-
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/display"
 	"github.com/cheat/cheat/internal/sheets"
 )
 
@@ -31,41 +30,53 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
 		)
 	}
 
-	// consolidate the cheatsheets found on all paths into a single map of
-	// `title` => `sheet` (ie, allow more local cheatsheets to override less
-	// local cheatsheets)
+	// if --all was passed, display cheatsheets from all cheatpaths
+	if opts["--all"].(bool) {
+		// iterate over the cheatpaths
+		out := ""
+		for _, cheatpath := range cheatsheets {
+
+			// if the cheatpath contains the specified cheatsheet, display it
+			if sheet, ok := cheatpath[cheatsheet]; ok {
+
+				// identify the matching cheatsheet
+				out += fmt.Sprintf("%s %s\n",
+					display.Underline(sheet.Title),
+					display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf),
+				)
+
+				// apply colorization if requested
+				if conf.Color(opts) {
+					sheet.Colorize(conf)
+				}
+
+				// display the cheatsheet
+				out += display.Indent(sheet.Text) + "\n"
+			}
+		}
+
+		// display and exit
+		display.Write(strings.TrimSuffix(out, "\n"), conf)
+		os.Exit(0)
+	}
+
+	// otherwise, consolidate the cheatsheets found on all paths into a single
+	// map of `title` => `sheet` (ie, allow more local cheatsheets to override
+	// less local cheatsheets)
 	consolidated := sheets.Consolidate(cheatsheets)
 
 	// fail early if the requested cheatsheet does not exist
 	sheet, ok := consolidated[cheatsheet]
 	if !ok {
 		fmt.Printf("No cheatsheet found for '%s'.\n", cheatsheet)
-		os.Exit(0)
+		os.Exit(2)
 	}
 
-	if !conf.Color(opts) {
-		fmt.Print(sheet.Text)
-		os.Exit(0)
+	// apply colorization if requested
+	if conf.Color(opts) {
+		sheet.Colorize(conf)
 	}
 
-	// otherwise, colorize the output
-	// if the syntax was not specified, default to bash
-	lex := sheet.Syntax
-	if lex == "" {
-		lex = "bash"
-	}
-
-	// apply syntax highlighting
-	err = quick.Highlight(
-		os.Stdout,
-		sheet.Text,
-		lex,
-		conf.Formatter,
-		conf.Style,
-	)
-
-	// if colorization somehow failed, output non-colorized text
-	if err != nil {
-		fmt.Print(sheet.Text)
-	}
+	// display the cheatsheet
+	display.Write(sheet.Text, conf)
 }

cmd/cheat/docopt.txt

@@ -2,18 +2,19 @@ Usage:
   cheat [options] [<cheatsheet>]
 
 Options:
-  --init                Write a default config file to stdout
-  -c --colorize         Colorize output
-  -d --directories      List cheatsheet directories
-  -e --edit=<sheet>     Edit <sheet>
-  -l --list             List cheatsheets
-  -p --path=<name>      Return only sheets found on path <name>
-  -r --regex            Treat search <phrase> as a regex
-  -s --search=<phrase>  Search cheatsheets for <phrase>
-  -t --tag=<tag>        Return only sheets matching <tag>
-  -T --tags             List all tags in use
-  -v --version          Print the version number
-  --rm=<sheet>          Remove (delete) <sheet>
+  --init                  Write a default config file to stdout
+  -a --all                Search among all cheatpaths
+  -c --colorize           Colorize output
+  -d --directories        List cheatsheet directories
+  -e --edit=<cheatsheet>  Edit <cheatsheet>
+  -l --list               List cheatsheets
+  -p --path=<name>        Return only sheets found on cheatpath <name>
+  -r --regex              Treat search <phrase> as a regex
+  -s --search=<phrase>    Search cheatsheets for <phrase>
+  -t --tag=<tag>          Return only sheets matching <tag>
+  -T --tags               List all tags in use
+  -v --version            Print the version number
+  --rm=<cheatsheet>       Remove (delete) <cheatsheet>
 
 Examples:
 

cmd/cheat/main.go

@@ -9,12 +9,14 @@ import (
 	"strings"
 
 	"github.com/docopt/docopt-go"
+	"github.com/mitchellh/go-homedir"
 
 	"github.com/cheat/cheat/internal/cheatpath"
 	"github.com/cheat/cheat/internal/config"
+	"github.com/cheat/cheat/internal/installer"
 )
 
-const version = "3.5.0"
+const version = "4.2.4"
 
 func main() {
 
@@ -32,15 +34,25 @@ func main() {
 		os.Exit(0)
 	}
 
+	// get the user's home directory
+	home, err := homedir.Dir()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "failed to get user home directory: %v\n", err)
+		os.Exit(1)
+	}
+
 	// read the envvars into a map of strings
 	envvars := map[string]string{}
 	for _, e := range os.Environ() {
 		pair := strings.SplitN(e, "=", 2)
+		if runtime.GOOS == "windows" {
+			pair[0] = strings.ToUpper(pair[0])
+		}
 		envvars[pair[0]] = pair[1]
 	}
 
-	// load the os-specifc paths at which the config file may be located
-	confpaths, err := config.Paths(runtime.GOOS, envvars)
+	// identify the os-specifc paths at which configs may be located
+	confpaths, err := config.Paths(runtime.GOOS, home, envvars)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "failed to load config: %v\n", err)
 		os.Exit(1)
@@ -49,22 +61,33 @@ func main() {
 	// search for the config file in the above paths
 	confpath, err := config.Path(confpaths)
 	if err != nil {
-
-		// the config file does not exist, so we'll try to create one
-		if err = config.Init(confpaths[0], configs()); err != nil {
-			fmt.Fprintf(
-				os.Stderr,
-				"failed to create config file: %s: %v\n",
-				confpaths[0],
-				err,
-			)
+		// prompt the user to create a config file
+		yes, err := installer.Prompt(
+			"A config file was not found. Would you like to create one now? [Y/n]",
+			true,
+		)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "failed to create config: %v\n", err)
 			os.Exit(1)
 		}
 
+		// exit early on a negative answer
+		if !yes {
+			os.Exit(0)
+		}
+
+		// choose a confpath
 		confpath = confpaths[0]
 
+		// run the installer
+		if err := installer.Run(configs(), confpath); err != nil {
+			fmt.Fprintf(os.Stderr, "failed to run installer: %v\n", err)
+			os.Exit(1)
+		}
+
+		// notify the user and exit
 		fmt.Printf("Created config file: %s\n", confpath)
-		fmt.Println("Please edit this file now to configure cheat.")
+		fmt.Println("Please read this file for advanced configuration information.")
 		os.Exit(0)
 	}
 
@@ -118,6 +141,9 @@ func main() {
 	case opts["<cheatsheet>"] != nil:
 		cmd = cmdView
 
+	case opts["--tag"] != nil && opts["--tag"].(string) != "":
+		cmd = cmdList
+
 	default:
 		fmt.Println(usage())
 		os.Exit(0)

cmd/cheat/str_config.go

@@ -9,19 +9,23 @@ import (
 func configs() string {
 	return strings.TrimSpace(`---
 # The editor to use with 'cheat -e <sheet>'. Defaults to $EDITOR or $VISUAL.
-editor: vim
+# editor: vim
 
 # Should 'cheat' always colorize output?
-colorize: true
+colorize: false
 
 # Which 'chroma' colorscheme should be applied to the output?
 # Options are available here:
 #   https://github.com/alecthomas/chroma/tree/master/styles
-style: monokai
+# style: monokai
 
 # Which 'chroma' "formatter" should be applied?
 # One of: "terminal", "terminal256", "terminal16m"
-formatter: terminal16m
+formatter: terminal
+
+# Through which pager should output be piped? (Unset this key for no pager.)
+pager: more
+# pager: less -FRX # <- recommended where available
 
 # The paths at which cheatsheets are available. Tags associated with a cheatpath
 # are automatically attached to all cheatsheets residing on that path.
@@ -41,33 +45,34 @@ cheatpaths:
   # thus be overridden by more local cheatsheets. That being the case, you
   # should probably list community cheatsheets first.
   #
-  # Note that the paths and tags listed below are just examples. You may freely
+  # Note that the paths and tags listed below are placeholders. You may freely
   # change them to suit your needs.
   #
-  # TODO: regarding community cheatsheets: these must be installed separately.
-  # You may download them here:
+  # Community cheatsheets must be installed separately, though you may have
+  # downloaded them automatically when installing 'cheat'. If not, you may
+  # download them here:
   #
   # https://github.com/cheat/cheatsheets
   #
   # Once downloaded, ensure that 'path' below points to the location at which
   # you downloaded the community cheatsheets.
   - name: community
-    path: ~/cheat/cheatsheets/community
+    path: COMMUNITY_PATH
     tags: [ community ]
     readonly: true
 
   # If you have personalized cheatsheets, list them last. They will take
   # precedence over the more global cheatsheets.
   - name: personal
-    path: ~/cheat/cheatsheets/personal
+    path: PERSONAL_PATH
     tags: [ personal ]
     readonly: false
 
-  # While it requires no specific configuration here, it's also worth noting
-  # that 'cheat' will automatically append directories named '.cheat' within
-  # the current working directory to the 'cheatpath'. This can be very useful
-  # if you'd like to closely associate cheatsheets with, for example, a
-  # directory containing source code.
+  # While it requires no configuration here, it's also worth noting that
+  # 'cheat' will automatically append directories named '.cheat' within the
+  # current working directory to the 'cheatpath'. This can be very useful if
+  # you'd like to closely associate cheatsheets with, for example, a directory
+  # containing source code.
   #
   # Such "directory-scoped" cheatsheets will be treated as the most "local"
   # cheatsheets, and will override less "local" cheatsheets. Likewise,

cmd/cheat/str_usage.go

@@ -11,18 +11,19 @@ func usage() string {
   cheat [options] [<cheatsheet>]
 
 Options:
-  --init                Write a default config file to stdout
-  -c --colorize         Colorize output
-  -d --directories      List cheatsheet directories
-  -e --edit=<sheet>     Edit <sheet>
-  -l --list             List cheatsheets
-  -p --path=<name>      Return only sheets found on path <name>
-  -r --regex            Treat search <phrase> as a regex
-  -s --search=<phrase>  Search cheatsheets for <phrase>
-  -t --tag=<tag>        Return only sheets matching <tag>
-  -T --tags             List all tags in use
-  -v --version          Print the version number
-  --rm=<sheet>          Remove (delete) <sheet>
+  --init                  Write a default config file to stdout
+  -a --all                Search among all cheatpaths
+  -c --colorize           Colorize output
+  -d --directories        List cheatsheet directories
+  -e --edit=<cheatsheet>  Edit <cheatsheet>
+  -l --list               List cheatsheets
+  -p --path=<name>        Return only sheets found on cheatpath <name>
+  -r --regex              Treat search <phrase> as a regex
+  -s --search=<phrase>    Search cheatsheets for <phrase>
+  -t --tag=<tag>          Return only sheets matching <tag>
+  -T --tags               List all tags in use
+  -v --version            Print the version number
+  --rm=<cheatsheet>       Remove (delete) <cheatsheet>
 
 Examples:
 

configs/conf.yml

@@ -1,18 +1,22 @@
 ---
 # The editor to use with 'cheat -e <sheet>'. Defaults to $EDITOR or $VISUAL.
-editor: vim
+# editor: vim
 
 # Should 'cheat' always colorize output?
-colorize: true
+colorize: false
 
 # Which 'chroma' colorscheme should be applied to the output?
 # Options are available here:
 #   https://github.com/alecthomas/chroma/tree/master/styles
-style: monokai
+# style: monokai
 
 # Which 'chroma' "formatter" should be applied?
 # One of: "terminal", "terminal256", "terminal16m"
-formatter: terminal16m
+formatter: terminal
+
+# Through which pager should output be piped? (Unset this key for no pager.)
+pager: more
+# pager: less -FRX # <- recommended where available
 
 # The paths at which cheatsheets are available. Tags associated with a cheatpath
 # are automatically attached to all cheatsheets residing on that path.
@@ -32,33 +36,34 @@ cheatpaths:
   # thus be overridden by more local cheatsheets. That being the case, you
   # should probably list community cheatsheets first.
   #
-  # Note that the paths and tags listed below are just examples. You may freely
+  # Note that the paths and tags listed below are placeholders. You may freely
   # change them to suit your needs.
   #
-  # TODO: regarding community cheatsheets: these must be installed separately.
-  # You may download them here:
+  # Community cheatsheets must be installed separately, though you may have
+  # downloaded them automatically when installing 'cheat'. If not, you may
+  # download them here:
   #
   # https://github.com/cheat/cheatsheets
   #
   # Once downloaded, ensure that 'path' below points to the location at which
   # you downloaded the community cheatsheets.
   - name: community
-    path: ~/cheat/cheatsheets/community
+    path: COMMUNITY_PATH
     tags: [ community ]
     readonly: true
 
   # If you have personalized cheatsheets, list them last. They will take
   # precedence over the more global cheatsheets.
   - name: personal
-    path: ~/cheat/cheatsheets/personal
+    path: PERSONAL_PATH
     tags: [ personal ]
     readonly: false
 
-  # While it requires no specific configuration here, it's also worth noting
-  # that 'cheat' will automatically append directories named '.cheat' within
-  # the current working directory to the 'cheatpath'. This can be very useful
-  # if you'd like to closely associate cheatsheets with, for example, a
-  # directory containing source code.
+  # While it requires no configuration here, it's also worth noting that
+  # 'cheat' will automatically append directories named '.cheat' within the
+  # current working directory to the 'cheatpath'. This can be very useful if
+  # you'd like to closely associate cheatsheets with, for example, a directory
+  # containing source code.
   #
   # Such "directory-scoped" cheatsheets will be treated as the most "local"
   # cheatsheets, and will override less "local" cheatsheets. Likewise,

doc/cheat.1

@@ -0,0 +1,221 @@
+.\" Automatically generated by Pandoc 2.2.1
+.\"
+.TH "CHEAT" "1" "" "" "General Commands Manual"
+.hy
+.SH NAME
+.PP
+\f[B]cheat\f[] \[em] create and view command\-line cheatsheets
+.SH SYNOPSIS
+.PP
+\f[B]cheat\f[] [options] [\f[I]CHEATSHEET\f[]]
+.SH DESCRIPTION
+.PP
+\f[B]cheat\f[] allows you to create and view interactive cheatsheets on
+the command\-line.
+It was designed to help remind *nix system administrators of options for
+commands that they use frequently, but not frequently enough to
+remember.
+.SH OPTIONS
+.TP
+.B \[en]init
+Print a config file to stdout.
+.RS
+.RE
+.TP
+.B \-c, \[en]colorize
+Colorize output.
+.RS
+.RE
+.TP
+.B \-d, \[en]directories
+List cheatsheet directories.
+.RS
+.RE
+.TP
+.B \-e, \[en]edit=\f[I]CHEATSHEET\f[]
+Open \f[I]CHEATSHEET\f[] for editing.
+.RS
+.RE
+.TP
+.B \-l, \[en]list
+List available cheatsheets.
+.RS
+.RE
+.TP
+.B \-p, \[en]path=\f[I]PATH\f[]
+Filter only to sheets found on path \f[I]PATH\f[].
+.RS
+.RE
+.TP
+.B \-r, \[en]regex
+Treat search \f[I]PHRASE\f[] as a regular expression.
+.RS
+.RE
+.TP
+.B \-s, \[en]search=\f[I]PHRASE\f[]
+Search cheatsheets for \f[I]PHRASE\f[].
+.RS
+.RE
+.TP
+.B \-t, \[en]tag=\f[I]TAG\f[]
+Filter only to sheets tagged with \f[I]TAG\f[].
+.RS
+.RE
+.TP
+.B \-T, \[en]tags
+List all tags in use.
+.RS
+.RE
+.TP
+.B \-v, \[en]version
+Print the version number.
+.RS
+.RE
+.TP
+.B \[en]rm=\f[I]CHEATSHEET\f[]
+Remove (deletes) \f[I]CHEATSHEET\f[].
+.RS
+.RE
+.SH EXAMPLES
+.TP
+.B To view the foo cheatsheet:
+cheat \f[I]foo\f[]
+.RS
+.RE
+.TP
+.B To edit (or create) the foo cheatsheet:
+cheat \-e \f[I]foo\f[]
+.RS
+.RE
+.TP
+.B To edit (or create) the foo/bar cheatsheet on the `work' cheatpath:
+cheat \-p \f[I]work\f[] \-e \f[I]foo/bar\f[]
+.RS
+.RE
+.TP
+.B To view all cheatsheet directories:
+cheat \-d
+.RS
+.RE
+.TP
+.B To list all available cheatsheets:
+cheat \-l
+.RS
+.RE
+.TP
+.B To list all cheatsheets whose titles match `apt':
+cheat \-l \f[I]apt\f[]
+.RS
+.RE
+.TP
+.B To list all tags in use:
+cheat \-T
+.RS
+.RE
+.TP
+.B To list available cheatsheets that are tagged as `personal':
+cheat \-l \-t \f[I]personal\f[]
+.RS
+.RE
+.TP
+.B To search for `ssh' among all cheatsheets, and colorize matches:
+cheat \-c \-s \f[I]ssh\f[]
+.RS
+.RE
+.TP
+.B To search (by regex) for cheatsheets that contain an IP address:
+cheat \-c \-r \-s \f[I]`(?:[0\-9]{1,3}.){3}[0\-9]{1,3}'\f[]
+.RS
+.RE
+.TP
+.B To remove (delete) the foo/bar cheatsheet:
+cheat \[en]rm \f[I]foo/bar\f[]
+.RS
+.RE
+.SH FILES
+.SS Configuration
+.PP
+\f[B]cheat\f[] is configured via a YAML file that is conventionally
+named \f[I]conf.yaml\f[].
+\f[B]cheat\f[] will search for \f[I]conf.yaml\f[] in varying locations,
+depending upon your platform:
+.SS Linux, OSX, and other Unixes
+.IP "1." 3
+\f[B]CHEAT_CONFIG_PATH\f[]
+.IP "2." 3
+\f[B]XDG_CONFIG_HOME\f[]/cheat/conf.yaml
+.IP "3." 3
+\f[B]$HOME\f[]/.config/cheat/conf.yml
+.IP "4." 3
+\f[B]$HOME\f[]/.cheat/conf.yml
+.SS Windows
+.IP "1." 3
+\f[B]CHEAT_CONFIG_PATH\f[]
+.IP "2." 3
+\f[B]APPDATA\f[]/cheat/conf.yml
+.IP "3." 3
+\f[B]PROGRAMDATA\f[]/cheat/conf.yml
+.PP
+\f[B]cheat\f[] will search in the order specified above.
+The first \f[I]conf.yaml\f[] encountered will be respected.
+.PP
+If \f[B]cheat\f[] cannot locate a config file, it will ask if you'd like
+to generate one automatically.
+Alternatively, you may also generate a config file manually by running
+\f[B]cheat \[en]init\f[] and saving its output to the appropriate
+location for your platform.
+.SS Cheatpaths
+.PP
+\f[B]cheat\f[] reads its cheatsheets from \[lq]cheatpaths\[rq], which
+are the directories in which cheatsheets are stored.
+Cheatpaths may be configured in \f[I]conf.yaml\f[], and viewed via
+\f[B]cheat \-d\f[].
+.PP
+For detailed instructions on how to configure cheatpaths, please refer
+to the comments in conf.yml.
+.SS Autocompletion
+.PP
+Autocompletion scripts for \f[B]bash\f[], \f[B]zsh\f[], and
+\f[B]fish\f[] are available for download:
+.IP \[bu] 2
+<https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
+.IP \[bu] 2
+<https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
+.IP \[bu] 2
+<https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
+.PP
+The \f[B]bash\f[] and \f[B]zsh\f[] scripts provide optional integration
+with \f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[].
+.PP
+The installation process will vary per system and shell configuration,
+and thus will not be discussed here.
+.SH ENVIRONMENT
+.TP
+.B \f[B]CHEAT_CONFIG_PATH\f[]
+The path at which the config file is available.
+If \f[B]CHEAT_CONFIG_PATH\f[] is set, all other config paths will be
+ignored.
+.RS
+.RE
+.TP
+.B \f[B]CHEAT_USE_FZF\f[]
+If set, autocompletion scripts will attempt to integrate with
+\f[B]fzf\f[].
+.RS
+.RE
+.SH RETURN VALUES
+.IP "0." 3
+Successful termination
+.IP "1." 3
+Application error
+.IP "2." 3
+Cheatsheet(s) not found
+.SH BUGS
+.PP
+See GitHub issues: <https://github.com/cheat/cheat/issues>
+.SH AUTHOR
+.PP
+Christopher Allen Lane <chris@chris-allen-lane.com>
+.SH SEE ALSO
+.PP
+\f[B]fzf(1)\f[]

doc/cheat.1.md

@@ -0,0 +1,192 @@
+% CHEAT(1) | General Commands Manual
+
+NAME
+====
+
+**cheat** — create and view command-line cheatsheets
+
+SYNOPSIS
+========
+
+| **cheat** \[options] \[_CHEATSHEET_]
+
+DESCRIPTION
+===========
+**cheat** allows you to create and view interactive cheatsheets on the
+command-line. It was designed to help remind \*nix system administrators of
+options for commands that they use frequently, but not frequently enough to
+remember.
+
+OPTIONS
+=======
+
+--init
+: Print a config file to stdout.
+
+-c, --colorize
+: Colorize output.
+
+-d, --directories
+: List cheatsheet directories.
+
+-e, --edit=_CHEATSHEET_
+: Open _CHEATSHEET_ for editing.
+
+-l, --list
+: List available cheatsheets.
+
+-p, --path=_PATH_
+: Filter only to sheets found on path _PATH_.
+
+-r, --regex
+: Treat search _PHRASE_ as a regular expression.
+
+-s, --search=_PHRASE_
+: Search cheatsheets for _PHRASE_.
+
+-t, --tag=_TAG_
+: Filter only to sheets tagged with _TAG_.
+
+-T, --tags
+: List all tags in use.
+
+-v, --version
+: Print the version number.
+
+--rm=_CHEATSHEET_
+: Remove (deletes) _CHEATSHEET_.
+
+
+EXAMPLES
+========
+
+To view the foo cheatsheet:
+: cheat _foo_
+
+To edit (or create) the foo cheatsheet:
+: cheat -e _foo_
+
+To edit (or create) the foo/bar cheatsheet on the 'work' cheatpath:
+: cheat -p _work_ -e _foo/bar_
+
+To view all cheatsheet directories:
+: cheat -d
+
+To list all available cheatsheets:
+: cheat -l
+
+To list all cheatsheets whose titles match 'apt':
+: cheat -l _apt_
+
+To list all tags in use:
+: cheat -T
+
+To list available cheatsheets that are tagged as 'personal':
+: cheat -l -t _personal_
+
+To search for 'ssh' among all cheatsheets, and colorize matches:
+: cheat -c -s _ssh_
+
+To search (by regex) for cheatsheets that contain an IP address:
+: cheat -c -r -s _'(?:[0-9]{1,3}\.){3}[0-9]{1,3}'_
+
+To remove (delete) the foo/bar cheatsheet:
+: cheat --rm _foo/bar_
+
+
+FILES
+=====
+
+Configuration
+-------------
+**cheat** is configured via a YAML file that is conventionally named
+_conf.yaml_.  **cheat** will search for _conf.yaml_ in varying locations,
+depending upon your platform:
+
+### Linux, OSX, and other Unixes ###
+
+1. **CHEAT_CONFIG_PATH**
+2. **XDG_CONFIG_HOME**/cheat/conf.yaml
+3. **$HOME**/.config/cheat/conf.yml
+4. **$HOME**/.cheat/conf.yml
+
+### Windows ###
+
+1. **CHEAT_CONFIG_PATH**
+2. **APPDATA**/cheat/conf.yml
+3. **PROGRAMDATA**/cheat/conf.yml
+
+**cheat** will search in the order specified above. The first _conf.yaml_
+encountered will be respected.
+
+If **cheat** cannot locate a config file, it will ask if you'd like to generate
+one automatically. Alternatively, you may also generate a config file manually
+by running **cheat --init** and saving its output to the appropriate location
+for your platform.
+
+
+Cheatpaths
+----------
+**cheat** reads its cheatsheets from "cheatpaths", which are the directories in
+which cheatsheets are stored. Cheatpaths may be configured in _conf.yaml_, and
+viewed via **cheat -d**.
+
+For detailed instructions on how to configure cheatpaths, please refer to the
+comments in conf.yml.
+
+
+Autocompletion
+--------------
+Autocompletion scripts for **bash**, **zsh**, and **fish** are available for
+download:
+
+- <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
+- <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
+- <https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
+
+The **bash** and **zsh** scripts provide optional integration with **fzf**, if
+the latter is available on your **PATH**.
+
+The installation process will vary per system and shell configuration, and thus
+will not be discussed here.
+
+
+ENVIRONMENT
+===========
+
+**CHEAT_CONFIG_PATH**
+
+: The path at which the config file is available. If **CHEAT_CONFIG_PATH** is
+set, all other config paths will be ignored.
+
+**CHEAT_USE_FZF**
+
+: If set, autocompletion scripts will attempt to integrate with **fzf**.
+
+RETURN VALUES
+=============
+
+0. Successful termination
+
+1. Application error
+
+2. Cheatsheet(s) not found
+
+
+BUGS
+====
+
+See GitHub issues: <https://github.com/cheat/cheat/issues>
+
+
+AUTHOR
+======
+
+Christopher Allen Lane <chris@chris-allen-lane.com>
+
+
+SEE ALSO
+========
+
+**fzf(1)**
+

go.mod

@@ -1,14 +1,17 @@
 module github.com/cheat/cheat
 
-go 1.13
+go 1.14
 
 require (
-	github.com/alecthomas/chroma v0.7.1
+	github.com/alecthomas/chroma v0.9.1
 	github.com/davecgh/go-spew v1.1.1
 	github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815
-	github.com/mattn/go-isatty v0.0.12
-	github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b
+	github.com/kr/text v0.2.0 // indirect
+	github.com/mattn/go-isatty v0.0.14
 	github.com/mitchellh/go-homedir v1.1.0
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
+	github.com/sergi/go-diff v1.1.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 	gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0
-	gopkg.in/yaml.v2 v2.2.8
+	gopkg.in/yaml.v2 v2.4.0
 )

go.sum

@@ -1,48 +1,59 @@
 github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38 h1:smF2tmSOzy2Mm+0dGI2AIUHY+w0BUc+4tn40djz7+6U=
 github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38/go.mod h1:r7bzyVFMNntcxPZXK3/+KdruV1H5KSlyVY0gc+NgInI=
-github.com/alecthomas/chroma v0.7.1 h1:G1i02OhUbRi2nJxcNkwJaY/J1gHXj9tt72qN6ZouLFQ=
-github.com/alecthomas/chroma v0.7.1/go.mod h1:gHw09mkX1Qp80JlYbmN9L3+4R5o6DJJ3GRShh+AICNc=
+github.com/alecthomas/chroma v0.9.1 h1:cBmvQqRImzR5aWqdMxYZByND4S7BCS/g0svZb28h0Dc=
+github.com/alecthomas/chroma v0.9.1/go.mod h1:eMuEnpA18XbG/WhOWtCzJHS7WqEtDAI+HxdwoW0nVSk=
 github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721 h1:JHZL0hZKJ1VENNfmXvHbgYlbUOvpzYzvy2aZU5gXVeo=
 github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721/go.mod h1:QO9JBoKquHd+jz9nshCh40fOfO+JzsoXy8qTHF68zU0=
-github.com/alecthomas/kong v0.2.1-0.20190708041108-0548c6b1afae/go.mod h1:+inYUSluD+p4L8KdviBSgzcqEjUQOfC5fQDRFuc36lI=
+github.com/alecthomas/kong v0.2.4/go.mod h1:kQOmtJgV+Lb4aj+I2LEn40cbtawdWJ9Y8QLq+lElKxE=
 github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897 h1:p9Sln00KOTlrYkxI1zYWl1QLnEqAqEARBEYa8FQnQcY=
 github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897/go.mod h1:xTS7Pm1pD1mvyM075QCDSRqH6qRLXylzS24ZTpRiSzQ=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964 h1:y5HC9v93H5EPKqaS1UYVg1uYah5Xf51mBfIoWehClUQ=
 github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964/go.mod h1:Xd9hchkHSWYkEqJwUGisez3G1QY8Ryz0sdWrLPMGjLk=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/dlclark/regexp2 v1.1.6 h1:CqB4MjHw0MFCDj+PHHjiESmHX+N7t0tJzKvC6M97BRg=
-github.com/dlclark/regexp2 v1.1.6/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
+github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E=
+github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
 github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 h1:bWDMxwH3px2JBh6AyO7hdCn/PkvCZXii8TGj7sbtEbQ=
 github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
-github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
-github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
-github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
-github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
-github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
-github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4=
-github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
-github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
+github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
+github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
-github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35 h1:YAFjXN64LMvktoUZH9zgY4lGc/msGN7HQfoSuKCgaDU=
-golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20200116001909-b77594299b42 h1:vEOn+mP2zCOVzKckCZy6YsCtDblrpj/w7B9nxGNELpg=
+github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200413165638-669c56c373c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0 h1:POO/ycCATvegFmVuPpQzZFJ+pGZeX22Ufu6fibxDVjU=
 gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0/go.mod h1:WDnlLJ4WF5VGsH/HVa3CI79GS0ol3YnhVnKP89i0kNg=
-gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
-gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

internal/config/color_test.go

@@ -0,0 +1,22 @@
+package config
+
+import (
+	"testing"
+)
+
+// TestColor asserts that colorization rules are properly respected
+func TestColor(t *testing.T) {
+
+	// mock a config
+	conf := Config{}
+
+	opts := map[string]interface{}{"--colorize": false}
+	if conf.Color(opts) {
+		t.Errorf("failed to respect --colorize (false)")
+	}
+
+	opts = map[string]interface{}{"--colorize": true}
+	if !conf.Color(opts) {
+		t.Errorf("failed to respect --colorize (true)")
+	}
+}

internal/config/config.go

@@ -4,7 +4,10 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"os/exec"
 	"path/filepath"
+	"runtime"
+	"strings"
 
 	cp "github.com/cheat/cheat/internal/cheatpath"
 
@@ -19,6 +22,7 @@ type Config struct {
 	Cheatpaths []cp.Cheatpath `yaml:"cheatpaths"`
 	Style      string         `yaml:"style"`
 	Formatter  string         `yaml:"formatter"`
+	Pager      string         `yaml:"pager"`
 }
 
 // New returns a new Config struct
@@ -96,8 +100,22 @@ func New(opts map[string]interface{}, confPath string, resolve bool) (Config, er
 			conf.Editor = os.Getenv("VISUAL")
 		} else if os.Getenv("EDITOR") != "" {
 			conf.Editor = os.Getenv("EDITOR")
+		} else if runtime.GOOS == "windows" {
+			conf.Editor = "notepad"
 		} else {
-			return Config{}, fmt.Errorf("no editor set")
+			// try to fall back to `nano`
+			path, err := exec.LookPath("nano")
+			if err != nil {
+				return Config{}, fmt.Errorf("failed to locate nano: %s", err)
+			}
+
+			// use `nano` if we found it
+			if path != "" {
+				conf.Editor = "nano"
+				// otherwise, give up
+			} else {
+				return Config{}, fmt.Errorf("no editor set")
+			}
 		}
 	}
 
@@ -108,7 +126,13 @@ func New(opts map[string]interface{}, confPath string, resolve bool) (Config, er
 
 	// if a chroma formatter was not provided, set a default
 	if conf.Formatter == "" {
-		conf.Formatter = "terminal16m"
+		conf.Formatter = "terminal"
+	}
+
+	// attempt to fall back to `PAGER` if a pager is not specified in configs
+	conf.Pager = strings.TrimSpace(conf.Pager)
+	if conf.Pager == "" && os.Getenv("PAGER") != "" {
+		conf.Pager = os.Getenv("PAGER")
 	}
 
 	return conf, nil

internal/config/config_test.go

@@ -39,17 +39,17 @@ func TestConfigSuccessful(t *testing.T) {
 	// assert that the cheatpaths are correct
 	want := []cheatpath.Cheatpath{
 		cheatpath.Cheatpath{
-			Path:     filepath.Join(home, ".dotfiles/cheat/community"),
+			Path:     filepath.Join(home, ".dotfiles", "cheat", "community"),
 			ReadOnly: true,
 			Tags:     []string{"community"},
 		},
 		cheatpath.Cheatpath{
-			Path:     filepath.Join(home, ".dotfiles/cheat/work"),
+			Path:     filepath.Join(home, ".dotfiles", "cheat", "work"),
 			ReadOnly: false,
 			Tags:     []string{"work"},
 		},
 		cheatpath.Cheatpath{
-			Path:     filepath.Join(home, ".dotfiles/cheat/personal"),
+			Path:     filepath.Join(home, ".dotfiles", "cheat", "personal"),
 			ReadOnly: false,
 			Tags:     []string{"personal"},
 		},
@@ -85,8 +85,8 @@ func TestEmptyEditor(t *testing.T) {
 
 	// initialize a config
 	conf, err := New(map[string]interface{}{}, mock.Path("conf/empty.yml"), false)
-	if err == nil {
-		t.Errorf("failed to return an error on empty editor")
+	if err != nil {
+		t.Errorf("failed to initialize test: %v", err)
 	}
 
 	// set editor, and assert that it is respected

internal/config/init_test.go

@@ -0,0 +1,38 @@
+package config
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+)
+
+// TestInit asserts that configs are properly initialized
+func TestInit(t *testing.T) {
+
+	// initialize a temporary config file
+	confFile, err := ioutil.TempFile("", "cheat-test")
+	if err != nil {
+		t.Errorf("failed to create temp file: %v", err)
+	}
+
+	// clean up the temp file
+	defer os.Remove(confFile.Name())
+
+	// initialize the config file
+	conf := "mock config data"
+	if err = Init(confFile.Name(), conf); err != nil {
+		t.Errorf("failed to init config file: %v", err)
+	}
+
+	// read back the config file contents
+	bytes, err := ioutil.ReadFile(confFile.Name())
+	if err != nil {
+		t.Errorf("failed to read config file: %v", err)
+	}
+
+	// assert that the contents were written correctly
+	got := string(bytes)
+	if got != conf {
+		t.Errorf("failed to write configs: want: %s, got: %s", conf, got)
+	}
+}

internal/config/path_test.go

@@ -0,0 +1,53 @@
+package config
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+)
+
+// TestPathConfigNotExists asserts that `Path` identifies non-existent config
+// files
+func TestPathConfigNotExists(t *testing.T) {
+
+	// package (invalid) cheatpaths
+	paths := []string{"/cheat-test-conf-does-not-exist"}
+
+	// assert
+	if _, err := Path(paths); err == nil {
+		t.Errorf("failed to identify non-existent config file")
+	}
+
+}
+
+// TestPathConfigExists asserts that `Path` identifies existent config files
+func TestPathConfigExists(t *testing.T) {
+
+	// initialize a temporary config file
+	confFile, err := ioutil.TempFile("", "cheat-test")
+	if err != nil {
+		t.Errorf("failed to create temp file: %v", err)
+	}
+
+	// clean up the temp file
+	defer os.Remove(confFile.Name())
+
+	// package cheatpaths
+	paths := []string{
+		"/cheat-test-conf-does-not-exist",
+		confFile.Name(),
+	}
+
+	// assert
+	got, err := Path(paths)
+	if err != nil {
+		t.Errorf("failed to identify config file: %v", err)
+	}
+	if got != confFile.Name() {
+		t.Errorf(
+			"failed to return config path: want: %s, got: %s",
+			confFile.Name(),
+			got,
+		)
+	}
+}

internal/config/paths.go

@@ -2,14 +2,18 @@ package config
 
 import (
 	"fmt"
-	"path"
+	"path/filepath"
 
 	"github.com/mitchellh/go-homedir"
 )
 
 // Paths returns config file paths that are appropriate for the operating
 // system
-func Paths(sys string, envvars map[string]string) ([]string, error) {
+func Paths(
+	sys string,
+	home string,
+	envvars map[string]string,
+) ([]string, error) {
 
 	// if `CHEAT_CONFIG_PATH` is set, expand ~ and return it
 	if confpath, ok := envvars["CHEAT_CONFIG_PATH"]; ok {
@@ -24,25 +28,25 @@ func Paths(sys string, envvars map[string]string) ([]string, error) {
 	}
 
 	switch sys {
-	case "darwin", "linux", "freebsd":
+	case "android", "darwin", "linux", "freebsd":
 		paths := []string{}
 
 		// don't include the `XDG_CONFIG_HOME` path if that envvar is not set
 		if xdgpath, ok := envvars["XDG_CONFIG_HOME"]; ok {
-			paths = append(paths, path.Join(xdgpath, "/cheat/conf.yml"))
+			paths = append(paths, filepath.Join(xdgpath, "cheat", "conf.yml"))
 		}
 
-		// `HOME` will always be set on a POSIX-compliant system, though
 		paths = append(paths, []string{
-			path.Join(envvars["HOME"], ".config/cheat/conf.yml"),
-			path.Join(envvars["HOME"], ".cheat/conf.yml"),
+			filepath.Join(home, ".config", "cheat", "conf.yml"),
+			filepath.Join(home, ".cheat", "conf.yml"),
+			"/etc/cheat/conf.yml",
 		}...)
 
 		return paths, nil
 	case "windows":
 		return []string{
-			path.Join(envvars["APPDATA"], "/cheat/conf.yml"),
-			path.Join(envvars["PROGRAMDATA"], "/cheat/conf.yml"),
+			filepath.Join(envvars["APPDATA"], "cheat", "conf.yml"),
+			filepath.Join(envvars["PROGRAMDATA"], "cheat", "conf.yml"),
 		}, nil
 	default:
 		return []string{}, fmt.Errorf("unsupported os: %s", sys)

internal/config/paths_test.go

@@ -11,14 +11,17 @@ import (
 // *nix platforms
 func TestValidatePathsNix(t *testing.T) {
 
+	// mock the user's home directory
+	home := "/home/foo"
+
 	// mock some envvars
 	envvars := map[string]string{
-		"HOME":            "/home/foo",
 		"XDG_CONFIG_HOME": "/home/bar",
 	}
 
 	// specify the platforms to test
 	oses := []string{
+		"android",
 		"darwin",
 		"freebsd",
 		"linux",
@@ -27,7 +30,7 @@ func TestValidatePathsNix(t *testing.T) {
 	// test each *nix os
 	for _, os := range oses {
 		// get the paths for the platform
-		paths, err := Paths(os, envvars)
+		paths, err := Paths(os, home, envvars)
 		if err != nil {
 			t.Errorf("paths returned an error: %v", err)
 		}
@@ -37,6 +40,7 @@ func TestValidatePathsNix(t *testing.T) {
 			"/home/bar/cheat/conf.yml",
 			"/home/foo/.config/cheat/conf.yml",
 			"/home/foo/.cheat/conf.yml",
+			"/etc/cheat/conf.yml",
 		}
 
 		// assert that output matches expectations
@@ -54,10 +58,11 @@ func TestValidatePathsNix(t *testing.T) {
 // on *nix platforms when `XDG_CONFIG_HOME is not set
 func TestValidatePathsNixNoXDG(t *testing.T) {
 
+	// mock the user's home directory
+	home := "/home/foo"
+
 	// mock some envvars
-	envvars := map[string]string{
-		"HOME": "/home/foo",
-	}
+	envvars := map[string]string{}
 
 	// specify the platforms to test
 	oses := []string{
@@ -69,7 +74,7 @@ func TestValidatePathsNixNoXDG(t *testing.T) {
 	// test each *nix os
 	for _, os := range oses {
 		// get the paths for the platform
-		paths, err := Paths(os, envvars)
+		paths, err := Paths(os, home, envvars)
 		if err != nil {
 			t.Errorf("paths returned an error: %v", err)
 		}
@@ -78,6 +83,7 @@ func TestValidatePathsNixNoXDG(t *testing.T) {
 		want := []string{
 			"/home/foo/.config/cheat/conf.yml",
 			"/home/foo/.cheat/conf.yml",
+			"/etc/cheat/conf.yml",
 		}
 
 		// assert that output matches expectations
@@ -95,6 +101,9 @@ func TestValidatePathsNixNoXDG(t *testing.T) {
 // on Windows platforms
 func TestValidatePathsWindows(t *testing.T) {
 
+	// mock the user's home directory
+	home := "not-used-on-windows"
+
 	// mock some envvars
 	envvars := map[string]string{
 		"APPDATA":     "/apps",
@@ -102,7 +111,7 @@ func TestValidatePathsWindows(t *testing.T) {
 	}
 
 	// get the paths for the platform
-	paths, err := Paths("windows", envvars)
+	paths, err := Paths("windows", home, envvars)
 	if err != nil {
 		t.Errorf("paths returned an error: %v", err)
 	}
@@ -126,7 +135,7 @@ func TestValidatePathsWindows(t *testing.T) {
 // TestValidatePathsUnsupported asserts that an error is returned on
 // unsupported platforms
 func TestValidatePathsUnsupported(t *testing.T) {
-	_, err := Paths("unsupported", map[string]string{})
+	_, err := Paths("unsupported", "", map[string]string{})
 	if err == nil {
 		t.Errorf("failed to return error on unsupported platform")
 	}
@@ -136,15 +145,17 @@ func TestValidatePathsUnsupported(t *testing.T) {
 // returned when `CHEAT_CONFIG_PATH` is explicitly specified.
 func TestValidatePathsCheatConfigPath(t *testing.T) {
 
+	// mock the user's home directory
+	home := "/home/foo"
+
 	// mock some envvars
 	envvars := map[string]string{
-		"HOME":              "/home/foo",
 		"XDG_CONFIG_HOME":   "/home/bar",
 		"CHEAT_CONFIG_PATH": "/home/baz/conf.yml",
 	}
 
 	// get the paths for the platform
-	paths, err := Paths("linux", envvars)
+	paths, err := Paths("linux", home, envvars)
 	if err != nil {
 		t.Errorf("paths returned an error: %v", err)
 	}

internal/display/faint.go

@@ -0,0 +1,18 @@
+package display
+
+import (
+	"fmt"
+
+	"github.com/cheat/cheat/internal/config"
+)
+
+// Faint returns an faint string
+func Faint(str string, conf config.Config) string {
+	// make `str` faint only if colorization has been requested
+	if conf.Colorize {
+		return fmt.Sprintf(fmt.Sprintf("\033[2m%s\033[0m", str))
+	}
+
+	// otherwise, return the string unmodified
+	return str
+}

internal/display/faint_test.go

@@ -0,0 +1,27 @@
+package display
+
+import (
+	"testing"
+
+	"github.com/cheat/cheat/internal/config"
+)
+
+// TestFaint asserts that Faint applies faint formatting
+func TestFaint(t *testing.T) {
+
+	// case: apply colorization
+	conf := config.Config{Colorize: true}
+	want := "\033[2mfoo\033[0m"
+	got := Faint("foo", conf)
+	if want != got {
+		t.Errorf("failed to faint: want: %s, got: %s", want, got)
+	}
+
+	// case: do not apply colorization
+	conf.Colorize = false
+	want = "foo"
+	got = Faint("foo", conf)
+	if want != got {
+		t.Errorf("failed to faint: want: %s, got: %s", want, got)
+	}
+}

internal/display/indent.go

@@ -0,0 +1,21 @@
+package display
+
+import (
+	"fmt"
+	"strings"
+)
+
+// Indent prepends each line of a string with a tab
+func Indent(str string) string {
+
+	// trim superfluous whitespace
+	str = strings.TrimSpace(str)
+
+	// prepend each line with a tab character
+	out := ""
+	for _, line := range strings.Split(str, "\n") {
+		out += fmt.Sprintf("\t%s\n", line)
+	}
+
+	return out
+}

internal/display/indent_test.go

@@ -0,0 +1,12 @@
+package display
+
+import "testing"
+
+// TestIndent asserts that Indent prepends a tab to each line
+func TestIndent(t *testing.T) {
+	got := Indent("foo\nbar\nbaz")
+	want := "\tfoo\n\tbar\n\tbaz\n"
+	if got != want {
+		t.Errorf("failed to indent: want: %s, got: %s", want, got)
+	}
+}

internal/display/underline.go

@@ -0,0 +1,8 @@
+package display
+
+import "fmt"
+
+// Underline returns an underlined string
+func Underline(str string) string {
+	return fmt.Sprintf(fmt.Sprintf("\033[4m%s\033[0m", str))
+}

internal/display/underline_test.go

@@ -0,0 +1,14 @@
+package display
+
+import (
+	"testing"
+)
+
+// TestUnderline asserts that Underline applies underline formatting
+func TestUnderline(t *testing.T) {
+	want := "\033[4mfoo\033[0m"
+	got := Underline("foo")
+	if want != got {
+		t.Errorf("failed to underline: want: %s, got: %s", want, got)
+	}
+}

internal/display/write.go

@@ -0,0 +1,37 @@
+package display
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/cheat/cheat/internal/config"
+)
+
+// Write writes output either directly to stdout, or through a pager,
+// depending upon configuration.
+func Write(out string, conf config.Config) {
+	// if no pager was configured, print the output to stdout and exit
+	if conf.Pager == "" {
+		fmt.Print(out)
+		os.Exit(0)
+	}
+
+	// otherwise, pipe output through the pager
+	parts := strings.Split(conf.Pager, " ")
+	pager := parts[0]
+	args := parts[1:]
+
+	// run the pager
+	cmd := exec.Command(pager, args...)
+	cmd.Stdin = strings.NewReader(out)
+	cmd.Stdout = os.Stdout
+
+	// handle errors
+	err := cmd.Run()
+	if err != nil {
+		fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to write to pager: %v", err))
+		os.Exit(1)
+	}
+}

internal/frontmatter/frontmatter.go

@@ -1,6 +1,7 @@
 package frontmatter
 
 import (
+	"fmt"
 	"strings"
 
 	"gopkg.in/yaml.v1"
@@ -28,7 +29,16 @@ func Parse(markdown string) (string, Frontmatter, error) {
 
 	// otherwise, split the frontmatter and cheatsheet text
 	parts := strings.SplitN(markdown, delim, 3)
-	err := yaml.Unmarshal([]byte(parts[1]), &fm)
 
-	return strings.TrimSpace(parts[2]), fm, err
+	// return an error if the frontmatter parses into the wrong number of parts
+	if len(parts) != 3 {
+		return markdown, fm, fmt.Errorf("failed to delimit frontmatter")
+	}
+
+	// return an error if the YAML cannot be unmarshalled
+	if err := yaml.Unmarshal([]byte(parts[1]), &fm); err != nil {
+		return markdown, fm, fmt.Errorf("failed to unmarshal frontmatter: %v", err)
+	}
+
+	return strings.TrimSpace(parts[2]), fm, nil
 }

internal/frontmatter/frontmatter_test.go

@@ -69,3 +69,27 @@ func TestHasNoFrontmatter(t *testing.T) {
 		t.Errorf("failed to parse tags: want: len 0, got: len %d", len(fm.Tags))
 	}
 }
+
+// TestHasInvalidFrontmatter asserts that markdown is properly parsed when it
+// contains invalid frontmatter
+func TestHasInvalidFrontmatter(t *testing.T) {
+
+	// stub our cheatsheet content (with invalid frontmatter)
+	markdown := `---
+syntax: go
+tags: [ test ]
+To foo the bar: baz`
+
+	// parse the frontmatter
+	text, _, err := Parse(markdown)
+
+	// assert that an error was returned
+	if err == nil {
+		t.Error("failed to error on invalid frontmatter")
+	}
+
+	// assert that the "raw" markdown was returned
+	if text != markdown {
+		t.Errorf("failed to parse text: want: %s, got: %s", markdown, text)
+	}
+}

internal/installer/clone.go

@@ -0,0 +1,24 @@
+package installer
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+)
+
+const cloneURL = "https://github.com/cheat/cheatsheets.git"
+
+// clone clones the community cheatsheets
+func clone(path string) error {
+
+	// perform the clone in a shell
+	cmd := exec.Command("git", "clone", cloneURL, path)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	err := cmd.Run()
+	if err != nil {
+		return fmt.Errorf("failed to clone cheatsheets: %v", err)
+	}
+
+	return nil
+}

internal/installer/prompt.go

@@ -0,0 +1,37 @@
+package installer
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strings"
+)
+
+// Prompt prompts the user for a answer
+func Prompt(prompt string, def bool) (bool, error) {
+
+	// initialize a line reader
+	reader := bufio.NewReader(os.Stdin)
+
+	// display the prompt
+	fmt.Print(fmt.Sprintf("%s: ", prompt))
+
+	// read the answer
+	ans, err := reader.ReadString('\n')
+	if err != nil {
+		return false, fmt.Errorf("failed to parse input: %v", err)
+	}
+
+	// normalize the answer
+	ans = strings.ToLower(strings.TrimSpace(ans))
+
+	// return the appropriate response
+	switch ans {
+	case "y":
+		return true, nil
+	case "":
+		return def, nil
+	default:
+		return false, nil
+	}
+}

internal/installer/run.go

@@ -0,0 +1,57 @@
+package installer
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/cheat/cheat/internal/config"
+)
+
+// Run runs the installer
+func Run(configs string, confpath string) error {
+
+	// determine the appropriate paths for config data and (optional) community
+	// cheatsheets based on the user's platform
+	confdir := filepath.Dir(confpath)
+
+	// create paths for community and personal cheatsheets
+	community := filepath.Join(confdir, "cheatsheets", "community")
+	personal := filepath.Join(confdir, "cheatsheets", "personal")
+
+	// template the above paths into the default configs
+	configs = strings.Replace(configs, "COMMUNITY_PATH", community, -1)
+	configs = strings.Replace(configs, "PERSONAL_PATH", personal, -1)
+
+	// prompt the user to download the community cheatsheets
+	yes, err := Prompt(
+		"Would you like to download the community cheatsheets? [Y/n]",
+		true,
+	)
+	if err != nil {
+		return fmt.Errorf("failed to prompt: %v", err)
+	}
+
+	// clone the community cheatsheets if so instructed
+	if yes {
+		// clone the community cheatsheets
+		fmt.Printf("Cloning community cheatsheets to %s.\n", community)
+		if err := clone(community); err != nil {
+			return fmt.Errorf("failed to clone cheatsheets: %v", err)
+		}
+
+		// also create a directory for personal cheatsheets
+		fmt.Printf("Cloning personal cheatsheets to %s.\n", personal)
+		if err := os.MkdirAll(personal, os.ModePerm); err != nil {
+			return fmt.Errorf("failed to create directory: %v", err)
+		}
+	}
+
+	// the config file does not exist, so we'll try to create one
+	if err = config.Init(confpath, configs); err != nil {
+		return fmt.Errorf("failed to create config file: %v", err)
+	}
+
+	return nil
+}

internal/mock/path.go

@@ -13,7 +13,7 @@ func Path(filename string) string {
 	// determine the path of this file during runtime
 	_, thisfile, _, _ := runtime.Caller(0)
 
-	// compute the config path
+	// compute the mock path
 	file, err := filepath.Abs(
 		path.Join(
 			filepath.Dir(thisfile),
@@ -22,7 +22,7 @@ func Path(filename string) string {
 		),
 	)
 	if err != nil {
-		panic(fmt.Errorf("failed to resolve config path: %v", err))
+		panic(fmt.Errorf("failed to resolve mock path: %v", err))
 	}
 
 	return file

internal/sheet/colorize.go

@@ -0,0 +1,37 @@
+package sheet
+
+import (
+	"bytes"
+
+	"github.com/cheat/cheat/internal/config"
+
+	"github.com/alecthomas/chroma/quick"
+)
+
+// Colorize applies syntax-highlighting to a cheatsheet's Text.
+func (s *Sheet) Colorize(conf config.Config) {
+
+	// if the syntax was not specified, default to bash
+	lex := s.Syntax
+	if lex == "" {
+		lex = "bash"
+	}
+
+	// write colorized text into a buffer
+	var buf bytes.Buffer
+	err := quick.Highlight(
+		&buf,
+		s.Text,
+		lex,
+		conf.Formatter,
+		conf.Style,
+	)
+
+	// if colorization somehow failed, do nothing
+	if err != nil {
+		return
+	}
+
+	// otherwise, swap the cheatsheet's Text with its colorized equivalent
+	s.Text = buf.String()
+}

internal/sheet/colorize_test.go

@@ -0,0 +1,34 @@
+package sheet
+
+import (
+	"testing"
+
+	"github.com/cheat/cheat/internal/config"
+)
+
+// TestColorize asserts that syntax-highlighting is correctly applied
+func TestColorize(t *testing.T) {
+
+	// mock configs
+	conf := config.Config{
+		Formatter: "terminal16m",
+		Style:     "solarized-dark",
+	}
+
+	// mock a sheet
+	s := Sheet{
+		Text: "echo 'foo'",
+	}
+
+	// colorize the sheet text
+	s.Colorize(conf)
+
+	// initialize expectations
+	want := "echo"
+	want += " 'foo'"
+
+	// assert
+	if s.Text != want {
+		t.Errorf("failed to colorize sheet: want: %s, got: %s", want, s.Text)
+	}
+}

internal/sheet/copy.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"path"
+	"path/filepath"
 )
 
 // Copy copies a cheatsheet to a new location
@@ -22,7 +22,7 @@ func (s *Sheet) Copy(dest string) error {
 	defer infile.Close()
 
 	// create any necessary subdirectories
-	dirs := path.Dir(dest)
+	dirs := filepath.Dir(dest)
 	if dirs != "." {
 		if err := os.MkdirAll(dirs, 0755); err != nil {
 			return fmt.Errorf("failed to create directory: %s, %v", dirs, err)

internal/sheet/copy_test.go

@@ -25,7 +25,7 @@ func TestCopyFlat(t *testing.T) {
 	}
 
 	// mock a cheatsheet struct
-	sheet, err := New("foo", src.Name(), []string{}, false)
+	sheet, err := New("foo", "community", src.Name(), []string{}, false)
 	if err != nil {
 		t.Errorf("failed to init cheatsheet: %v", err)
 	}
@@ -72,7 +72,13 @@ func TestCopyDeep(t *testing.T) {
 	}
 
 	// mock a cheatsheet struct
-	sheet, err := New("/cheat-tests/alpha/bravo/foo", src.Name(), []string{}, false)
+	sheet, err := New(
+		"/cheat-tests/alpha/bravo/foo",
+		"community",
+		src.Name(),
+		[]string{},
+		false,
+	)
 	if err != nil {
 		t.Errorf("failed to init cheatsheet: %v", err)
 	}

internal/sheet/match.go

@@ -1,7 +0,0 @@
-package sheet
-
-// Match encapsulates search matches within cheatsheets
-type Match struct {
-	Line int
-	Text string
-}

internal/sheet/search.go

@@ -3,43 +3,22 @@ package sheet
 import (
 	"regexp"
 	"strings"
-
-	"github.com/mgutz/ansi"
 )
 
-// Search searches for regexp matches in a cheatsheet's text, and optionally
-// colorizes matching strings.
-func (s *Sheet) Search(reg *regexp.Regexp, colorize bool) []Match {
+// Search returns lines within a sheet's Text that match the search regex
+func (s *Sheet) Search(reg *regexp.Regexp) string {
 
 	// record matches
-	matches := []Match{}
+	matches := ""
 
 	// search through the cheatsheet's text line by line
-	// TODO: searching line-by-line is surely the "naive" approach. Revisit this
-	// later with an eye for performance improvements.
-	for linenum, line := range strings.Split(s.Text, "\n") {
+	for _, line := range strings.Split(s.Text, "\n\n") {
 
 		// exit early if the line doesn't match the regex
-		if !reg.MatchString(line) {
-			continue
+		if reg.MatchString(line) {
+			matches += line + "\n\n"
 		}
-
-		// init the match
-		m := Match{
-			Line: linenum + 1,
-			Text: strings.TrimSpace(line),
-		}
-
-		// colorize the matching text if so configured
-		if colorize {
-			m.Text = reg.ReplaceAllStringFunc(m.Text, func(matched string) string {
-				return ansi.Color(matched, "red+b")
-			})
-		}
-
-		// record the match
-		matches = append(matches, m)
 	}
 
-	return matches
+	return strings.TrimSpace(matches)
 }

internal/sheet/search_test.go

@@ -4,8 +4,6 @@ import (
 	"reflect"
 	"regexp"
 	"testing"
-
-	"github.com/davecgh/go-spew/spew"
 )
 
 // TestSearchNoMatch ensures that the expected output is returned when no
@@ -24,21 +22,21 @@ func TestSearchNoMatch(t *testing.T) {
 	}
 
 	// search the sheet
-	matches := sheet.Search(reg, false)
+	matches := sheet.Search(reg)
 
 	// assert that no matches were found
-	if len(matches) != 0 {
-		t.Errorf("failure: expected no matches: got: %s", spew.Sdump(matches))
+	if matches != "" {
+		t.Errorf("failure: expected no matches: got: %s", matches)
 	}
 }
 
-// TestSearchSingleMatchNoColor asserts that the expected output is returned
-// when a single match is returned, and no colorization is applied.
-func TestSearchSingleMatchNoColor(t *testing.T) {
+// TestSearchSingleMatch asserts that the expected output is returned
+// when a single match is returned
+func TestSearchSingleMatch(t *testing.T) {
 
 	// mock a cheatsheet
 	sheet := Sheet{
-		Text: "The quick brown fox\njumped over\nthe lazy dog.",
+		Text: "The quick brown fox\njumped over\n\nthe lazy dog.",
 	}
 
 	// compile the search regex
@@ -48,69 +46,28 @@ func TestSearchSingleMatchNoColor(t *testing.T) {
 	}
 
 	// search the sheet
-	matches := sheet.Search(reg, false)
+	matches := sheet.Search(reg)
 
 	// specify the expected results
-	want := []Match{
-		Match{
-			Line: 1,
-			Text: "The quick brown fox",
-		},
-	}
+	want := "The quick brown fox\njumped over"
 
 	// assert that the correct matches were returned
-	if !reflect.DeepEqual(matches, want) {
+	if matches != want {
 		t.Errorf(
 			"failed to return expected matches: want:\n%s, got:\n%s",
-			spew.Sdump(want),
-			spew.Sdump(matches),
+			want,
+			matches,
 		)
 	}
 }
 
-// TestSearchSingleMatchColorized asserts that the expected output is returned
-// when a single match is returned, and colorization is applied
-func TestSearchSingleMatchColorized(t *testing.T) {
+// TestSearchMultiMatch asserts that the expected output is returned
+// when a multiple matches are returned
+func TestSearchMultiMatch(t *testing.T) {
 
 	// mock a cheatsheet
 	sheet := Sheet{
-		Text: "The quick brown fox\njumped over\nthe lazy dog.",
-	}
-
-	// compile the search regex
-	reg, err := regexp.Compile("(?i)fox")
-	if err != nil {
-		t.Errorf("failed to compile regex: %v", err)
-	}
-
-	// search the sheet
-	matches := sheet.Search(reg, true)
-
-	// specify the expected results
-	want := []Match{
-		Match{
-			Line: 1,
-			Text: "The quick brown \x1b[1;31mfox\x1b[0m",
-		},
-	}
-
-	// assert that the correct matches were returned
-	if !reflect.DeepEqual(matches, want) {
-		t.Errorf(
-			"failed to return expected matches: want:\n%s, got:\n%s",
-			spew.Sdump(want),
-			spew.Sdump(matches),
-		)
-	}
-}
-
-// TestSearchMultiMatchNoColor asserts that the expected output is returned
-// when a multiple matches are returned, and no colorization is applied
-func TestSearchMultiMatchNoColor(t *testing.T) {
-
-	// mock a cheatsheet
-	sheet := Sheet{
-		Text: "The quick brown fox\njumped over\nthe lazy dog.",
+		Text: "The quick brown fox\n\njumped over\n\nthe lazy dog.",
 	}
 
 	// compile the search regex
@@ -120,66 +77,17 @@ func TestSearchMultiMatchNoColor(t *testing.T) {
 	}
 
 	// search the sheet
-	matches := sheet.Search(reg, false)
+	matches := sheet.Search(reg)
 
 	// specify the expected results
-	want := []Match{
-		Match{
-			Line: 1,
-			Text: "The quick brown fox",
-		},
-		Match{
-			Line: 3,
-			Text: "the lazy dog.",
-		},
-	}
+	want := "The quick brown fox\n\nthe lazy dog."
 
 	// assert that the correct matches were returned
 	if !reflect.DeepEqual(matches, want) {
 		t.Errorf(
 			"failed to return expected matches: want:\n%s, got:\n%s",
-			spew.Sdump(want),
-			spew.Sdump(matches),
-		)
-	}
-}
-
-// TestSearchMultiMatchColorized asserts that the expected output is returned
-// when a multiple matches are returned, and colorization is applied
-func TestSearchMultiMatchColorized(t *testing.T) {
-
-	// mock a cheatsheet
-	sheet := Sheet{
-		Text: "The quick brown fox\njumped over\nthe lazy dog.",
-	}
-
-	// compile the search regex
-	reg, err := regexp.Compile("(?i)the")
-	if err != nil {
-		t.Errorf("failed to compile regex: %v", err)
-	}
-
-	// search the sheet
-	matches := sheet.Search(reg, true)
-
-	// specify the expected results
-	want := []Match{
-		Match{
-			Line: 1,
-			Text: "\x1b[1;31mThe\x1b[0m quick brown fox",
-		},
-		Match{
-			Line: 3,
-			Text: "\x1b[1;31mthe\x1b[0m lazy dog.",
-		},
-	}
-
-	// assert that the correct matches were returned
-	if !reflect.DeepEqual(matches, want) {
-		t.Errorf(
-			"failed to return expected matches: want:\n%s, got:\n%s",
-			spew.Sdump(want),
-			spew.Sdump(matches),
+			want,
+			matches,
 		)
 	}
 }

internal/sheet/sheet.go

@@ -10,17 +10,19 @@ import (
 
 // Sheet encapsulates sheet information
 type Sheet struct {
-	Title    string
-	Path     string
-	Text     string
-	Tags     []string
-	Syntax   string
-	ReadOnly bool
+	Title     string
+	CheatPath string
+	Path      string
+	Text      string
+	Tags      []string
+	Syntax    string
+	ReadOnly  bool
 }
 
 // New initializes a new Sheet
 func New(
 	title string,
+	cheatpath string,
 	path string,
 	tags []string,
 	readOnly bool,
@@ -46,11 +48,12 @@ func New(
 
 	// initialize and return a sheet
 	return Sheet{
-		Title:    title,
-		Path:     path,
-		Text:     text + "\n",
-		Tags:     tags,
-		Syntax:   fm.Syntax,
-		ReadOnly: readOnly,
+		Title:     title,
+		CheatPath: cheatpath,
+		Path:      path,
+		Text:      text + "\n",
+		Tags:      tags,
+		Syntax:    fm.Syntax,
+		ReadOnly:  readOnly,
 	}, nil
 }

internal/sheet/sheet_test.go

@@ -13,6 +13,7 @@ func TestSheetSuccess(t *testing.T) {
 	// initialize a sheet
 	sheet, err := New(
 		"foo",
+		"community",
 		mock.Path("sheet/foo"),
 		[]string{"alpha", "bravo"},
 		false,
@@ -61,6 +62,7 @@ func TestSheetFailure(t *testing.T) {
 	// initialize a sheet
 	_, err := New(
 		"foo",
+		"community",
 		mock.Path("/does-not-exist"),
 		[]string{"alpha", "bravo"},
 		false,
@@ -69,3 +71,20 @@ func TestSheetFailure(t *testing.T) {
 		t.Errorf("failed to return an error on unreadable sheet")
 	}
 }
+
+// TestSheetFrontMatterFailure asserts that an error is returned if the sheet's
+// frontmatter cannot be parsed.
+func TestSheetFrontMatterFailure(t *testing.T) {
+
+	// initialize a sheet
+	_, err := New(
+		"foo",
+		"community",
+		mock.Path("sheet/bad-fm"),
+		[]string{"alpha", "bravo"},
+		false,
+	)
+	if err == nil {
+		t.Errorf("failed to return an error on malformed front-matter")
+	}
+}

internal/sheets/load.go

@@ -33,7 +33,7 @@ func Load(cheatpaths []cp.Cheatpath) ([]map[string]sheet.Sheet, error) {
 
 				// fail if an error occurred while walking the directory
 				if err != nil {
-					return fmt.Errorf("error walking path: %v", err)
+					return fmt.Errorf("failed to walk path: %v", err)
 				}
 
 				// don't register directories as cheatsheets
@@ -59,9 +59,20 @@ func Load(cheatpaths []cp.Cheatpath) ([]map[string]sheet.Sheet, error) {
 				}
 
 				// parse the cheatsheet file into a `sheet` struct
-				s, err := sheet.New(title, path, cheatpath.Tags, cheatpath.ReadOnly)
+				s, err := sheet.New(
+					title,
+					cheatpath.Name,
+					path,
+					cheatpath.Tags,
+					cheatpath.ReadOnly,
+				)
 				if err != nil {
-					return fmt.Errorf("could not create sheet: %v", err)
+					return fmt.Errorf(
+						"failed to load sheet: %s, path: %s, err: %v",
+						title,
+						path,
+						err,
+					)
 				}
 
 				// register the cheatsheet on its cheatpath, keyed by its title

internal/sheets/load_test.go

@@ -1,3 +1,62 @@
 package sheets
 
-// TODO
+import (
+	"path"
+	"testing"
+
+	"github.com/cheat/cheat/internal/cheatpath"
+	"github.com/cheat/cheat/internal/mock"
+)
+
+// TestLoad asserts that sheets on valid cheatpaths can be loaded successfully
+func TestLoad(t *testing.T) {
+
+	// mock cheatpaths
+	cheatpaths := []cheatpath.Cheatpath{
+		{
+			Name:     "community",
+			Path:     path.Join(mock.Path("cheatsheets"), "community"),
+			ReadOnly: true,
+		},
+		{
+			Name:     "personal",
+			Path:     path.Join(mock.Path("cheatsheets"), "personal"),
+			ReadOnly: false,
+		},
+	}
+
+	// load cheatsheets
+	sheets, err := Load(cheatpaths)
+	if err != nil {
+		t.Errorf("failed to load cheatsheets: %v", err)
+	}
+
+	// assert that the correct number of sheets loaded
+	// (sheet load details are tested in `sheet_test.go`)
+	want := 4
+	if len(sheets) != want {
+		t.Errorf(
+			"failed to load correct number of cheatsheets: want: %d, got: %d",
+			want,
+			len(sheets),
+		)
+	}
+}
+
+// TestLoadBadPath asserts that an error is returned if a cheatpath is invalid
+func TestLoadBadPath(t *testing.T) {
+
+	// mock a bad cheatpath
+	cheatpaths := []cheatpath.Cheatpath{
+		{
+			Name:     "badpath",
+			Path:     "/cheat/test/path/does/not/exist",
+			ReadOnly: true,
+		},
+	}
+
+	// attempt to load the cheatpath
+	if _, err := Load(cheatpaths); err == nil {
+		t.Errorf("failed to reject invalid cheatpath")
+	}
+}

internal/sheets/tags_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/cheat/cheat/internal/sheet"
 )
 
-// TestTags asserts that cheetsheet tags are properly returned
+// TestTags asserts that cheatsheet tags are properly returned
 func TestTags(t *testing.T) {
 
 	// mock cheatsheets available on multiple cheatpaths

mocks/cheatsheets/community/bar

@@ -0,0 +1,4 @@
+---
+tags: [ community ]
+---
+This is the bar cheatsheet.

mocks/cheatsheets/community/foo

@@ -0,0 +1,4 @@
+---
+tags: [ community ]
+---
+This is the foo cheatsheet.

mocks/cheatsheets/personal/bat

@@ -0,0 +1,4 @@
+---
+tags: [ personal ]
+---
+This is the bat cheatsheet.

mocks/cheatsheets/personal/baz

@@ -0,0 +1,4 @@
+---
+tags: [ personal ]
+---
+This is the baz cheatsheet.

mocks/sheet/bad-fm

@@ -0,0 +1,4 @@
+---
+syntax: sh
+
+This is malformed frontmatter.

scripts/cheat.zsh

@@ -0,0 +1,65 @@
+#compdef cheat
+
+local cheats taglist pathlist
+
+_cheat_complete_personal_cheatsheets()
+{
+  cheats=("${(f)$(cheat -l -t personal | tail -n +2 | cut -d' ' -f1)}")
+  _describe -t cheats 'cheats' cheats
+}
+
+_cheat_complete_full_cheatsheets()
+{
+  cheats=("${(f)$(cheat -l | tail -n +2 | cut -d' ' -f1)}")
+  _describe -t cheats 'cheats' cheats
+}
+
+_cheat_complete_tags()
+{
+  taglist=("${(f)$(cheat -T)}")
+  _describe -t taglist 'taglist' taglist
+}
+
+_cheat_complete_paths()
+{
+  pathlist=("${(f)$(cheat -d | cut -d':' -f1)}")
+  _describe -t pathlist 'pathlist' pathlist
+}
+
+_cheat() {
+
+  _arguments -C \
+    '(--init)--init[Write a default config file to stdout]: :->none' \
+    '(-c --colorize)'{-c,--colorize}'[Colorize output]: :->none' \
+    '(-d --directories)'{-d,--directories}'[List cheatsheet directories]: :->none' \
+    '(-e --edit)'{-e,--edit}'[Edit <sheet>]: :->personal' \
+    '(-l --list)'{-l,--list}'[List cheatsheets]: :->full' \
+    '(-p --path)'{-p,--path}'[Return only sheets found on path <name>]: :->pathlist' \
+    '(-r --regex)'{-r,--regex}'[Treat search <phrase> as a regex]: :->none' \
+    '(-s --search)'{-s,--search}'[Search cheatsheets for <phrase>]: :->none' \
+    '(-t --tag)'{-t,--tag}'[Return only sheets matching <tag>]: :->taglist' \
+    '(-T --tags)'{-T,--tags}'[List all tags in use]: :->none' \
+    '(-v --version)'{-v,--version}'[Print the version number]: :->none' \
+    '(--rm)--rm[Remove (delete) <sheet>]: :->personal' 
+
+  case $state in
+    (none)
+      ;;
+    (full)
+      _cheat_complete_full_cheatsheets
+      ;;
+    (personal)
+      _cheat_complete_personal_cheatsheets
+      ;;
+    (taglist)
+      _cheat_complete_tags
+      ;;
+    (pathlist)
+      _cheat_complete_paths
+      ;;
+    (*)
+      ;;
+  esac
+}
+
+compdef _cheat cheat

scripts/git/cheatsheets

@@ -0,0 +1,46 @@
+#!/bin/sh -e
+
+pull() {
+  for d in `cheat -d | awk '{print $2}'`;
+  do
+      echo "Update $d"
+      cd "$d"
+      [ -d ".git" ] && git pull || :
+  done
+
+  echo
+  echo "Finished update"
+}
+
+push() {
+  for d in `cheat -d | grep -v "community" | awk '{print $2}'`;
+  do
+      cd "$d"
+      if [ -d ".git" ]
+      then
+          echo "Push modifications $d"
+          files=$(git ls-files -mo | tr '\n' ' ')
+          git add -A && git commit -m "Edited files: $files" && git push || :
+      else
+          echo "$(pwd) is not a git managed folder"
+          echo "First connect this to your personal git repository"
+      fi
+  done
+
+  echo
+  echo "Finished push operation"
+}
+
+
+if [ "$1" = "pull" ]; then
+  pull
+elif [ "$1" = "push" ]; then
+  push
+else
+  echo "Usage:
+  # pull changes
+  cheatsheets pull
+
+  # push changes
+  cheatsheets push"
+fi

vendor/github.com/alecthomas/chroma/.golangci.yml

@@ -20,6 +20,11 @@ linters:
     - wsl
     - gomnd
     - gocognit
+    - goerr113
+    - nolintlint
+    - testpackage
+    - godot
+    - nestif
 
 linters-settings:
   govet:

vendor/github.com/alecthomas/chroma/.goreleaser.yml

@@ -3,28 +3,32 @@ release:
   github:
     owner: alecthomas
     name: chroma
-brew:
-  install: bin.install "chroma"
+brews:
+  -
+    install: bin.install "chroma"
+env:
+  - CGO_ENABLED=0
 builds:
 - goos:
-  - linux
-  - darwin
-  - windows
+    - linux
+    - darwin
+    - windows
   goarch:
-  - amd64
-  - "386"
+    - amd64
+    - "386"
   goarm:
-  - "6"
+    - "6"
   main: ./cmd/chroma/main.go
   ldflags: -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}}
   binary: chroma
-archive:
-  format: tar.gz
-  name_template: '{{ .Binary }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}{{ if .Arm }}v{{
+archives:
+  -
+    format: tar.gz
+    name_template: '{{ .Binary }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}{{ if .Arm }}v{{
     .Arm }}{{ end }}'
-  files:
-  - COPYING
-  - README*
+    files:
+      - COPYING
+      - README*
 snapshot:
   name_template: SNAPSHOT-{{ .Commit }}
 checksum:

vendor/github.com/alecthomas/chroma/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-language: go
-go:
-  - "1.13.x"
-script:
-  - go test -v ./...
-  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s v1.22.2
-  - ./bin/golangci-lint run
-  - git clean -fdx .
-after_success:
-  curl -sL https://git.io/goreleaser | bash && goreleaser
-

vendor/github.com/alecthomas/chroma/Makefile

@@ -1,5 +1,7 @@
 .PHONY: chromad upload all
 
+VERSION ?= $(shell git describe --tags --dirty  --always)
+
 all: README.md tokentype_string.go
 
 README.md: lexers/*/*.go
@@ -9,10 +11,8 @@ tokentype_string.go: types.go
 	go generate
 
 chromad:
-	(cd ./cmd/chromad && go get github.com/GeertJohan/go.rice/rice@master && go install github.com/GeertJohan/go.rice/rice)
 	rm -f chromad
-	(export CGOENABLED=0 GOOS=linux ; cd ./cmd/chromad && go build -o ../../chromad .)
-	rice append -i ./cmd/chromad --exec=./chromad
+	(export CGOENABLED=0 GOOS=linux ; cd ./cmd/chromad && go build -ldflags="-X 'main.version=$(VERSION)'" -o ../../chromad .)
 
 upload: chromad
 	scp chromad root@swapoff.org: && \

vendor/github.com/alecthomas/chroma/README.md

@@ -1,4 +1,4 @@
-# Chroma — A general purpose syntax highlighter in pure Go [![Golang Documentation](https://godoc.org/github.com/alecthomas/chroma?status.svg)](https://godoc.org/github.com/alecthomas/chroma) [![Build Status](https://travis-ci.org/alecthomas/chroma.svg)](https://travis-ci.org/alecthomas/chroma) [![Gitter chat](https://badges.gitter.im/alecthomas.svg)](https://gitter.im/alecthomas/Lobby)
+# Chroma — A general purpose syntax highlighter in pure Go [![Golang Documentation](https://godoc.org/github.com/alecthomas/chroma?status.svg)](https://godoc.org/github.com/alecthomas/chroma) [![CircleCI](https://img.shields.io/circleci/project/github/alecthomas/chroma.svg)](https://circleci.com/gh/alecthomas/chroma) [![Go Report Card](https://goreportcard.com/badge/github.com/alecthomas/chroma)](https://goreportcard.com/report/github.com/alecthomas/chroma) [![Slack chat](https://img.shields.io/static/v1?logo=slack&style=flat&label=slack&color=green&message=gophers)](https://invite.slack.golangbridge.org/)
 
 > **NOTE:** As Chroma has just been released, its API is still in flux. That said, the high-level interface should not change significantly.
 
@@ -36,29 +36,30 @@ translators for Pygments lexers and styles.
 Prefix | Language
 :----: | --------
 A | ABAP, ABNF, ActionScript, ActionScript 3, Ada, Angular2, ANTLR, ApacheConf, APL, AppleScript, Arduino, Awk
-B | Ballerina, Base Makefile, Bash, Batchfile, BlitzBasic, BNF, Brainfuck
-C | C, C#, C++, Cap'n Proto, Cassandra CQL, Ceylon, CFEngine3, cfstatement, ChaiScript, Cheetah, Clojure, CMake, COBOL, CoffeeScript, Common Lisp, Coq, Crystal, CSS, Cython
-D | D, Dart, Diff, Django/Jinja, Docker, DTD
+B | Ballerina, Base Makefile, Bash, Batchfile, BibTeX, BlitzBasic, BNF, Brainfuck
+C | C, C#, C++, Caddyfile, Caddyfile Directives, Cap'n Proto, Cassandra CQL, Ceylon, CFEngine3, cfstatement, ChaiScript, Cheetah, Clojure, CMake, COBOL, CoffeeScript, Common Lisp, Coq, Crystal, CSS, Cython
+D | D, Dart, Diff, Django/Jinja, Docker, DTD, Dylan
 E | EBNF, Elixir, Elm, EmacsLisp, Erlang
 F | Factor, Fish, Forth, Fortran, FSharp
-G | GAS, GDScript, Genshi, Genshi HTML, Genshi Text, GLSL, Gnuplot, Go, Go HTML Template, Go Text Template, GraphQL, Groovy
-H | Handlebars, Haskell, Haxe, HCL, Hexdump, HTML, HTTP, Hy
-I | Idris, INI, Io
+G | GAS, GDScript, Genshi, Genshi HTML, Genshi Text, Gherkin, GLSL, Gnuplot, Go, Go HTML Template, Go Text Template, GraphQL, Groovy
+H | Handlebars, Haskell, Haxe, HCL, Hexdump, HLB, HTML, HTTP, Hy
+I | Idris, Igor, INI, Io
 J | J, Java, JavaScript, JSON, Julia, Jungle
 K | Kotlin
 L | Lighttpd configuration file, LLVM, Lua
 M | Mako, markdown, Mason, Mathematica, Matlab, MiniZinc, MLIR, Modula-2, MonkeyC, MorrowindScript, Myghty, MySQL
 N | NASM, Newspeak, Nginx configuration file, Nim, Nix
 O | Objective-C, OCaml, Octave, OpenSCAD, Org Mode
-P | PacmanConf, Perl, PHP, Pig, PkgConfig, PL/pgSQL, plaintext, PostgreSQL SQL dialect, PostScript, POVRay, PowerShell, Prolog, Protocol Buffer, Puppet, Python, Python 3
+P | PacmanConf, Perl, PHP, PHTML, Pig, PkgConfig, PL/pgSQL, plaintext, Pony, PostgreSQL SQL dialect, PostScript, POVRay, PowerShell, Prolog, PromQL, Protocol Buffer, Puppet, Python, Python 3
 Q | QBasic
-R | R, Racket, Ragel, react, reg, reStructuredText, Rexx, Ruby, Rust
-S | Sass, Scala, Scheme, Scilab, SCSS, Smalltalk, Smarty, SML, Snobol, Solidity, SPARQL, SQL, SquidConf, Swift, SYSTEMD, systemverilog
+R | R, Racket, Ragel, react, ReasonML, reg, reStructuredText, Rexx, Ruby, Rust
+S | SAS, Sass, Scala, Scheme, Scilab, SCSS, Smalltalk, Smarty, Snobol, Solidity, SPARQL, SQL, SquidConf, Standard ML, Stylus, Swift, SYSTEMD, systemverilog
 T | TableGen, TASM, Tcl, Tcsh, Termcap, Terminfo, Terraform, TeX, Thrift, TOML, TradingView, Transact-SQL, Turing, Turtle, Twig, TypeScript, TypoScript, TypoScriptCssData, TypoScriptHtmlData
 V | VB.net, verilog, VHDL, VimL, vue
 W | WDTE
 X | XML, Xorg
-Y | YAML
+Y | YAML, YANG
+Z | Zig
 
 
 _I will attempt to keep this section up to date, but an authoritative list can be
@@ -183,7 +184,7 @@ following constructor options:
 - `ClassPrefix(prefix)` - prefix each generated CSS class.
 - `TabWidth(width)` - Set the rendered tab width, in characters.
 - `WithLineNumbers()` - Render line numbers (style with `LineNumbers`).
-- `LinkableLineNumbers()` - Make the line numbers linkable.
+- `LinkableLineNumbers()` - Make the line numbers linkable and be a link to themselves.
 - `HighlightLines(ranges)` - Highlight lines in these ranges (style with `LineHighlight`).
 - `LineNumbersInTable()` - Use a table for formatting line numbers and code, rather than spans.
 
@@ -215,7 +216,7 @@ python3 ~/Projects/chroma/_tools/pygments2chroma.py \
   && gofmt -s -w ~/Projects/chroma/lexers/*.go
 ```
 
-See notes in [pygments-lexers.go](https://github.com/alecthomas/chroma/blob/master/pygments-lexers.txt)
+See notes in [pygments-lexers.txt](https://github.com/alecthomas/chroma/blob/master/pygments-lexers.txt)
 for a list of lexers, and notes on some of the issues importing them.
 
 <a id="markdown-formatters" name="formatters"></a>

vendor/github.com/alecthomas/chroma/formatters/html/html.go

@@ -22,6 +22,9 @@ func ClassPrefix(prefix string) Option { return func(f *Formatter) { f.prefix =
 // WithClasses emits HTML using CSS classes, rather than inline styles.
 func WithClasses(b bool) Option { return func(f *Formatter) { f.Classes = b } }
 
+// WithAllClasses disables an optimisation that omits redundant CSS classes.
+func WithAllClasses(b bool) Option { return func(f *Formatter) { f.allClasses = b } }
+
 // TabWidth sets the number of characters for a tab. Defaults to 8.
 func TabWidth(width int) Option { return func(f *Formatter) { f.tabWidth = width } }
 
@@ -141,6 +144,7 @@ type Formatter struct {
 	standalone          bool
 	prefix              string
 	Classes             bool // Exported field to detect when classes are being used
+	allClasses          bool
 	preWrapper          PreWrapper
 	tabWidth            int
 	lineNumbers         bool
@@ -188,7 +192,7 @@ func (f *Formatter) writeHTML(w io.Writer, style *chroma.Style, tokens []chroma.
 	wrapInTable := f.lineNumbers && f.lineNumbersInTable
 
 	lines := chroma.SplitTokensIntoLines(tokens)
-	lineDigits := len(fmt.Sprintf("%d", len(lines)))
+	lineDigits := len(fmt.Sprintf("%d", f.baseLineNumber+len(lines)-1))
 	highlightIndex := 0
 
 	if wrapInTable {
@@ -207,7 +211,7 @@ func (f *Formatter) writeHTML(w io.Writer, style *chroma.Style, tokens []chroma.
 				fmt.Fprintf(w, "<span%s>", f.styleAttr(css, chroma.LineHighlight))
 			}
 
-			fmt.Fprintf(w, "<span%s%s>%*d\n</span>", f.styleAttr(css, chroma.LineNumbersTable), f.lineIDAttribute(line), lineDigits, line)
+			fmt.Fprintf(w, "<span%s%s>%s\n</span>", f.styleAttr(css, chroma.LineNumbersTable), f.lineIDAttribute(line), f.lineTitleWithLinkIfNeeded(lineDigits, line))
 
 			if highlight {
 				fmt.Fprintf(w, "</span>")
@@ -233,7 +237,7 @@ func (f *Formatter) writeHTML(w io.Writer, style *chroma.Style, tokens []chroma.
 		}
 
 		if f.lineNumbers && !wrapInTable {
-			fmt.Fprintf(w, "<span%s%s>%*d</span>", f.styleAttr(css, chroma.LineNumbers), f.lineIDAttribute(line), lineDigits, line)
+			fmt.Fprintf(w, "<span%s%s>%s</span>", f.styleAttr(css, chroma.LineNumbers), f.lineIDAttribute(line), f.lineTitleWithLinkIfNeeded(lineDigits, line))
 		}
 
 		for _, token := range tokens {
@@ -268,7 +272,19 @@ func (f *Formatter) lineIDAttribute(line int) string {
 	if !f.linkableLineNumbers {
 		return ""
 	}
-	return fmt.Sprintf(" id=\"%s%d\"", f.lineNumbersIDPrefix, line)
+	return fmt.Sprintf(" id=\"%s\"", f.lineID(line))
+}
+
+func (f *Formatter) lineTitleWithLinkIfNeeded(lineDigits, line int) string {
+	title := fmt.Sprintf("%*d", lineDigits, line)
+	if !f.linkableLineNumbers {
+		return title
+	}
+	return fmt.Sprintf("<a style=\"outline: none; text-decoration:none; color:inherit\" href=\"#%s\">%s</a>", f.lineID(line), title)
+}
+
+func (f *Formatter) lineID(line int) string {
+	return fmt.Sprintf("%s%d", f.lineNumbersIDPrefix, line)
 }
 
 func (f *Formatter) shouldHighlight(highlightIndex, line int) (bool, bool) {
@@ -362,8 +378,12 @@ func (f *Formatter) WriteCSS(w io.Writer, style *chroma.Style) error {
 		if tt == chroma.Background {
 			continue
 		}
+		class := f.class(tt)
+		if class == "" {
+			continue
+		}
 		styles := css[tt]
-		if _, err := fmt.Fprintf(w, "/* %s */ .%schroma .%s { %s }\n", tt, f.prefix, f.class(tt), styles); err != nil {
+		if _, err := fmt.Fprintf(w, "/* %s */ .%schroma .%s { %s }\n", tt, f.prefix, class, styles); err != nil {
 			return err
 		}
 	}
@@ -379,7 +399,7 @@ func (f *Formatter) styleToCSS(style *chroma.Style) map[chroma.TokenType]string
 		if t != chroma.Background {
 			entry = entry.Sub(bg)
 		}
-		if entry.IsZero() {
+		if !f.allClasses && entry.IsZero() {
 			continue
 		}
 		classes[t] = StyleEntryToCSS(entry)

vendor/github.com/alecthomas/chroma/formatters/tty_indexed.go

@@ -17,6 +17,20 @@ var c = chroma.MustParseColour
 
 var ttyTables = map[int]*ttyTable{
 	8: {
+		foreground: map[chroma.Colour]string{
+			c("#000000"): "\033[30m", c("#7f0000"): "\033[31m", c("#007f00"): "\033[32m", c("#7f7fe0"): "\033[33m",
+			c("#00007f"): "\033[34m", c("#7f007f"): "\033[35m", c("#007f7f"): "\033[36m", c("#e5e5e5"): "\033[37m",
+			c("#555555"): "\033[1m\033[30m", c("#ff0000"): "\033[1m\033[31m", c("#00ff00"): "\033[1m\033[32m", c("#ffff00"): "\033[1m\033[33m",
+			c("#0000ff"): "\033[1m\033[34m", c("#ff00ff"): "\033[1m\033[35m", c("#00ffff"): "\033[1m\033[36m", c("#ffffff"): "\033[1m\033[37m",
+		},
+		background: map[chroma.Colour]string{
+			c("#000000"): "\033[40m", c("#7f0000"): "\033[41m", c("#007f00"): "\033[42m", c("#7f7fe0"): "\033[43m",
+			c("#00007f"): "\033[44m", c("#7f007f"): "\033[45m", c("#007f7f"): "\033[46m", c("#e5e5e5"): "\033[47m",
+			c("#555555"): "\033[1m\033[40m", c("#ff0000"): "\033[1m\033[41m", c("#00ff00"): "\033[1m\033[42m", c("#ffff00"): "\033[1m\033[43m",
+			c("#0000ff"): "\033[1m\033[44m", c("#ff00ff"): "\033[1m\033[45m", c("#00ffff"): "\033[1m\033[46m", c("#ffffff"): "\033[1m\033[47m",
+		},
+	},
+	16: {
 		foreground: map[chroma.Colour]string{
 			c("#000000"): "\033[30m", c("#7f0000"): "\033[31m", c("#007f00"): "\033[32m", c("#7f7fe0"): "\033[33m",
 			c("#00007f"): "\033[34m", c("#7f007f"): "\033[35m", c("#007f7f"): "\033[36m", c("#e5e5e5"): "\033[37m",
@@ -227,15 +241,11 @@ type indexedTTYFormatter struct {
 func (c *indexedTTYFormatter) Format(w io.Writer, style *chroma.Style, it chroma.Iterator) (err error) {
 	theme := styleToEscapeSequence(c.table, style)
 	for token := it(); token != chroma.EOF; token = it() {
-		// TODO: Cache token lookups?
 		clr, ok := theme[token.Type]
 		if !ok {
 			clr, ok = theme[token.Type.SubCategory()]
 			if !ok {
 				clr = theme[token.Type.Category()]
-				// if !ok {
-				// 	clr = theme[chroma.InheritStyle]
-				// }
 			}
 		}
 		if clr != "" {
@@ -249,10 +259,22 @@ func (c *indexedTTYFormatter) Format(w io.Writer, style *chroma.Style, it chroma
 	return nil
 }
 
+// TTY is an 8-colour terminal formatter.
+//
+// The Lab colour space is used to map RGB values to the most appropriate index colour.
+var TTY = Register("terminal", &indexedTTYFormatter{ttyTables[8]})
+
 // TTY8 is an 8-colour terminal formatter.
 //
 // The Lab colour space is used to map RGB values to the most appropriate index colour.
-var TTY8 = Register("terminal", &indexedTTYFormatter{ttyTables[8]})
+var TTY8 = Register("terminal8", &indexedTTYFormatter{ttyTables[8]})
+
+// TTY16 is a 16-colour terminal formatter.
+//
+// It uses \033[3xm for normal colours and \033[90Xm for bright colours.
+//
+// The Lab colour space is used to map RGB values to the most appropriate index colour.
+var TTY16 = Register("terminal16", &indexedTTYFormatter{ttyTables[16]})
 
 // TTY256 is a 256-colour terminal formatter.
 //

vendor/github.com/alecthomas/chroma/go.mod

@@ -1,19 +1,18 @@
 module github.com/alecthomas/chroma
 
+go 1.13
+
 require (
 	github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38
 	github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721 // indirect
-	github.com/alecthomas/kong v0.2.1-0.20190708041108-0548c6b1afae
+	github.com/alecthomas/kong v0.2.4
 	github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897 // indirect
 	github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964
-	github.com/dlclark/regexp2 v1.1.6
-	github.com/mattn/go-colorable v0.0.9
-	github.com/mattn/go-isatty v0.0.4
+	github.com/dlclark/regexp2 v1.4.0
+	github.com/mattn/go-colorable v0.1.6
+	github.com/mattn/go-isatty v0.0.12
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/sergi/go-diff v1.0.0 // indirect
 	github.com/stretchr/testify v1.3.0 // indirect
-	golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35 // indirect
+	golang.org/x/sys v0.0.0-20200413165638-669c56c373c4 // indirect
 )
-
-replace github.com/GeertJohan/go.rice => github.com/alecthomas/go.rice v1.0.1-0.20190719113735-961b99d742e7
-
-go 1.13

vendor/github.com/alecthomas/chroma/go.sum

@@ -2,8 +2,8 @@ github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38 h1:smF2tmSOzy2Mm
 github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38/go.mod h1:r7bzyVFMNntcxPZXK3/+KdruV1H5KSlyVY0gc+NgInI=
 github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721 h1:JHZL0hZKJ1VENNfmXvHbgYlbUOvpzYzvy2aZU5gXVeo=
 github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721/go.mod h1:QO9JBoKquHd+jz9nshCh40fOfO+JzsoXy8qTHF68zU0=
-github.com/alecthomas/kong v0.2.1-0.20190708041108-0548c6b1afae h1:C4Q9m+oXOxcSWwYk9XzzafY2xAVAaeubZbUHJkw3PlY=
-github.com/alecthomas/kong v0.2.1-0.20190708041108-0548c6b1afae/go.mod h1:+inYUSluD+p4L8KdviBSgzcqEjUQOfC5fQDRFuc36lI=
+github.com/alecthomas/kong v0.2.4 h1:Y0ZBCHAvHhTHw7FFJ2FzCAAG4pkbTgA45nc7BpMhDNk=
+github.com/alecthomas/kong v0.2.4/go.mod h1:kQOmtJgV+Lb4aj+I2LEn40cbtawdWJ9Y8QLq+lElKxE=
 github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897 h1:p9Sln00KOTlrYkxI1zYWl1QLnEqAqEARBEYa8FQnQcY=
 github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897/go.mod h1:xTS7Pm1pD1mvyM075QCDSRqH6qRLXylzS24ZTpRiSzQ=
 github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964 h1:y5HC9v93H5EPKqaS1UYVg1uYah5Xf51mBfIoWehClUQ=
@@ -11,15 +11,18 @@ github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964/go.mod h1:Xd9
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/dlclark/regexp2 v1.1.6 h1:CqB4MjHw0MFCDj+PHHjiESmHX+N7t0tJzKvC6M97BRg=
-github.com/dlclark/regexp2 v1.1.6/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
-github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
-github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
-github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
-github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
-github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
+github.com/dlclark/regexp2 v1.2.0 h1:8sAhBGEM0dRWogWqWyQeIJnxjWO6oIjl8FKqREDsGfk=
+github.com/dlclark/regexp2 v1.2.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
+github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E=
+github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=
+github.com/mattn/go-colorable v0.1.6 h1:6Su7aK7lXmJ/U79bYtBjLNaha4Fs1Rg9plHpcH+vvnE=
+github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
@@ -29,5 +32,7 @@ github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35 h1:YAFjXN64LMvktoUZH9zgY4lGc/msGN7HQfoSuKCgaDU=
-golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200413165638-669c56c373c4 h1:opSr2sbRXk5X5/givKrrKj9HXxFpW2sdCiP8MJSKLQY=
+golang.org/x/sys v0.0.0-20200413165638-669c56c373c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

vendor/github.com/alecthomas/chroma/iterator.go

@@ -4,7 +4,7 @@ import "strings"
 
 // An Iterator across tokens.
 //
-// nil will be returned at the end of the Token stream.
+// EOF will be returned at the end of the Token stream.
 //
 // If an error occurs within an Iterator, it may propagate this in a panic. Formatters should recover.
 type Iterator func() Token

vendor/github.com/alecthomas/chroma/lexer.go

@@ -6,7 +6,8 @@ import (
 
 var (
 	defaultOptions = &TokeniseOptions{
-		State: "root",
+		State:    "root",
+		EnsureLF: true,
 	}
 )
 
@@ -80,6 +81,10 @@ type TokeniseOptions struct {
 	State string
 	// Nested tokenisation.
 	Nested bool
+
+	// If true, all EOLs are converted into LF
+	// by replacing CRLF and CR
+	EnsureLF bool
 }
 
 // A Lexer for tokenising source code.

vendor/github.com/alecthomas/chroma/lexers/a/abap.go

@@ -6,7 +6,7 @@ import (
 )
 
 // ABAP lexer.
-var Abap = internal.Register(MustNewLexer(
+var Abap = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "ABAP",
 		Aliases:         []string{"abap"},
@@ -14,7 +14,11 @@ var Abap = internal.Register(MustNewLexer(
 		MimeTypes:       []string{"text/x-abap"},
 		CaseInsensitive: true,
 	},
-	Rules{
+	abapRules,
+))
+
+func abapRules() Rules {
+	return Rules{
 		"common": {
 			{`\s+`, Text, nil},
 			{`^\*.*$`, CommentSingle, nil},
@@ -52,5 +56,5 @@ var Abap = internal.Register(MustNewLexer(
 			{`[/;:()\[\],.]`, Punctuation, nil},
 			{`(!)(\w+)`, ByGroups(Operator, Name), nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/abnf.go

@@ -6,14 +6,18 @@ import (
 )
 
 // Abnf lexer.
-var Abnf = internal.Register(MustNewLexer(
+var Abnf = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "ABNF",
 		Aliases:   []string{"abnf"},
 		Filenames: []string{"*.abnf"},
 		MimeTypes: []string{"text/x-abnf"},
 	},
-	Rules{
+	abnfRules,
+))
+
+func abnfRules() Rules {
+	return Rules{
 		"root": {
 			{`;.*$`, CommentSingle, nil},
 			{`(%[si])?"[^"]*"`, Literal, nil},
@@ -34,5 +38,5 @@ var Abnf = internal.Register(MustNewLexer(
 			{`\s+`, Text, nil},
 			{`.`, Text, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/actionscript.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Actionscript lexer.
-var Actionscript = internal.Register(MustNewLexer(
+var Actionscript = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:         "ActionScript",
 		Aliases:      []string{"as", "actionscript"},
@@ -15,7 +15,11 @@ var Actionscript = internal.Register(MustNewLexer(
 		NotMultiline: true,
 		DotAll:       true,
 	},
-	Rules{
+	actionscriptRules,
+))
+
+func actionscriptRules() Rules {
+	return Rules{
 		"root": {
 			{`\s+`, Text, nil},
 			{`//.*?\n`, CommentSingle, nil},
@@ -35,5 +39,5 @@ var Actionscript = internal.Register(MustNewLexer(
 			{`"(\\\\|\\"|[^"])*"`, LiteralStringDouble, nil},
 			{`'(\\\\|\\'|[^'])*'`, LiteralStringSingle, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/actionscript3.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Actionscript 3 lexer.
-var Actionscript3 = internal.Register(MustNewLexer(
+var Actionscript3 = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "ActionScript 3",
 		Aliases:   []string{"as3", "actionscript3"},
@@ -14,7 +14,11 @@ var Actionscript3 = internal.Register(MustNewLexer(
 		MimeTypes: []string{"application/x-actionscript3", "text/x-actionscript3", "text/actionscript3"},
 		DotAll:    true,
 	},
-	Rules{
+	actionscript3Rules,
+))
+
+func actionscript3Rules() Rules {
+	return Rules{
 		"root": {
 			{`\s+`, Text, nil},
 			{`(function\s+)([$a-zA-Z_]\w*)(\s*)(\()`, ByGroups(KeywordDeclaration, NameFunction, Text, Operator), Push("funcparams")},
@@ -52,5 +56,5 @@ var Actionscript3 = internal.Register(MustNewLexer(
 			{`,`, Operator, Pop(1)},
 			Default(Pop(1)),
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/ada.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Ada lexer.
-var Ada = internal.Register(MustNewLexer(
+var Ada = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "Ada",
 		Aliases:         []string{"ada", "ada95", "ada2005"},
@@ -14,7 +14,11 @@ var Ada = internal.Register(MustNewLexer(
 		MimeTypes:       []string{"text/x-ada"},
 		CaseInsensitive: true,
 	},
-	Rules{
+	adaRules,
+))
+
+func adaRules() Rules {
+	return Rules{
 		"root": {
 			{`[^\S\n]+`, Text, nil},
 			{`--.*?\n`, CommentSingle, nil},
@@ -110,5 +114,5 @@ var Ada = internal.Register(MustNewLexer(
 			{`\)`, Punctuation, Pop(1)},
 			Include("root"),
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/al.go

@@ -0,0 +1,48 @@
+package a
+
+import (
+	. "github.com/alecthomas/chroma" // nolint
+	"github.com/alecthomas/chroma/lexers/internal"
+)
+
+// Al lexer.
+var Al = internal.Register(MustNewLazyLexer(
+	&Config{
+		Name:            "AL",
+		Aliases:         []string{"al"},
+		Filenames:       []string{"*.al", "*.dal"},
+		MimeTypes:       []string{"text/x-al"},
+		DotAll:          true,
+		CaseInsensitive: true,
+	},
+	alRules,
+))
+
+// https://github.com/microsoft/AL/blob/master/grammar/alsyntax.tmlanguage
+func alRules() Rules {
+	return Rules{
+		"root": {
+			{`\s+`, TextWhitespace, nil},
+			{`(?s)\/\*.*?\\*\*\/`, CommentMultiline, nil},
+			{`(?s)//.*?\n`, CommentSingle, nil},
+			{`\"([^\"])*\"`, Text, nil},
+			{`'([^'])*'`, LiteralString, nil},
+			{`\b(?i:(ARRAY|ASSERTERROR|BEGIN|BREAK|CASE|DO|DOWNTO|ELSE|END|EVENT|EXIT|FOR|FOREACH|FUNCTION|IF|IMPLEMENTS|IN|INDATASET|INTERFACE|INTERNAL|LOCAL|OF|PROCEDURE|PROGRAM|PROTECTED|REPEAT|RUNONCLIENT|SECURITYFILTERING|SUPPRESSDISPOSE|TEMPORARY|THEN|TO|TRIGGER|UNTIL|VAR|WHILE|WITH|WITHEVENTS))\b`, Keyword, nil},
+			{`\b(?i:(AND|DIV|MOD|NOT|OR|XOR))\b`, OperatorWord, nil},
+			{`\b(?i:(AVERAGE|CONST|COUNT|EXIST|FIELD|FILTER|LOOKUP|MAX|MIN|ORDER|SORTING|SUM|TABLEDATA|UPPERLIMIT|WHERE|ASCENDING|DESCENDING))\b`, Keyword, nil},
+			// Added new objects types of BC 2021 wave 1 (REPORTEXTENSION|Entitlement|PermissionSet|PermissionSetExtension)
+			{`\b(?i:(CODEUNIT|PAGE|PAGEEXTENSION|PAGECUSTOMIZATION|DOTNET|ENUM|ENUMEXTENSION|VALUE|QUERY|REPORT|TABLE|TABLEEXTENSION|XMLPORT|PROFILE|CONTROLADDIN|REPORTEXTENSION|Entitlement|PermissionSet|PermissionSetExtension))\b`, Keyword, nil},
+			{`\b(?i:(Action|Array|Automation|BigInteger|BigText|Blob|Boolean|Byte|Char|ClientType|Code|Codeunit|CompletionTriggerErrorLevel|ConnectionType|Database|DataClassification|DataScope|Date|DateFormula|DateTime|Decimal|DefaultLayout|Dialog|Dictionary|DotNet|DotNetAssembly|DotNetTypeDeclaration|Duration|Enum|ErrorInfo|ErrorType|ExecutionContext|ExecutionMode|FieldClass|FieldRef|FieldType|File|FilterPageBuilder|Guid|InStream|Integer|Joker|KeyRef|List|ModuleDependencyInfo|ModuleInfo|None|Notification|NotificationScope|ObjectType|Option|OutStream|Page|PageResult|Query|Record|RecordId|RecordRef|Report|ReportFormat|SecurityFilter|SecurityFiltering|Table|TableConnectionType|TableFilter|TestAction|TestField|TestFilterField|TestPage|TestPermissions|TestRequestPage|Text|TextBuilder|TextConst|TextEncoding|Time|TransactionModel|TransactionType|Variant|Verbosity|Version|XmlPort|HttpContent|HttpHeaders|HttpClient|HttpRequestMessage|HttpResponseMessage|JsonToken|JsonValue|JsonArray|JsonObject|View|Views|XmlAttribute|XmlAttributeCollection|XmlComment|XmlCData|XmlDeclaration|XmlDocument|XmlDocumentType|XmlElement|XmlNamespaceManager|XmlNameTable|XmlNode|XmlNodeList|XmlProcessingInstruction|XmlReadOptions|XmlText|XmlWriteOptions|WebServiceActionContext|WebServiceActionResultCode|SessionSettings))\b`, Keyword, nil},
+			{`\b([<>]=|<>|<|>)\b?`, Operator, nil},
+			{`\b(\-|\+|\/|\*)\b`, Operator, nil},
+			{`\s*(\:=|\+=|-=|\/=|\*=)\s*?`, Operator, nil},
+			{`\b(?i:(ADDFIRST|ADDLAST|ADDAFTER|ADDBEFORE|ACTION|ACTIONS|AREA|ASSEMBLY|CHARTPART|CUEGROUP|CUSTOMIZES|COLUMN|DATAITEM|DATASET|ELEMENTS|EXTENDS|FIELD|FIELDGROUP|FIELDATTRIBUTE|FIELDELEMENT|FIELDGROUPS|FIELDS|FILTER|FIXED|GRID|GROUP|MOVEAFTER|MOVEBEFORE|KEY|KEYS|LABEL|LABELS|LAYOUT|MODIFY|MOVEFIRST|MOVELAST|MOVEBEFORE|MOVEAFTER|PART|REPEATER|USERCONTROL|REQUESTPAGE|SCHEMA|SEPARATOR|SYSTEMPART|TABLEELEMENT|TEXTATTRIBUTE|TEXTELEMENT|TYPE))\b`, Keyword, nil},
+			{`\s*[(\.\.)&\|]\s*`, Operator, nil},
+			{`\b((0(x|X)[0-9a-fA-F]*)|(([0-9]+\.?[0-9]*)|(\.[0-9]+))((e|E)(\+|-)?[0-9]+)?)(L|l|UL|ul|u|U|F|f|ll|LL|ull|ULL)?\b`, LiteralNumber, nil},
+			{`[;:,]`, Punctuation, nil},
+			{`#[ \t]*(if|else|elif|endif|define|undef|region|endregion|pragma)\b.*?\n`, CommentPreproc, nil},
+			{`\w+`, Text, nil},
+			{`.`, Text, nil},
+		},
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/angular2.go

@@ -6,14 +6,18 @@ import (
 )
 
 // Angular2 lexer.
-var Angular2 = internal.Register(MustNewLexer(
+var Angular2 = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Angular2",
 		Aliases:   []string{"ng2"},
 		Filenames: []string{},
 		MimeTypes: []string{},
 	},
-	Rules{
+	angular2Rules,
+))
+
+func angular2Rules() Rules {
+	return Rules{
 		"root": {
 			{`[^{([*#]+`, Other, nil},
 			{`(\{\{)(\s*)`, ByGroups(CommentPreproc, Text), Push("ngExpression")},
@@ -38,5 +42,5 @@ var Angular2 = internal.Register(MustNewLexer(
 			{`'.*?'`, LiteralString, Pop(1)},
 			{`[^\s>]+`, LiteralString, Pop(1)},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/antlr.go

@@ -6,14 +6,18 @@ import (
 )
 
 // ANTLR lexer.
-var ANTLR = internal.Register(MustNewLexer(
+var ANTLR = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "ANTLR",
 		Aliases:   []string{"antlr"},
 		Filenames: []string{},
 		MimeTypes: []string{},
 	},
-	Rules{
+	antlrRules,
+))
+
+func antlrRules() Rules {
+	return Rules{
 		"whitespace": {
 			{`\s+`, TextWhitespace, nil},
 		},
@@ -97,5 +101,5 @@ var ANTLR = internal.Register(MustNewLexer(
 			{`(\$[a-zA-Z]+)(\.?)(text|value)?`, ByGroups(NameVariable, Punctuation, NameProperty), nil},
 			{`(\\\\|\\\]|\\\[|[^\[\]])+`, Other, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/apache.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Apacheconf lexer.
-var Apacheconf = internal.Register(MustNewLexer(
+var Apacheconf = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "ApacheConf",
 		Aliases:         []string{"apacheconf", "aconf", "apache"},
@@ -14,7 +14,11 @@ var Apacheconf = internal.Register(MustNewLexer(
 		MimeTypes:       []string{"text/x-apacheconf"},
 		CaseInsensitive: true,
 	},
-	Rules{
+	apacheconfRules,
+))
+
+func apacheconfRules() Rules {
+	return Rules{
 		"root": {
 			{`\s+`, Text, nil},
 			{`(#.*?)$`, Comment, nil},
@@ -34,5 +38,5 @@ var Apacheconf = internal.Register(MustNewLexer(
 			{`"([^"\\]*(?:\\.[^"\\]*)*)"`, LiteralStringDouble, nil},
 			{`[^\s"\\]+`, Text, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/apl.go

@@ -6,14 +6,18 @@ import (
 )
 
 // Apl lexer.
-var Apl = internal.Register(MustNewLexer(
+var Apl = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "APL",
 		Aliases:   []string{"apl"},
 		Filenames: []string{"*.apl"},
 		MimeTypes: []string{},
 	},
-	Rules{
+	aplRules,
+))
+
+func aplRules() Rules {
+	return Rules{
 		"root": {
 			{`\s+`, Text, nil},
 			{`[⍝#].*$`, CommentSingle, nil},
@@ -32,5 +36,5 @@ var Apl = internal.Register(MustNewLexer(
 			{`[⍺⍵⍶⍹∇:]`, NameBuiltinPseudo, nil},
 			{`[{}]`, KeywordType, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/applescript.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Applescript lexer.
-var Applescript = internal.Register(MustNewLexer(
+var Applescript = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "AppleScript",
 		Aliases:   []string{"applescript"},
@@ -14,7 +14,11 @@ var Applescript = internal.Register(MustNewLexer(
 		MimeTypes: []string{},
 		DotAll:    true,
 	},
-	Rules{
+	applescriptRules,
+))
+
+func applescriptRules() Rules {
+	return Rules{
 		"root": {
 			{`\s+`, Text, nil},
 			{`¬\n`, LiteralStringEscape, nil},
@@ -51,5 +55,5 @@ var Applescript = internal.Register(MustNewLexer(
 			{`[^*(]+`, CommentMultiline, nil},
 			{`[*(]`, CommentMultiline, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/arduino.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Arduino lexer.
-var Arduino = internal.Register(MustNewLexer(
+var Arduino = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Arduino",
 		Aliases:   []string{"arduino"},
@@ -14,7 +14,11 @@ var Arduino = internal.Register(MustNewLexer(
 		MimeTypes: []string{"text/x-arduino"},
 		EnsureNL:  true,
 	},
-	Rules{
+	arduinoRules,
+))
+
+func arduinoRules() Rules {
+	return Rules{
 		"statements": {
 			{Words(``, `\b`, `catch`, `const_cast`, `delete`, `dynamic_cast`, `explicit`, `export`, `friend`, `mutable`, `namespace`, `new`, `operator`, `private`, `protected`, `public`, `reinterpret_cast`, `restrict`, `static_cast`, `template`, `this`, `throw`, `throws`, `try`, `typeid`, `typename`, `using`, `virtual`, `constexpr`, `nullptr`, `decltype`, `thread_local`, `alignas`, `alignof`, `static_assert`, `noexcept`, `override`, `final`), Keyword, nil},
 			{`char(16_t|32_t)\b`, KeywordType, nil},
@@ -106,5 +110,5 @@ var Arduino = internal.Register(MustNewLexer(
 			{`^\s*#endif.*?(?<!\\)\n`, CommentPreproc, Pop(1)},
 			{`.*?\n`, Comment, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/a/awk.go

@@ -6,14 +6,18 @@ import (
 )
 
 // Awk lexer.
-var Awk = internal.Register(MustNewLexer(
+var Awk = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Awk",
 		Aliases:   []string{"awk", "gawk", "mawk", "nawk"},
 		Filenames: []string{"*.awk"},
 		MimeTypes: []string{"application/x-awk"},
 	},
-	Rules{
+	awkRules,
+))
+
+func awkRules() Rules {
+	return Rules{
 		"commentsandwhitespace": {
 			{`\s+`, Text, nil},
 			{`#.*$`, CommentSingle, nil},
@@ -30,19 +34,19 @@ var Awk = internal.Register(MustNewLexer(
 		"root": {
 			{`^(?=\s|/)`, Text, Push("slashstartsregex")},
 			Include("commentsandwhitespace"),
-			{`\+\+|--|\|\||&&|in\b|\$|!?~|(\*\*|[-<>+*%\^/!=|])=?`, Operator, Push("slashstartsregex")},
+			{`\+\+|--|\|\||&&|in\b|\$|!?~|\|&|(\*\*|[-<>+*%\^/!=|])=?`, Operator, Push("slashstartsregex")},
 			{`[{(\[;,]`, Punctuation, Push("slashstartsregex")},
 			{`[})\].]`, Punctuation, nil},
-			{`(break|continue|do|while|exit|for|if|else|return)\b`, Keyword, Push("slashstartsregex")},
+			{`(break|continue|do|while|exit|for|if|else|return|switch|case|default)\b`, Keyword, Push("slashstartsregex")},
 			{`function\b`, KeywordDeclaration, Push("slashstartsregex")},
-			{`(atan2|cos|exp|int|log|rand|sin|sqrt|srand|gensub|gsub|index|length|match|split|sprintf|sub|substr|tolower|toupper|close|fflush|getline|next|nextfile|print|printf|strftime|systime|delete|system)\b`, KeywordReserved, nil},
-			{`(ARGC|ARGIND|ARGV|BEGIN|CONVFMT|ENVIRON|END|ERRNO|FIELDWIDTHS|FILENAME|FNR|FS|IGNORECASE|NF|NR|OFMT|OFS|ORFS|RLENGTH|RS|RSTART|RT|SUBSEP)\b`, NameBuiltin, nil},
-			{`[$a-zA-Z_]\w*`, NameOther, nil},
+			{`(atan2|cos|exp|int|log|rand|sin|sqrt|srand|gensub|gsub|index|length|match|split|patsplit|sprintf|sub|substr|tolower|toupper|close|fflush|getline|next(file)|print|printf|strftime|systime|mktime|delete|system|strtonum|and|compl|lshift|or|rshift|asorti?|isarray|bindtextdomain|dcn?gettext|@(include|load|namespace))\b`, KeywordReserved, nil},
+			{`(ARGC|ARGIND|ARGV|BEGIN(FILE)?|BINMODE|CONVFMT|ENVIRON|END(FILE)?|ERRNO|FIELDWIDTHS|FILENAME|FNR|FPAT|FS|IGNORECASE|LINT|NF|NR|OFMT|OFS|ORS|PROCINFO|RLENGTH|RS|RSTART|RT|SUBSEP|TEXTDOMAIN)\b`, NameBuiltin, nil},
+			{`[@$a-zA-Z_]\w*`, NameOther, nil},
 			{`[0-9][0-9]*\.[0-9]+([eE][0-9]+)?[fd]?`, LiteralNumberFloat, nil},
 			{`0x[0-9a-fA-F]+`, LiteralNumberHex, nil},
 			{`[0-9]+`, LiteralNumberInteger, nil},
 			{`"(\\\\|\\"|[^"])*"`, LiteralStringDouble, nil},
 			{`'(\\\\|\\'|[^'])*'`, LiteralStringSingle, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/ballerina.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Ballerina lexer.
-var Ballerina = internal.Register(MustNewLexer(
+var Ballerina = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Ballerina",
 		Aliases:   []string{"ballerina"},
@@ -14,7 +14,11 @@ var Ballerina = internal.Register(MustNewLexer(
 		MimeTypes: []string{"text/x-ballerina"},
 		DotAll:    true,
 	},
-	Rules{
+	ballerinaRules,
+))
+
+func ballerinaRules() Rules {
+	return Rules{
 		"root": {
 			{`[^\S\n]+`, Text, nil},
 			{`//.*?\n`, CommentSingle, nil},
@@ -42,5 +46,5 @@ var Ballerina = internal.Register(MustNewLexer(
 		"import": {
 			{`[\w.]+`, NameNamespace, Pop(1)},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/bash.go

@@ -7,17 +7,27 @@ import (
 	"github.com/alecthomas/chroma/lexers/internal"
 )
 
+// TODO(moorereason): can this be factored away?
 var bashAnalyserRe = regexp.MustCompile(`(?m)^#!.*/bin/(?:env |)(?:bash|zsh|sh|ksh)`)
 
 // Bash lexer.
-var Bash = internal.Register(MustNewLexer(
+var Bash = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Bash",
 		Aliases:   []string{"bash", "sh", "ksh", "zsh", "shell"},
-		Filenames: []string{"*.sh", "*.ksh", "*.bash", "*.ebuild", "*.eclass", "*.exheres-0", "*.exlib", "*.zsh", "*.zshrc", ".bashrc", "bashrc", ".bash_*", "bash_*", "zshrc", ".zshrc", "PKGBUILD"},
+		Filenames: []string{"*.sh", "*.ksh", "*.bash", "*.ebuild", "*.eclass", ".env", "*.env", "*.exheres-0", "*.exlib", "*.zsh", "*.zshrc", ".bashrc", "bashrc", ".bash_*", "bash_*", "zshrc", ".zshrc", "PKGBUILD"},
 		MimeTypes: []string{"application/x-sh", "application/x-shellscript"},
 	},
-	Rules{
+	bashRules,
+).SetAnalyser(func(text string) float32 {
+	if bashAnalyserRe.FindString(text) != "" {
+		return 1.0
+	}
+	return 0.0
+}))
+
+func bashRules() Rules {
+	return Rules{
 		"root": {
 			Include("basic"),
 			{"`", LiteralStringBacktick, Push("backticks")},
@@ -36,7 +46,7 @@ var Bash = internal.Register(MustNewLexer(
 			{`\b(if|fi|else|while|do|done|for|then|return|function|case|select|continue|until|esac|elif)(\s*)\b`, ByGroups(Keyword, Text), nil},
 			{"\\b(alias|bg|bind|break|builtin|caller|cd|command|compgen|complete|declare|dirs|disown|echo|enable|eval|exec|exit|export|false|fc|fg|getopts|hash|help|history|jobs|kill|let|local|logout|popd|printf|pushd|pwd|read|readonly|set|shift|shopt|source|suspend|test|time|times|trap|true|type|typeset|ulimit|umask|unalias|unset|wait)(?=[\\s)`])", NameBuiltin, nil},
 			{`\A#!.+\n`, CommentPreproc, nil},
-			{`#.*\S`, CommentSingle, nil},
+			{`#.*(\S|$)`, CommentSingle, nil},
 			{`\\[\w\W]`, LiteralStringEscape, nil},
 			{`(\b\w+)(\s*)(\+?=)`, ByGroups(NameVariable, Text, Operator), nil},
 			{`[\[\]{}()=]`, Operator, nil},
@@ -86,10 +96,5 @@ var Bash = internal.Register(MustNewLexer(
 			{"`", LiteralStringBacktick, Pop(1)},
 			Include("root"),
 		},
-	},
-).SetAnalyser(func(text string) float32 {
-	if bashAnalyserRe.FindString(text) != "" {
-		return 1.0
 	}
-	return 0.0
-}))
+}

vendor/github.com/alecthomas/chroma/lexers/b/batch.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Batchfile lexer.
-var Batchfile = internal.Register(MustNewLexer(
+var Batchfile = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "Batchfile",
 		Aliases:         []string{"bat", "batch", "dosbatch", "winbatch"},
@@ -14,7 +14,11 @@ var Batchfile = internal.Register(MustNewLexer(
 		MimeTypes:       []string{"application/x-dos-batch"},
 		CaseInsensitive: true,
 	},
-	Rules{
+	batchfileRules,
+))
+
+func batchfileRules() Rules {
+	return Rules{
 		"root": {
 			{`\)((?=\()|(?=\^?[\t\v\f\r ,;=\xa0]|[&<>|\n\x1a]))(?:(?:[^\n\x1a^]|\^[\n\x1a]?[\w\W])*)`, CommentSingle, nil},
 			{`(?=((?:(?<=^[^:])|^[^:]?)[\t\v\f\r ,;=\xa0]*)(:))`, Text, Push("follow")},
@@ -190,5 +194,5 @@ var Batchfile = internal.Register(MustNewLexer(
 			{`else(?=\^?[\t\v\f\r ,;=\xa0]|[&<>|\n\x1a])`, Keyword, Pop(1)},
 			Default(Pop(1)),
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/bibtex.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Bibtex lexer.
-var Bibtex = internal.Register(MustNewLexer(
+var Bibtex = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "BibTeX",
 		Aliases:         []string{"bib", "bibtex"},
@@ -15,7 +15,11 @@ var Bibtex = internal.Register(MustNewLexer(
 		NotMultiline:    true,
 		CaseInsensitive: true,
 	},
-	Rules{
+	bibtexRules,
+))
+
+func bibtexRules() Rules {
+	return Rules{
 		"root": {
 			Include("whitespace"),
 			{`@comment`, Comment, nil},
@@ -72,5 +76,5 @@ var Bibtex = internal.Register(MustNewLexer(
 		"whitespace": {
 			{`\s+`, Text, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/blitz.go

@@ -6,7 +6,7 @@ import (
 )
 
 // Blitzbasic lexer.
-var Blitzbasic = internal.Register(MustNewLexer(
+var Blitzbasic = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:            "BlitzBasic",
 		Aliases:         []string{"blitzbasic", "b3d", "bplus"},
@@ -14,7 +14,11 @@ var Blitzbasic = internal.Register(MustNewLexer(
 		MimeTypes:       []string{"text/x-bb"},
 		CaseInsensitive: true,
 	},
-	Rules{
+	blitzbasicRules,
+))
+
+func blitzbasicRules() Rules {
+	return Rules{
 		"root": {
 			{`[ \t]+`, Text, nil},
 			{`;.*?\n`, CommentSingle, nil},
@@ -44,5 +48,5 @@ var Blitzbasic = internal.Register(MustNewLexer(
 			{`"C?`, LiteralStringDouble, Pop(1)},
 			{`[^"]+`, LiteralStringDouble, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/bnf.go

@@ -6,19 +6,23 @@ import (
 )
 
 // Bnf lexer.
-var Bnf = internal.Register(MustNewLexer(
+var Bnf = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "BNF",
 		Aliases:   []string{"bnf"},
 		Filenames: []string{"*.bnf"},
 		MimeTypes: []string{"text/x-bnf"},
 	},
-	Rules{
+	bnfRules,
+))
+
+func bnfRules() Rules {
+	return Rules{
 		"root": {
 			{`(<)([ -;=?-~]+)(>)`, ByGroups(Punctuation, NameClass, Punctuation), nil},
 			{`::=`, Operator, nil},
 			{`[^<>:]+`, Text, nil},
 			{`.`, Text, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/b/brainfuck.go

@@ -6,14 +6,18 @@ import (
 )
 
 // Brainfuck lexer.
-var Brainfuck = internal.Register(MustNewLexer(
+var Brainfuck = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "Brainfuck",
 		Aliases:   []string{"brainfuck", "bf"},
 		Filenames: []string{"*.bf", "*.b"},
 		MimeTypes: []string{"application/x-brainfuck"},
 	},
-	Rules{
+	brainfuckRules,
+))
+
+func brainfuckRules() Rules {
+	return Rules{
 		"common": {
 			{`[.,]+`, NameTag, nil},
 			{`[+-]+`, NameBuiltin, nil},
@@ -30,5 +34,5 @@ var Brainfuck = internal.Register(MustNewLexer(
 			{`\]`, Keyword, Pop(1)},
 			Include("common"),
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/c/c.go

@@ -6,14 +6,19 @@ import (
 )
 
 // C lexer.
-var C = internal.Register(MustNewLexer(
+var C = internal.Register(MustNewLazyLexer(
 	&Config{
 		Name:      "C",
 		Aliases:   []string{"c"},
 		Filenames: []string{"*.c", "*.h", "*.idc"},
 		MimeTypes: []string{"text/x-chdr", "text/x-csrc"},
+		EnsureNL:  true,
 	},
-	Rules{
+	cRules,
+))
+
+func cRules() Rules {
+	return Rules{
 		"whitespace": {
 			{`^#if\s+0`, CommentPreproc, Push("if0")},
 			{`^#`, CommentPreproc, Push("macro")},
@@ -87,5 +92,5 @@ var C = internal.Register(MustNewLexer(
 			{`^\s*#endif.*?(?<!\\)\n`, CommentPreproc, Pop(1)},
 			{`.*?\n`, Comment, nil},
 		},
-	},
-))
+	}
+}

vendor/github.com/alecthomas/chroma/lexers/c/caddyfile.go

@@ -0,0 +1,216 @@
+package c
+
+import (
+	. "github.com/alecthomas/chroma" // nolint
+	"github.com/alecthomas/chroma/lexers/internal"
+)
+
+// caddyfileCommon are the rules common to both of the lexer variants
+func caddyfileCommonRules() Rules {
+	return Rules{
+		"site_block_common": {
+			// Import keyword
+			{`(import)(\s+)([^\s]+)`, ByGroups(Keyword, Text, NameVariableMagic), nil},
+			// Matcher definition
+			{`@[^\s]+(?=\s)`, NameDecorator, Push("matcher")},
+			// Matcher token stub for docs
+			{`\[\<matcher\>\]`, NameDecorator, Push("matcher")},
+			// These cannot have matchers but may have things that look like
+			// matchers in their arguments, so we just parse as a subdirective.
+			{`try_files`, Keyword, Push("subdirective")},
+			// These are special, they can nest more directives
+			{`handle_errors|handle|route|handle_path|not`, Keyword, Push("nested_directive")},
+			// Any other directive
+			{`[^\s#]+`, Keyword, Push("directive")},
+			Include("base"),
+		},
+		"matcher": {
+			{`\{`, Punctuation, Push("block")},
+			// Not can be one-liner
+			{`not`, Keyword, Push("deep_not_matcher")},
+			// Any other same-line matcher
+			{`[^\s#]+`, Keyword, Push("arguments")},
+			// Terminators
+			{`\n`, Text, Pop(1)},
+			{`\}`, Punctuation, Pop(1)},
+			Include("base"),
+		},
+		"block": {
+			{`\}`, Punctuation, Pop(2)},
+			// Not can be one-liner
+			{`not`, Keyword, Push("not_matcher")},
+			// Any other subdirective
+			{`[^\s#]+`, Keyword, Push("subdirective")},
+			Include("base"),
+		},
+		"nested_block": {
+			{`\}`, Punctuation, Pop(2)},
+			// Matcher definition
+			{`@[^\s]+(?=\s)`, NameDecorator, Push("matcher")},
+			// Something that starts with literally < is probably a docs stub
+			{`\<[^#]+\>`, Keyword, Push("nested_directive")},
+			// Any other directive
+			{`[^\s#]+`, Keyword, Push("nested_directive")},
+			Include("base"),
+		},
+		"not_matcher": {
+			{`\}`, Punctuation, Pop(2)},
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			{`[^\s#]+`, Keyword, Push("arguments")},
+			{`\s+`, Text, nil},
+		},
+		"deep_not_matcher": {
+			{`\}`, Punctuation, Pop(2)},
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			{`[^\s#]+`, Keyword, Push("deep_subdirective")},
+			{`\s+`, Text, nil},
+		},
+		"directive": {
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			Include("matcher_token"),
+			Include("comments_pop_1"),
+			{`\n`, Text, Pop(1)},
+			Include("base"),
+		},
+		"nested_directive": {
+			{`\{(?=\s)`, Punctuation, Push("nested_block")},
+			Include("matcher_token"),
+			Include("comments_pop_1"),
+			{`\n`, Text, Pop(1)},
+			Include("base"),
+		},
+		"subdirective": {
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			Include("comments_pop_1"),
+			{`\n`, Text, Pop(1)},
+			Include("base"),
+		},
+		"arguments": {
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			Include("comments_pop_2"),
+			{`\\\n`, Text, nil}, // Skip escaped newlines
+			{`\n`, Text, Pop(2)},
+			Include("base"),
+		},
+		"deep_subdirective": {
+			{`\{(?=\s)`, Punctuation, Push("block")},
+			Include("comments_pop_3"),
+			{`\n`, Text, Pop(3)},
+			Include("base"),
+		},
+		"matcher_token": {
+			{`@[^\s]+`, NameDecorator, Push("arguments")},         // Named matcher
+			{`/[^\s]+`, NameDecorator, Push("arguments")},         // Path matcher
+			{`\*`, NameDecorator, Push("arguments")},              // Wildcard path matcher
+			{`\[\<matcher\>\]`, NameDecorator, Push("arguments")}, // Matcher token stub for docs
+		},
+		"comments": {
+			{`^#.*\n`, CommentSingle, nil},   // Comment at start of line
+			{`\s+#.*\n`, CommentSingle, nil}, // Comment preceded by whitespace
+		},
+		"comments_pop_1": {
+			{`^#.*\n`, CommentSingle, Pop(1)},   // Comment at start of line
+			{`\s+#.*\n`, CommentSingle, Pop(1)}, // Comment preceded by whitespace
+		},
+		"comments_pop_2": {
+			{`^#.*\n`, CommentSingle, Pop(2)},   // Comment at start of line
+			{`\s+#.*\n`, CommentSingle, Pop(2)}, // Comment preceded by whitespace
+		},
+		"comments_pop_3": {
+			{`^#.*\n`, CommentSingle, Pop(3)},   // Comment at start of line
+			{`\s+#.*\n`, CommentSingle, Pop(3)}, // Comment preceded by whitespace
+		},
+		"base": {
+			Include("comments"),
+			{`(on|off|first|last|before|after|internal|strip_prefix|strip_suffix|replace)\b`, NameConstant, nil},
+			{`(https?://)?([a-z0-9.-]+)(:)([0-9]+)`, ByGroups(Name, Name, Punctuation, LiteralNumberInteger), nil},
+			{`[a-z-]+/[a-z-+]+`, LiteralString, nil},
+			{`[0-9]+[km]?\b`, LiteralNumberInteger, nil},
+			{`\{[\w+.\$-]+\}`, LiteralStringEscape, nil}, // Placeholder
+			{`\[(?=[^#{}$]+\])`, Punctuation, nil},
+			{`\]|\|`, Punctuation, nil},
+			{`[^\s#{}$\]]+`, LiteralString, nil},
+			{`/[^\s#]*`, Name, nil},
+			{`\s+`, Text, nil},
+		},
+	}
+}
+
+// Caddyfile lexer.
+var Caddyfile = internal.Register(MustNewLazyLexer(
+	&Config{
+		Name:      "Caddyfile",
+		Aliases:   []string{"caddyfile", "caddy"},
+		Filenames: []string{"Caddyfile*"},
+		MimeTypes: []string{},
+	},
+	caddyfileRules,
+))
+
+func caddyfileRules() Rules {
+	return Rules{
+		"root": {
+			Include("comments"),
+			// Global options block
+			{`^\s*(\{)\s*$`, ByGroups(Punctuation), Push("globals")},
+			// Snippets
+			{`(\([^\s#]+\))(\s*)(\{)`, ByGroups(NameVariableAnonymous, Text, Punctuation), Push("snippet")},
+			// Site label
+			{`[^#{(\s,]+`, GenericHeading, Push("label")},
+			// Site label with placeholder
+			{`\{[\w+.\$-]+\}`, LiteralStringEscape, Push("label")},
+			{`\s+`, Text, nil},
+		},
+		"globals": {
+			{`\}`, Punctuation, Pop(1)},
+			{`[^\s#]+`, Keyword, Push("directive")},
+			Include("base"),
+		},
+		"snippet": {
+			{`\}`, Punctuation, Pop(1)},
+			// Matcher definition
+			{`@[^\s]+(?=\s)`, NameDecorator, Push("matcher")},
+			// Any directive
+			{`[^\s#]+`, Keyword, Push("directive")},
+			Include("base"),
+		},
+		"label": {
+			// Allow multiple labels, comma separated, newlines after
+			// a comma means another label is coming
+			{`,\s*\n?`, Text, nil},
+			{` `, Text, nil},
+			// Site label with placeholder
+			{`\{[\w+.\$-]+\}`, LiteralStringEscape, nil},
+			// Site label
+			{`[^#{(\s,]+`, GenericHeading, nil},
+			// Comment after non-block label (hack because comments end in \n)
+			{`#.*\n`, CommentSingle, Push("site_block")},
+			// Note: if \n, we'll never pop out of the site_block, it's valid
+			{`\{(?=\s)|\n`, Punctuation, Push("site_block")},
+		},
+		"site_block": {
+			{`\}`, Punctuation, Pop(2)},
+			Include("site_block_common"),
+		},
+	}.Merge(caddyfileCommonRules())
+}
+
+// Caddyfile directive-only lexer.
+var CaddyfileDirectives = internal.Register(MustNewLazyLexer(
+	&Config{
+		Name:      "Caddyfile Directives",
+		Aliases:   []string{"caddyfile-directives", "caddyfile-d", "caddy-d"},
+		Filenames: []string{},
+		MimeTypes: []string{},
+	},
+	caddyfileDirectivesRules,
+))
+
+func caddyfileDirectivesRules() Rules {
+	return Rules{
+		// Same as "site_block" in Caddyfile
+		"root": {
+			Include("site_block_common"),
+		},
+	}.Merge(caddyfileCommonRules())
+}