camel-tooling / camel-language-server Goto Github PK

The Apache Camel LSP server implementation

License: Apache License 2.0

Java 99.87% Groovy 0.05% Kotlin 0.05% JavaScript 0.03%

camel apache-camel lsp lsp-server camel-language-server lsp4j language-server-protocol language-server

camel-language-server's Introduction

camel-language-server

camel-language-server is a server implementation that provides Camel DSL smartness. The server adheres to the language server protocol and can be used with any editor that supports the protocol. The server utilizes Apache Camel.

Clients

These clients are available:

Tutorial with manual configuration is provided for:

Help is welcome to provide more client implementations and tutorials. You can pick from this list.

Features

Code completion for Camel URI

Completion for Camel components
Completion for Camel attributes
Completion for Camel attributes value

Hover on Camel URI

On hover, the documentation of the Camel component is available.

Diagnostics (a.k.a. Validation) on Camel URI

On save, diagnostics on Camel URIs are updated:

Camel K modeline support

Completion for:
- option names
- trait definition names
- trait property names
- Camel artifact id for dependency
- mvn dependency
- Camel component properties
- resource-like properties (resource, open-api, property-file). It is providing relevant sibling files filtering out some IDEs configuration folders (.vscode, .settings, .theia).

WebSocket support

Connection through WebSocket is supported. The server needs to be launched with --websocket option.

The following extra parameters can be used:

--port=<port>, default value is 8025
--hostname=<hostname>, default value localhost
--contextPath=<contextPath>, default value /. It must start with a /.

Then, the connection can be made through ws://<hostname>:<port><contextPath>/camel-language-server.

For information, with all defaults, it is ws://localhost:8025/camel-language-server.

Specific version of Camel catalog

It is possible to specify a specific version of the Camel catalog. This can be provided as Initialization Option or Workspace Configuration. The format is the same for both:

{
	"camel": {
		"Camel catalog version" : ...
	}
}

Please note that the first time a version is used, it can take several seconds/minutes to have it available depending on the time to download the dependencies in the background.

When using a Red Hat productized version which contains redhat in the version, the Maven Red Hat repository is automatically added.

To use other versions not available on Maven Central, additional repositories need to be configured on the host running the Camel Language Server. To configure it, follow these steps:

Copy the default grape config file corresponding to the version used by Camel into ~/.groovy folder and call it grapeConfig.xml
Add <ibiblio name="fuse" m2compatible="true" root="<https://<urlofYourMavenRepository>"/> inside the chain node

For more information, check the Grape official documentation.

Specific runtime provider of Camel catalog

It is possible to specify a specific runtime provider of the Camel catalog. This can be provided as Initialization Option or Workspace Configuration. The format is the same for both:

{
	"camel": {
		"Camel catalog runtime provider" : ...
	}
}

Currently supported providers can be found in CamelRuntimeProvider enum.

Additional Camel components

It is possible to specify a list of additional Camel components. This can be provided as Initialization Option or Workspace Configuration. The format is the same for both:

{
	"camel": {
		"extra-components" : [
			...
		]
	}
}

Document symbol support

There is document symbol for Camel Contexts and routes, on XML and Java DSL. In UI, for instance with VS Code, it means there are an outline, a breadcrumb and a Go To Document Symbol command.

Connected mode completion for Kafka component

When using the Camel Kafka component, the list of topics is dynamically retrieved from the Kafka Broker when available. By default, it tries to connect to localhost:9092. To connect to another instance, a setting can be provided, following this pattern:

{
	"camel": {
		"Kafka Connection URL" : "localhost:9092"
	}
}

Features planned

As you type reporting of parsing and compilation errors
More advanced Code completion
Code outline
Code navigation
Code lens (references)
Highlights
Code formatting

Feedback

File a bug in GitHub Issues.

License

ASL 2.0, See LICENSE file.

camel-language-server's People

Contributors

Stargazers

Watchers

camel-language-server's Issues

Include outline/DocumentSymbol for Camel routes in features of readme

see #73

Provide domain-specific completion

for some domains, some components are more used, it would be nice to provide built-in for different domain which will sort the completion proposal by providing first the domain-specific ones

Support camel files using prefix namespace

Support additional catalogs

some catalogs are provided outside of Camel core, it will be a good idea to have a way to include them in the completion/validation/doc. it will help to focus on a specific vertical for instance.

Support incremental mode

currently, the whole file is sent on each request. to save bandwith and improve performance, it would be nice to support incremental update

Provide "go to" link for "Direct" components

Filter attribute completion when attribute is already used in the same Camel URI

Provide an internal model of the whole Camel file containing all ranges of value

not an easy task, but it would certainly allow to parse a single time the file (and on each modifications?), simplifying after to provide all completions/documentsymbol and other things

Update LSP protocol implementors page to point to this new repo

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

Update to Camel 2.21.1

Provide validation of Camel URI with XML DSL

maybe worth having a look to camel-validation-plugin and see if we can reuse it directly

add deployment to maven central

extend the travis script to push snapshots and releases to some official and public maven repository

On Completion, insert and replace when there is something after the cursor

for instance, there is "timer", I put the cursor after the t and choose twitter

current result is:
"twitter:kindimer"

expected result would be:
"twitter:kind"

same applies for options.

How to handle the remaining parts if more complex such as:
"timer:value?delay=1000"
if I autocomplete after the t with twitter:kind, what would be the result?
"twitter:kind"
"twitter:kind?delay=1000"
"twitter:value"

Provide code-lens for placeholder values

in case placeholder value can be determined, it might be nie to add the value as a code-lens

Rename test packages from org.apache.camel to com.github.cameltooling

Provide outline/DocumentSymbol for global endpoints

follow-up #73

Remove hardcoded Camel version in code which is not used

as the VersionManager is the default one, the catalog used is always the one from the dependency. The set of the version is ignored

Provide type of attributes

Update readme to list all clients available

refactor maven gav

We are not allowed to use org.apache so we should rename the gav to org.cameltooling

Provide icons for variables in completion

Support different version of Camel

currently the compeltion is based on latest available version.

it would be nice to be able to specify which version to use in a first time and to read it from project in a second time (or to read it from xsd location if people are using strict modeling metamodel)

Add java language support

Sort completion of option param with "common" ones on top

Provide action in completion to create a placeholder

"Downlight" deprecated components/attributes in completion

can be strikethrough or italic?

Provide completion for "ref" attribute in Camel uri

Support Camel uri written on multiline

Include Camel attribute documentation on hover

Currently, it contains only the component documentation, it would be nice to provide the Camel attribute documentation also

Provide "go to" link for Rest dsl

to jump from the to the component anId

Provide support for JSonPath language

some attributes are JSonPath dataformat/language, it would be nice to be able to provide completion/validation for these fields

would be interesting to factorize code with Camel Idea plugin

Provide link to open documentation in webbrowser of current Camel component

maybe can be split on hover and on completion

Use camel-tooling-common to avoid code duplication

Improve readme to provide gifs for completion feature

Provide architecture documentation

to help contributor to jumpstart in the project:

point to LSP protocol
point to LSP4J which is the LSP Protocol implementation in Java used in the project
point to java Future documentation
define entry points
provide architecture schema

Provide rename capabilities for placeholders

Provide completion while searching by tags for components

Camel components have tags which can help to search for a specific domain.
See a part of this list from a screenshot from Fuse Tooling:

while auto-completing, it migth be nice to search in categories too.

I imagine several possibilities:

"a -> ask for completion will return all components starting by a and after in the list all components which categories starts by a
have specific prefix that user need to use to search by category: a special character? # or | or what else? or a specific name such as "cat" or "category"?