@lifeart/ember-language-server

A language server implementation for Ember.js projects.


Keywords
ember, language-server, ember-language-server, autocomplete, dx, emberjs, glimmerjs, hacktoberfest, handlebars, language-server-protocol, visual-studio-code
License
MIT
Install
npm install @lifeart/ember-language-server@2.25.0

Documentation

Ember Language Server

Greenkeeper badge

The Ember Language Server (ELS) implements the Language Server Protocol for Ember.js projects. ELS enables editors to provide features like auto complete, goto definition and diagnostics. To get these features, you have to install the plugin for your editor.

Features

All features currently only work in Ember CLI application that use the default classic structure, and are a rough first draft with a lot of room for improvements. Pods and addons are not supported yet.

  • Autocompletion

    • *.{js/ts}: services, models, routes, transforms
    • *.hbs: components, route names, helpers, modifiers, local paths, arguments
    • Namespaces support (batman syntax)
  • Template linting

    • works only if ember-template-lint dependency added into project.
    • ember-template-lint (v2, v3, v4) integration, including documentation links and auto fixes
    • template linting inside .js and .ts files (with hbs literal)
    • experimental linting inside .gjs and .gts files (with <template> tag)
  • Definition providers for (enable features like "Go To Definition" or "Peek Definition"):

    • Components (in Templates)
    • Helpers (in Templates)
    • Modifiers (in Templates)
    • Models
    • Transforms
    • Component imports (from addons)
    • Namespace components (batman syntax)
  • Route autocompletion in link-to and <LinkTo> components.

  • Outlet jumping

  • Workspaces support

  • Supports Ignoring of LS initialization on unneeded projects by using ignoredProjects config option, if you need "exclude except" functionality, specify project name as !my-project.

Editor Plugins

Addons available for install

Addon notes:

  • all addons could be added as dev-dependency for a project
  • dev-dependency installation allow us to have independent versions of addons for different projects
  • for global addon installation check LS settings in your editor (you have to specify path to addon root in LS config)
  • you could build your project-sepecific addon

Integration details

Server entrypoints

lib/start-server.js - nodejs

lib/start-worker-server.js - worker

Server options

new Server({fs, type})

fs - available options:

  • sync - LS should use nodejs.fs logic
  • async - LS should use client's fs provider

type - available options:

  • node - supported addons & require logic
  • worker - addons and require logic not supported

Debugging


Changelog


Licence

MIT