Custom Elements Language Server

Note This project is in Alpha phase right now. Major changes might occur.

Usage

The best way to utilize the Custom Elements Language Server is to enable the Custom Elements Manifest(CEM) in your project by installing a CEM generator like one provided by The Open WC Team.

Generating a CEM in watch mode will provide you with the best user experience. If your dependencies ship with a Custom Elements Manifest, those will be utilized also.

Installing

VS Code

For VS Code, you are able to install the Custom Elements Language Server through the extension Marketplace.

You can find the plugin here

NeoVim

NeoVim supports LSP actions through the built in LSP. You will just need to install the Language Server locally on your machine through npm or yarn, and then enable your connector for the language service.

Install language server

npm install -g custom-elements-languageserver

Set up your lsp client

With a library like nvim-lspconfig the client setup should be as easy as

require'lspconfig'.custom_elements_language_server.setup{}

Other editors

Is your favorite editor missing? If the editor supports LSP actions, plugging it in should be easy. If you need assistance, submit an issue.

The Goal

The aim of the Custom Elements Language Server / Language services is to create a centralized server for supporting LSP operations on Custom Elements.

These operations include but are not limited to

• Go To Definition
• Attribute autocompletion
• Slot name autocompletions
• Event binding completions

Via installing a plugin to your favorite editor to support LSP actions, you are able to enable all of these Language Service functionalities.