Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds simple documentation for the test executions code lenses #196

Merged
merged 1 commit into from
Jul 19, 2021
Merged

Adds simple documentation for the test executions code lenses #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,30 @@ Check the output log by opening `View > Output` and selecting "ElixirLS" in the

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

## Experimental features

### Test code lenses

This feature allows ElixirLS to provide code lenses that help developers easily execute tests. This feature is currently
experimental because of a few known issues as well as a lack of large scale testing.

#### Example

![Test Lenses Example](https://raw.githubusercontent.com/elixir-lsp/elixir-ls/master/images/test_lens_example.gif)

#### Configuration

```jsonc
{
// Enable or disable test lenses. Defaults to false.
"elixirLS.enableTestLenses": true
}
```

#### Known issues

- 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.
Comment on lines +129 to +131
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per this and the few following comments, this issue seems to be more about elixir-ls' test setup than the test lenses, so I guess this could be removed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to leave it in for now in the chance that it affects other projects as well, and other projects may use a similar alias in their tests.


## Contributing

### Installation
Expand Down
Binary file added images/test_lens_example.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.