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.

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

Add dev instructions to README #155

Merged
merged 4 commits into from
Aug 9, 2023
Merged
Changes from 3 commits
Commits
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
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,33 @@ The preferred way to use Next LS is through one of the supported editor extensio

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`.

## Development

If you are making changes to NextLS and want to test them locally you can run
`bin/start --port 9000` to start the language server (port 9000 is just an
example, you can use any port that you want as long as it is not being used
already).

Then you can configure your editor to connect to NextLS using that port.

<details>
<summary>

[elixir-tools.nvim](https://github.com/elixir-tools/elixir-tools.nvim)

</summary>

nextls = {enable = true, port = 9000}

</details>

<details><summary>Visual Studio Code</summary>

"elixir-tools.nextls.adapter": "tcp",
"elixir-tools.nextls.port": 9000,

</details>
mhanberg marked this conversation as resolved.
Show resolved Hide resolved

### Note

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