Skip to content

Commit 947d070

Browse files
crbelausmhanberg
andauthored
docs: add dev instructions to README (#155)
Co-authored-by: Mitchell Hanberg <[email protected]>
1 parent 218d4d0 commit 947d070

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,30 @@ The preferred way to use Next LS is through one of the supported editor extensio
6666

6767
If you need to install Next LS 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`.
6868

69+
## Development
70+
71+
If you are making changes to NextLS and want to test them locally you can run
72+
`bin/start --port 9000` to start the language server (port 9000 is just an
73+
example, you can use any port that you want as long as it is not being used
74+
already).
75+
76+
Then you can configure your editor to connect to NextLS using that port.
77+
78+
[elixir-tools.nvim](https://github.com/elixir-tools/elixir-tools.nvim)
79+
80+
```lua
81+
{
82+
nextls = {enable = true, port = 9000}
83+
}
84+
85+
Visual Studio Code
86+
87+
```json
88+
{
89+
"elixir-tools.nextls.adapter": "tcp",
90+
"elixir-tools.nextls.port": 9000,
91+
}
92+
6993
### Note
7094

7195
Next LS creates an `.elixir-tools` hidden directory in your project, but it will be automatically ignored by `git`.

0 commit comments

Comments
 (0)