Need help with elm-language-client-vscode?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

elm-tooling
195 Stars 21 Forks MIT License 555 Commits 17 Opened issues

Description

Improving your Elm experience since 2019

Services available

!
?

Need anything else?

Contributors list

Elm Plugin for Visual Studio Code (VSCode)

Version Downloads Rating

Supports elm 0.19 and up

Install

  1. Install VSCode from here
  2. Follow this link to install the plugin
  3. Make sure you have nodejs and therefore npm installed
  4. Make sure you have Elm installed
  5. Install
    elm-test
    and
    elm-format
    by running
    npm install -g elm-test elm-format
    in a terminal
  6. (Optional) Install
    elm-review
    via
    npm install -g elm-review
    in a terminal and enable it in your settings

Highlighted Features

  • Errors and informations when changing code and when saving (Control + S)
  • Format on save (Control + S) (Make sure you also enable the "Editor: Format on Save" setting for this to work).
  • Suggests completions and snippets (Control + Space)
  • Test explorer integration

Additional Features

  • Lists all references to a type alias, module, custom type or function (Alt + Shift + F12)
  • Jump to the definition of a type alias, module, custom type or function
  • Shows type annotations and documentation on hover for type alias, module, custom type or function
  • Rename a type alias, module, custom type or function (F2)
  • Browse file by symbols (Control + Shift + O)
  • Browse workspace by symbols (Control + Shift + R)
  • Codelenses show how many times you calling a function and if it's exposed or not
  • Code folding
  • Type inference
  • Some more

Extension Settings

This extension contributes the following settings:

  • elmLS.trace.server
    : Enable/disable trace logging of client and server communication
  • elmLS.elmPath
    : The path to your elm executable.
  • elmLS.elmReviewPath
    : The path to your elm-review executable.
  • elmLS.elmReviewDiagnostics
    : Configure linting diagnostics from elm-review. Possible values:
    off
    ,
    warning
    ,
    error
    .
  • elmLS.elmFormatPath
    : The path to your elm-format executable.
  • elmLS.elmTestPath
    : The path to your elm-test executable.
  • elmLS.disableElmLSDiagnostics
    : Disable linting diagnostics from the language server.
  • elmLS.skipInstallPackageConfirmation
    : Skip confirmation for the Install Package code action.
  • elmLS.onlyUpdateDiagnosticsOnSave
    : Only update compiler diagnostics on save, not on document change.
  • elmLS.elmTestRunner.showElmTestOutput
    : Show output of elm-test as terminal task.

Configuration

We used to have a file called

elm-tooling.json
where you could specifiy
"entrypoints"
. That’s not needed anymore – the language server finds the entrypoints automatically.

If all you had in

elm-tooling.json
was
"entrypoints"
, you can safely remove that file.

FAQ

  • How to get a logfile?

    • F1
      -> Type
      Output: Focus on Output View
      -> In the now open panel, use the drop down on the right to choose
      Elm (your project name)
  • Most features don't seem to work for me?

    • This tool needs a valid elm project, please check if you have an
      elm.json
      . You can easily initialize your project with
      elm init
      . If it still does work, please try if you get the same behavior with the elm-spa-example.
  • What's the relation to the language server?

  • Why do I need to install

    elm
    ,
    elm-test
    and
    elm-format
    ?
    • You will need to install
      elm
      and
      elm-test
      to get all diagnostics and
      elm-format
      for formatting. If your setup fails to find the global installations of those, you can use the settings panel in VSCode to set the paths to the executable manually. Alternatively you can also just install these to your local npm
      package.json
      .
  • I don't like the inserted lines for "X references" (CodeLenses)

    • You can configure VSCode to not show them, just look for "Editor: Code Lens" in your settings.
  • I'm using glsl and the extension is not helpful

Contributing / Debugging

git clone --recursive [email protected]:elm-tooling/elm-language-client-vscode.git
cd elm-language-client-vscode
npm install

Open VSCode with this project (

code .
) and press
F5
to start debugging the plugin.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.