Skip to content

Commit f5c2a29

Browse files
author
Étienne Lévesque
authored
Adds simple documentation for the test executions code lenses (#196)
1 parent 00023f4 commit f5c2a29

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,30 @@ Check the output log by opening `View > Output` and selecting "ElixirLS" in the
106106

107107
Check the developer console by opening `Help > Toggle Developer Tools` and include any errors that look relevant.
108108

109+
## Experimental features
110+
111+
### Test code lenses
112+
113+
This feature allows ElixirLS to provide code lenses that help developers easily execute tests. This feature is currently
114+
experimental because of a few known issues as well as a lack of large scale testing.
115+
116+
#### Example
117+
118+
![Test Lenses Example](https://raw.githubusercontent.com/elixir-lsp/elixir-ls/master/images/test_lens_example.gif)
119+
120+
#### Configuration
121+
122+
```jsonc
123+
{
124+
// Enable or disable test lenses. Defaults to false.
125+
"elixirLS.enableTestLenses": true
126+
}
127+
```
128+
129+
#### Known issues
130+
131+
- The generated command sometimes fails to properly execute tests in umbrella apps. See [this comment](https://github.com/elixir-lsp/elixir-ls/issues/438#issuecomment-871861880) for more details.
132+
109133
## Contributing
110134

111135
### Installation

images/test_lens_example.gif

64 KB
Loading

0 commit comments

Comments
 (0)