Git Product home page Git Product logo

lsp4mp's Introduction

Eclipse LSP4MP - Language Server for MicroProfile

Build Status License Gitter chat for lsp4mp

A language server implementation based on the Language Server Protocol for MicroProfile. This Language Server for MicroProfile (LSP4MP) provides core language support capabilities (such as code complete, diagnostics, quick fixes) to enable developers to quickly and easily develop applications using MicroProfile APIs.

This project contains:

You can build all projects at once by running the buildAll.sh script (buildAll.bat on Windows).

Features

General

When you open a MicroProfile project, lsp4mp provides:

  • Symbols to help you navigate to JAX-RS REST endpoint methods, searchable using the naming convention: @/api/endpointName: GET

Properties files

In microprofile-config.properties files, you will benefit with:

  • Completion support for MicroProfile properties
  • Hover support for MicroProfile properties
  • Definition support for MicroProfile properties
  • Format support for MicroProfile properties
  • Validation and Quick Fix support for MicroProfile properties
  • Outline support (flat or tree view)

Java files

In Java files, you will benefit with:

  • Completion support for MicroProfile
  • Hover support for MicroProfile
  • Validation and Quick Fix support for MicroProfile
  • Code Lens support for MicroProfile
  • Code snippets

Architecture

For information on the architecture/project structure see architecture.md

Getting started

JDK 11 is required to build the language server and the eclipse.jdt.ls extension.

  1. Clone this repository
  2. Open the folder in your terminal / command line
  3. Run ./buildAll.sh (OSX, Linux) or buildAll.bat (Windows)

Maven coordinates

Here are the Maven coordinates for LSP4MP (replace the X.Y.Z version with the latest release):

<dependency>
  <groupId>org.eclipse.lsp4mp</groupId>
  <artifactId>org.eclipse.lsp4mp.ls</artifactId>
  <version>X>Y>Z</version>
  <classifier>uber</classifier>
  <exclusions>
    <exclusion>
      <groupId>org.eclipse.lsp4j</groupId>
      <artifactId>org.eclipse.lsp4j</artifactId>
    </exclusion>
    <exclusion>
      <groupId>org.eclipse.lsp4j</groupId>
      <artifactId>org.eclipse.lsp4j.jsonrpc</artifactId>
    </exclusion>
  </exclusions>
</dependency>

for Gradle:

compile(group: 'org.eclipse.lsp4mp', name: 'org.eclipse.lsp4mp', version: 'X.Y.Z', classifier: 'uber')

You will have to reference the Maven repository hosting the dependency you need. E.g. for Maven, add this repository to your pom.xml or settings.xml :

<repository>
  <id>lsp4mp-releases</id>
  <url>https://repo.eclipse.org/content/repositories/lsp4mp-releases/</url>
  <snapshots>
    <enabled>false</enabled>
  </snapshots>
  <releases>
    <enabled>true</enabled>
  </releases>
</repository>

And if you want to consume the SNAPSHOT builds instead:

<repository>
  <id>lsp4mp-snapshots</id>
  <url>https://repo.eclipse.org/content/repositories/lsp4mp-snapshots/</url>
  <releases>
    <enabled>false</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

Clients

Extensions

Both the MicroProfile JDT LS Extensions and MicroProfile Language Server can be extended to provide additional functionality. A common extension is to provide additional snippets via an external JAR.

Example extensions:

Feedback

Please report bugs, issues and feature requests by creating a GitHub Issue

lsp4mp's People

Contributors

angelozerr avatar baibhab97 avatar datho7561 avatar dependabot[bot] avatar dkwon17 avatar eclipsewebmaster avatar fbricon avatar jeffmaury avatar jessicajhee avatar kathrynkodama avatar rgrunber avatar rzgry avatar sbouchet avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.