elixir-tools / credo-language-server

LSP implementation for Credo.
MIT License
98 stars 11 forks source link
credo elixir lsp

[!IMPORTANT]
Next LS now has support for Credo, so Credo Language Server will not receive further significant updates.

credo-language-server

Discord Hex.pm GitHub Discussions

credo-language-server is an LSP implementation for Credo.

Features

Editor Support

Installation

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

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.

Note

Credo Language Server creates an .elixir-tools hidden directory in your project.

This should be added to your project's .gitignore.

Code Actions

DisableCheck

Check: all

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.

ModuleDocFalse

Check: Credo.Check.Readability.ModuleDoc

Inject a @moduledoc false snippet into the module.

Contributing

Running tests

# setup the test project
$ (cd test/support/project && mix deps.get)

# run the tests
$ mix test

Built with gen_lsp