1# Lexer tests 2 3The tests in this directory feed a known input `testdata/<name>.actual` into the parser for `<name>` and check 4that its output matches `<name>.exported`. 5 6## Running the tests 7 8Run the tests as normal: 9```go 10go test ./lexers 11``` 12 13## Update existing tests 14When 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. 15 16To regenerate all tests, type in your terminal: 17 18```go 19RECORD=true go test ./lexers 20``` 21 22This first sets the `RECORD` environment variable to `true`. Then it runs `go test` on the `./lexers` directory of the Chroma project. 23 24(That environment variable tells Chroma it needs to output test data. After running `go test ./lexers` you can remove or reset that variable.) 25 26### Windows users 27Windows users will find that the `RECORD=true go test ./lexers` command fails in both the standard command prompt terminal and in PowerShell. 28 29Instead we have to perform both steps separately: 30 31- Set the `RECORD` environment variable to `true`. 32 + In the regular command prompt window, the `set` command sets an environment variable for the current session: `set RECORD=true`. See [this page](https://superuser.com/questions/212150/how-to-set-env-variable-in-windows-cmd-line) for more. 33 + In PowerShell, you can use the `$env:RECORD = 'true'` command for that. See [this article](https://mcpmag.com/articles/2019/03/28/environment-variables-in-powershell.aspx) for more. 34 + You can also make a persistent environment variable by hand in the Windows computer settings. See [this article](https://www.computerhope.com/issues/ch000549.htm) for how. 35- When the environment variable is set, run `go tests ./lexers`. 36 37Chroma will now regenerate the test files and print its results to the console window. 38