Apache Camel for Visual Studio Code
This is a preview release of the Visual Studio Code extension that adds Apache Camel language support for XML DSL and Java DSL code.
When you add this extension to your installation of VS Code, the VS Code editor provides the following features:
Language service support for Apache Camel URIs (both XML DSL and Java DSL)
Auto-completion for Camel components, attributes, and the list of attribute values
XML DSL
Java DSL
Camel-K Groovy DSL (It requires to have file named with the pattern *.camelk.groovy or that the file starts with // camel-k:)
Camel-K Kotlin DSL (It requires to have file named with the pattern _*.camelk.kts or that the file starts with // camel-k:)
Camel-K JavaScript DSL (It requires to have file named with the pattern _*.camelk.js or that the file starts with // camel-k:)
Camel Kafka Connect properties
Camel-K Yaml DSL (It requires to have file named with the pattern *.camelk.yaml or that the file starts with // camel-k:)
Camel properties file (restricted to camel components ids and camel components properties)
Quick reference documentation when you hover the cursor over a Camel component
Diagnostics for Camel URIs
Navigation to Camel contexts and routes in the VS Code outline panel and in the Go > Go to Symbol in Editor... navigation panel (XML DSL only)
Navigation for Java and XML DSL
- Outline. Note that if you select
sort by position, you gain an overview of the route flow, not only of the element hierarchy.
- Go > Go to Symbol in Editor...
- Breadcrumb
Auto-completion for referenced IDs of direct, direct VM, VM and SEDA components (XML DSL only)
Find references for direct and direct VM components in all open Camel files (XML DSL only)
Camel K modelines support
- completion and hover for:
- option names
- trait definition names
- trait property names
- Camel artifact id for dependency
- mvn dependency
- Camel properties
- diagnostic for duplicated trait properties
Camel Kafka Connector support:
- Completion and hover for Camel URIs as property values of
camel.sink.url and camel.source.url
- Completion and hover for
connector.class property value based on Camel Kafka Connector Catalog.
- Completion and hover for
camel.sink.* and camel.source.* property keys based on Camel Kafka Connector Catalog.
- Completion for
key.converter and value.converter property values based on Camel Kafka Connector Catalog.
- Completion for
transforms.*.type property values based on Camel Kafka Connector Catalog.
- Completion for [basic configuration|https://camel.apache.org/camel-kafka-connector/latest/basic-configuration.html]
- Diagnostic in Camel Kafka Connector files:
- for invalid
camel.(source|sink).(endpoint|path).* property keys. A quickfix is provided as well for close property keys.
- for mix of source and sink property keys
- for mix of
camel.(source|sink).(endpoint|path).* and camel.(source|sink).url usage
- for duplicated keys differentiated by dash case or camel case
It is possible to use a specific Camel Catalog version. This can be specified in File -> Preferences -> Settings -> Apache Camel Tooling -> 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, you need to configure extra repositories. See in Camel Language Server documentation.
It is possible to use a specific Runtime provider for the Camel catalog. This can be specified in File -> Preferences -> Settings -> Apache Camel Tooling -> Camel catalog runtime provider
Additional Camel components can be provided. This can be specified in File -> Preferences -> Settings -> Apache Camel Tooling -> Extra-components -> Edit in settings.json
You can add a list of Camel components definition. This json definition can be found in jar of the Camel component. You will end up with something like:
{
"camel.extra-components": [{
"component": {
...
},
"componentProperties": {
...
},
"properties": {
...
}
}]
}
It is possible to use dashed notation in properties file and Camel K modelines. By default, the completion is using the camel cased notation. It is using the dashed notation when there is another Camel property already using dashed notation in the same file.
For detailed information about Apache Camel supported features, see the Language Server GitHub page.
If you run into an issue or have a suggestion, you can report it by creating a new issue on GitHub.
How to install
You can download this Language Support for Apache Camel extension from the Visual Studio Code Marketplace at https://marketplace.visualstudio.com/items?itemName=camel-tooling.vscode-apache-camel.
After you install VS Code, follow these steps:
- In VS Code, select View > Extensions.
- Search for Camel.
- Select the Language Support for Apache Camel option and then click Install.
Requirements for using this extension
- Java 11 is currently required to launch the Camel Language Server. The
java.home VS Code preferences can be used to use a different version of JDK than the default one installed on the machine.
After you install this Language Support for Apache Camel extension, follow these guidelines to access its features:
For an XML DSL file:
For a Java DSL file:
- Use a
.java file extension.
- Specify Camel (usually from an imported package).
For example:
import org.apache.camel.builder.RouteBuilder
- To reference the Camel component, use
from or to and a string without a space. The string cannot be a variable. For example, from("timer:timerName") works but from( "timer:timerName") and from(aVariable) do not work.
Data and Telemetry
The VS Code Language support for Apache Camel extension collects anonymous usage data and sends it to Red Hat servers to help improve our products and services. Read our privacy statement to learn more. This extension respects the redhat.elemetry.enabled setting which you can learn more about at https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting
