Chris Lane 55b18b4897 Squashed commit of the following:
commit 95479c8ad744db48386a5c78e54ef8da80e9120b
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:26:32 2021 -0400

    chore(version): bump version to 4.2.1

commit 6956f51caea74cef7a09a39c3e4d5bcb66d4b2c5
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:24:21 2021 -0400

    fix(Makefile): `vendor-update`

    Update the `vendor-update` build target to run `go mod vendor` after
    updating dependencies.

commit 0aca411279e06d8b9edfc9c25f0b9d03ea028de7
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 12:23:24 2021 -0400

    chore(deps): update dependencies

commit e847956b020d2709f1f5625f2d500733e26872c0
Author: Chris Lane <chris@chris-allen-lane.com>
Date:   Wed Apr 28 08:26:51 2021 -0400

    chore(deps): build updates

    - Upgrade `go` to `1.16.3`

    - Attempt to fix build errors regarding dependencies
2021-04-28 12:35:32 -04:00
..
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2021-04-28 12:35:32 -04:00
2020-08-08 10:29:29 -04:00
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.