Skip to content

Commit 63a9920

Browse files
committed
feat: deprecate Credo Language Server
Removes all mentions of Credo Language Server and changes it to default to disabled.
1 parent 62d7c40 commit 63a9920

File tree

2 files changed

+5
-28
lines changed

2 files changed

+5
-28
lines changed

README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
## Features
1919

2020
- [Next LS](https://github.com/elixir-tools/next-ls) installation and configuration.
21-
- [Credo Language Server](https://github.com/elixir-tools/credo-language-server) installation and configuration.
2221
- [ElixirLS](https://github.com/elixir-lsp/elixir-ls) installation and configuration.
2322
- `:Mix` command with autocomplete
2423
- [vim-projectionist](https://github.com/tpope/vim-projectionist) support
@@ -40,7 +39,6 @@ Requires 0.8
4039

4140
elixir.setup {
4241
nextls = {enable = true},
43-
credo = {},
4442
elixirls = {
4543
enable = true,
4644
settings = elixirls.settings {
@@ -71,20 +69,19 @@ use({ "elixir-tools/elixir-tools.nvim", tag = "stable", requires = { "nvim-lua/p
7169

7270
## Minimal Setup
7371

74-
The minimal setup will configure both ElixirLS and credo-language-server.
72+
The minimal setup will configure both ElixirLS but not Next LS.
7573

7674
```lua
7775
require("elixir").setup()
7876
```
7977

80-
Next LS, ElixirLS, and Credo Language Server can be enabled/disabled by setting the `enable` flag in the respective options table.
78+
Next LS and ElixirLS can be enabled/disabled by setting the `enable` flag in the respective options table.
8179

8280
The defaults are shown below.
8381

8482
```lua
8583
require("elixir").setup({
8684
nextls = {enable = false},
87-
credo = {enable = true},
8885
elixirls = {enable = true},
8986
})
9087
```
@@ -118,15 +115,7 @@ elixir.setup {
118115
-- custom keybinds
119116
end
120117
},
121-
credo = {
122-
enable = true, -- defaults to true
123-
port = 9000, -- connect via TCP with the given port. mutually exclusive with `cmd`. defaults to nil
124-
cmd = "path/to/credo-language-server", -- path to the executable. mutually exclusive with `port`
125-
version = "0.1.0-rc.3", -- version of credo-language-server to install and use. defaults to the latest release
126-
on_attach = function(client, bufnr)
127-
-- custom keybinds
128-
end
129-
},
118+
,
130119
elixirls = {
131120
-- specify a repository and branch
132121
repo = "mhanberg/elixir-ls", -- defaults to elixir-lsp/elixir-ls
@@ -197,18 +186,6 @@ and it will not prompt you to install and use it from there.
197186

198187
Next LS command are available as subcommands of the `:Elixir` command
199188

200-
## Credo Language Server
201-
202-
> **Note**
203-
> Credo Language Server integration utilizes `Mix.install/2`, so you must be running Elixir >= 1.12
204-
205-
> **Note**
206-
> Credo Language Server creates a `.elixir-tools` directory in your project root. You'll want to add that to your gitignore.
207-
208-
- Uses your project's Credo version.
209-
- Full project diagnostics
210-
- Code Actions
211-
212189
## ElixirLS
213190

214191
### Automatic Installation

lua/elixir/init.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ function M.setup(opts)
9696
opts.credo.cmd = M.credo.default_bin
9797
end
9898

99-
if enabled(opts.credo.enable) and not opts.credo.version then
99+
if opts.credo.enable == true and not opts.credo.version then
100100
opts.credo.version = utils.latest_release("elixir-tools", "credo-language-server")
101101
end
102102

@@ -112,7 +112,7 @@ function M.setup(opts)
112112
elixirls.setup(opts.elixirls)
113113
end
114114

115-
if opts.credo.version and enabled(opts.credo.enable) then
115+
if opts.credo.version and opts.credo.enable == true then
116116
credo.setup(opts.credo)
117117
end
118118

0 commit comments

Comments
 (0)