From 6acfa13b55c0056e39cd9ae80bdbbf3eba252e4a Mon Sep 17 00:00:00 2001 From: Jos512 Date: Fri, 4 Oct 2019 00:57:10 +0200 Subject: [PATCH] Improve info on test regeneration (#287) --- lexers/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/lexers/README.md b/lexers/README.md index de859a1..2421710 100644 --- a/lexers/README.md +++ b/lexers/README.md @@ -10,10 +10,28 @@ Run the tests as normal: go test ./lexers ``` -## Updating the existing tests +## 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. -You can regenerate all the test outputs +To regenerate all tests, type in your terminal: ```go 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](https://superuser.com/questions/212150/how-to-set-env-variable-in-windows-cmd-line) for more. + + 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. + + 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. +- 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.