rebar3_bsp's Introduction

erlang_ls

An Erlang server implementing Microsoft's Language Server Protocol 3.17.

Minimum Requirements

Supported OTP versions

24, 25, 26

Quickstart

Compile the project:

make

To install the produced erlang_ls escript in /usr/local/bin:

make install

To install to a different directory set the PREFIX environment variable:

PREFIX=/path/to/directory make install

Command-line Arguments

These are the command-line arguments that can be provided to the erlang_ls escript:

Usage: Erlang LS [-v] [-t [<transport>]] [-p [<port>]] [-d [<log_dir>]]
                 [-l [<log_level>]]

  -v, --version    Print the current version of Erlang LS
  -t, --transport  Specifies the transport the server will use for the
                   connection with the client, either "tcp" or "stdio".
                   [default: tcp]
  -p, --port       Used when the transport is tcp. [default: 10000]
  -d, --log-dir    Directory where logs will be written.
                   [default: filename:basedir(user_log, "erlang_ls")]
  -l, --log-level  The log level that should be used. [default: info]

Configuration

It is possible to customize the behaviour of the erlang_ls server via a configuration file, named erlang_ls.config or erlang_ls.yaml. That file should be placed in the root directory of a given project to store the configuration for that project. It is also possible to store a system-wide default configuration, which is shared across multiple projects.

Please refer to the configuration section of the documentation to learn how to configure Erlang LS for a specific project.

Getting in Touch

If you have any questions about the project, feel free to open a new issue. You can also join the #erlang-ls channel in the Erlanger Slack if you would like to get involved or if you prefer a more informal mean of communication.

All contributions are welcome, be them in the form of a bug report, a question, feedback, or code.

I occasionally blog about the project on Medium.

References

https://microsoft.github.io/language-server-protocol/

License

The erlang_ls project is licensed under the Apache License 2.0. Please refer to the LICENSE file for details.

rebar3_bsp's People

Contributors

Stargazers

Watchers

rebar3_bsp's Issues

The easiest way to run ct_test on runtime node with rebar3_bsp

Hi @robertoaloi,

I am impressed with the abbility to run ct tests on the runtime node. But I see it is not the single goal of bsp.

Found this repo, when looking for the "rebar3_erlang_ls_agent.erl" - which is default module for the "els_config_ct_run_test".

I tried to add bsp plugin, and run rebar3 bsp, but faced following crash:

=CRASH REPORT==== 7-Dec-2020::22:33:57.335286 ===
  crasher:
    initial call: rebar3_bsp_stdio:init/0
    pid: <0.1000.0>
    registered_name: []
    exception error: bad argument
      in function  binary_to_integer/1
         called as binary_to_integer(undefined)
      in call from rebar3_bsp_stdio:loop/1 (/d/repos/kribrum/spider_umbrella/apps/yandex_maps/_build/default/plugins/rebar3_bsp/src/rebar3_bsp_stdio.erl, line 23)
    ancestors: [rebar3_bsp_agent,<0.999.0>]
    message_queue_len: 0
    messages: []
    links: [<0.9.0>]
    dictionary: []
    trap_exit: false
    status: running
    heap_size: 610
    stack_size: 28
    reductions: 223
  neighbours:

I see, that plugin is not ready yet, but - maybe there is a way to achive running ct tests on the runtime node?

erlang-ls / rebar3_bsp Goto Github PK