Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/camel-tooling/camel-language-server

The Apache Camel LSP server implementation
https://github.com/camel-tooling/camel-language-server

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

Last synced: 3 months ago
JSON representation

The Apache Camel LSP server implementation

Awesome Lists containing this project

README 

        
[![Central](https://img.shields.io/maven-central/v/com.github.camel-tooling/camel-lsp-server.svg?style=plastic)]()

[![GitHub tag](https://img.shields.io/github/tag/camel-tooling/camel-language-server.svg?style=plastic)]()

[![Main branch CI](https://github.com/camel-tooling/camel-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/camel-tooling/camel-language-server/actions/workflows/main.yml)

[![Sonar](https://sonarcloud.io/api/project_badges/measure?project=camel-lsp-server&metric=alert_status)](https://sonarcloud.io/dashboard?id=camel-lsp-server)

[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

[![Chat on Zulip](https://img.shields.io/zulip-join_chat-brightgreen.svg)](https://camel.zulipchat.com/#narrow/stream/258729-camel-tooling)



# camel-language-server



camel-language-server is a server implementation that provides Camel DSL smartness.

The server adheres to the [language server protocol](https://github.com/Microsoft/language-server-protocol)

and can be used with any editor that supports the protocol. The server utilizes [Apache Camel](https://camel.apache.org/).



# Clients



These clients are available:

* [Eclipse IDE](https://github.com/camel-tooling/camel-lsp-client-eclipse) [Marketplace](https://marketplace.eclipse.org/content/language-support-apache-camel)

* [VS Code & Codium](https://github.com/camel-tooling/camel-lsp-client-vscode)

  * [Microsoft Marketplace](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-apache-camel)

  * [Open VSX Marketplace](https://open-vsx.org/extension/redhat/vscode-apache-camel)

* [Emacs](https://emacs-lsp.github.io/lsp-mode/page/lsp-camel/)

* [Vim/NeoClide](https://www.npmjs.com/package/coc-camel)

* [Eclipse Che with Theia](https://github.com/eclipse/che/pull/8648)

* [Atom Editor](https://github.com/camel-tooling/camel-lsp-client-atom)



Tutorial with manual configuration is provided for:

* [Vim/neoClide](https://github.com/camel-tooling/camel-lsp-client-vim)

* [Sublime Text](https://github.com/camel-tooling/camel-lsp-client-sublime)

* [CodeMirror](https://github.com/camel-tooling/camel-lsp-client-codemirror)

* [Emacs](https://github.com/camel-tooling/camel-lsp-client-emacs)



Help is welcome to provide more client implementations and tutorials. You can pick from [this list](https://microsoft.github.io/language-server-protocol/implementors/tools/).



## Features



### Code completion for Camel URI

* Completion for Camel components ![Completion for Camel components](./images/completionComponent.png "Completion for Camel components")

* Completion for Camel attributes ![Completion for Camel attributes](./images/completionAttribute.png "Completion for Camel attributes")

* Completion for Camel attributes value ![Completion for Camel attributes value](./images/completionAttributeValueForChoice.png "Completion for Camel attributes value")



### Hover on Camel URI



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

![Hover on Camel components](./images/hoverComponent.png "Hover on Camel components")



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



On save, diagnostics on Camel URIs are updated:

![Diagnostic on Camel URI](./images/diagnostic.png "Diagnostic on Camel URI")



### 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=`, default value is `8025`

* `--hostname=`, default value `localhost`

* `--contextPath=`, default value `/`. It must start with a `/`.



Then, the connection can be made through

`ws://:/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](https://github.com/apache/groovy/blob/GROOVY_2_5_8/src/resources/groovy/grape/defaultGrapeConfig.xml) into _~/.groovy_ folder and call it _grapeConfig.xml_

* Add `` inside the chain node



For more information, check the [Grape official documentation](http://docs.groovy-lang.org/latest/html/documentation/grape.html#Grape-CustomizeIvysettings).



## 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](/src/main/java/com/github/cameltooling/lsp/internal/catalog/runtimeprovider/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.



![Outline](./images/outline.png "Outline")

![Go to Symbol](./images/goToSymbol.gif "Go To Symbol")

![Breadcrumb](./images/breadCrumbXml.gif "Breadcrumb")



## 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](https://github.com/camel-tooling/camel-language-server/issues).



## License



ASL 2.0, See [LICENSE](LICENSE) file.