Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Commit a1b289f

Browse files
authored
chore: update README (#46)
1 parent 4854ad3 commit a1b289f

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,13 @@ credo-language-server is an LSP implementation for Credo.
1111

1212
## Editor Support
1313

14-
### Neovim
15-
16-
[elixir-tools.nvim](https://github.com/elixir-tools/elixir-tools.nvim)
17-
### VSCode
18-
19-
[elixir-tools.vscode](https://github.com/elixir-tools/elixir-tools.vscode)
20-
21-
### Helix
14+
<ul>
15+
<li>Neovim: <a href="https://github.com/elixir-tools/elixir-tools.nvim">elixir-tools.nvim</a></li>
16+
<li>VSCode: <a href="https://github.com/elixir-tools/elixir-tools.vscode">elixir-tools.vscode</a></li>
2217

18+
<li>
2319
<details>
24-
<summary>example configuration</summary>
20+
<summary>Helix</summary>
2521

2622
Here is an example configuration for `languages.toml`
2723

@@ -45,24 +41,38 @@ config = { elixirLS.dialyzerEnabled = true }
4541
[language-server.credo]
4642
command = "/path/to/executable/credo-language-server"
4743
args = ["--stdio=true", "--port=999"]
48-
4944
```
5045

5146
</details>
52-
47+
</li>
48+
</ul>
5349

5450
## Installation
5551

5652
The preferred way to use credo-language-server is through one of the supported editor extensions.
5753

5854
If you need to install credo-language-server on it's own, you can download the executable hosted by the GitHub release. The executable is an Elixir script that utilizes `Mix.install/2`.
5955

56+
### Note
57+
58+
Credo Language Server creates an `.elixir-tools` hidden directory in your project.
59+
60+
This should be added to your project's `.gitignore`.
61+
6062
## Code Actions
6163

62-
### Disable Check
64+
### DisableCheck
65+
66+
Check: all
6367

6468
If there is a check that you'd wish to disable, you can trigger the code action on that line to insert a magic comment to disable that check.
6569

70+
### ModuleDocFalse
71+
72+
Check: `Credo.Check.Readability.ModuleDoc`
73+
74+
Inject a `@moduledoc false` snippet into the module.
75+
6676
---
6777

6878
Built with [gen_lsp](https://github.com/mhanberg/gen_lsp)

0 commit comments

Comments
 (0)