cheat/vendor/github.com/alecthomas/chroma/lexers
Chris Allen Lane 91f0d02de2
v3.3.0 (#525)
* feat: directory-scoped cheatpaths

`cheat` now searches for a `.cheat` directory in the current working
directory. If found, that directory is (temporarily) appended to the slice
of cheatpaths.

* makefile wip

* fix: appeases linter

Appeases linter (`go vet`) by adding quotation marks to YAML struct
tags.

* chore: modifies .gitignore

Adds `tag` to `.gitignore`

* feat: adds Makefile

Adds a `Makefile` for managing build-related tasks.

* chore: documents directory-local paths

Adds documentation regarding the new directory-local cheatpath
functionality.

* chore: updates dependencies

* chore: bumps version to 3.3.0

* chore: updates bin scripts

- Removes `build_release.sh`
- Places deprecation notice in `build_devel.sh`, as its purpose has been
  superceded by the `Makefile`.
2020-01-20 12:34:48 -05:00
..
a fix: resolves #498 2019-11-07 20:24:08 -05:00
b chore: updates chroma dependency 2019-12-28 09:56:19 -05:00
c fix: resolves #498 2019-11-07 20:24:08 -05:00
circular Add vendor files for go build 2019-10-27 12:04:31 -04:00
d fix: resolves #498 2019-11-07 20:24:08 -05:00
e Add vendor files for go build 2019-10-27 12:04:31 -04:00
f Add vendor files for go build 2019-10-27 12:04:31 -04:00
g Add vendor files for go build 2019-10-27 12:04:31 -04:00
h fix: resolves #498 2019-11-07 20:24:08 -05:00
i Add vendor files for go build 2019-10-27 12:04:31 -04:00
internal fix: resolves #498 2019-11-07 20:24:08 -05:00
j chore: updates vendored dependencies 2019-11-12 19:03:59 -05:00
k Add vendor files for go build 2019-10-27 12:04:31 -04:00
l Add vendor files for go build 2019-10-27 12:04:31 -04:00
m v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
n fix: resolves #498 2019-11-07 20:24:08 -05:00
o Add vendor files for go build 2019-10-27 12:04:31 -04:00
p v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
q Add vendor files for go build 2019-10-27 12:04:31 -04:00
r Add vendor files for go build 2019-10-27 12:04:31 -04:00
s v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
t v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
v Add vendor files for go build 2019-10-27 12:04:31 -04:00
w Add vendor files for go build 2019-10-27 12:04:31 -04:00
x Add vendor files for go build 2019-10-27 12:04:31 -04:00
y v3.3.0 (#525) 2020-01-20 12:34:48 -05:00
lexers.go Add vendor files for go build 2019-10-27 12:04:31 -04:00
README.md fix: resolves #498 2019-11-07 20:24:08 -05:00

Lexer tests

The tests in this directory feed a known input testdata/<name>.actual into the parser for <name> and check that its output matches <name>.exported.

Running the tests

Run the tests as normal:

go test ./lexers

Update existing tests

When you add a new test data file (*.actual), you need to regenerate all tests. That's how Chroma creates the *.expected test file based on the corresponding lexer.

To regenerate all tests, type in your terminal:

RECORD=true go test ./lexers

This first sets the RECORD environment variable to true. Then it runs go test on the ./lexers directory of the Chroma project.

(That environment variable tells Chroma it needs to output test data. After running go test ./lexers you can remove or reset that variable.)

Windows users

Windows users will find that the RECORD=true go test ./lexers command fails in both the standard command prompt terminal and in PowerShell.

Instead we have to perform both steps separately:

  • Set the RECORD environment variable to true.
    • In the regular command prompt window, the set command sets an environment variable for the current session: set RECORD=true. See this page for more.
    • In PowerShell, you can use the $env:RECORD = 'true' command for that. See this article for more.
    • You can also make a persistent environment variable by hand in the Windows computer settings. See this article for how.
  • When the environment variable is set, run go tests ./lexers.

Chroma will now regenerate the test files and print its results to the console window.