SandpointsGitHook/vendor/github.com/alecthomas/chroma/lexers
2021-03-20 23:21:23 +01:00
..
a new vendor... 2021-03-20 23:21:23 +01:00
b new vendor... 2021-03-20 23:21:23 +01:00
c new vendor... 2021-03-20 23:21:23 +01:00
circular new vendor... 2021-03-20 23:21:23 +01:00
d new vendor... 2021-03-20 23:21:23 +01:00
e new vendor... 2021-03-20 23:21:23 +01:00
f new vendor... 2021-03-20 23:21:23 +01:00
g new vendor... 2021-03-20 23:21:23 +01:00
h new vendor... 2021-03-20 23:21:23 +01:00
i new vendor... 2021-03-20 23:21:23 +01:00
internal new vendor... 2021-03-20 23:21:23 +01:00
j new vendor... 2021-03-20 23:21:23 +01:00
k new vendor... 2021-03-20 23:21:23 +01:00
l new vendor... 2021-03-20 23:21:23 +01:00
m new vendor... 2021-03-20 23:21:23 +01:00
n new vendor... 2021-03-20 23:21:23 +01:00
o new vendor... 2021-03-20 23:21:23 +01:00
p new vendor... 2021-03-20 23:21:23 +01:00
q new vendor... 2021-03-20 23:21:23 +01:00
r new vendor... 2021-03-20 23:21:23 +01:00
s new vendor... 2021-03-20 23:21:23 +01:00
t new vendor... 2021-03-20 23:21:23 +01:00
v new vendor... 2021-03-20 23:21:23 +01:00
w new vendor... 2021-03-20 23:21:23 +01:00
x new vendor... 2021-03-20 23:21:23 +01:00
y new vendor... 2021-03-20 23:21:23 +01:00
z new vendor... 2021-03-20 23:21:23 +01:00
hlb.go new vendor... 2021-03-20 23:21:23 +01:00
lexers.go new vendor... 2021-03-20 23:21:23 +01:00
qml.go new vendor... 2021-03-20 23:21:23 +01:00
README.md new vendor... 2021-03-20 23:21:23 +01: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
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:

```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.