Welcome to SAP CDS Language Support for IntelliJ. It is a plugin for IntelliJ IDEs that provides editing and development support for the CDS language as used in the SAP Cloud Application Programming Model (CAP).
Look at our comprehensive list of features.
This plugin is compatible with the latest paid IntelliJ IDEs including IDEA Ultimate and WebStorm. Check https://www.jetbrains.com/ to find out which option is best for you.
The LSP API is only available in commercial IntelliJ IDEs, which is why the plugin doesn't run in the free variants (such as IntelliJ Community).
Tested on Windows, macOS, and Linux.
Prepare your environment:
- Install
on your computer if not already present.
- Register the new Node.js installation in your IntelliJ IDE by going to File > Settings > Languages & Frameworks > Node.js and adding the Node.js interpreter.
- If you have installed the SAP CDS Language Support for IntelliJ plugin from a ZIP file before, uninstall it.
- Note: we have reset the current plugin version to
1.0.0for the first JetBrains Marketplace release, to clarify that the feature set (based on the current LSP API) is still incomplete.
- Note: we have reset the current plugin version to
Install or update the plugin:
- In your IntelliJ IDE, go to File > Settings > Plugins.
- Click the Marketplace tab.
- Search for "SAP CDS Language Support" and click Install.
Alternatively, you can install the plugin from the JetBrains Marketplace:
- Go to the plugin homepage and hit the "Install to …" button.
- Open your IntelliJ IDE and follow the instructions in the dialog that appears.
Create an issue in this repository if you find a bug or have questions about the content.
For additional support, ask a question in SAP Community.
- Language servers: provide language-specific features like code completion, diagnostics, etc.
- Language Server Protocol (LSP): common protocol for communication between IDEs and language servers.
SAP CDS Language Support for IntelliJ is based on the following components:
| Component | Role | Publisher |
|---|---|---|
| CDS Language Server (cds-lsp, running on Node.js) | SAP CDS Language Support | SAP |
| CDS TextMate bundle | CDS syntax highlighting | (shipped with cds-lsp) |
| IntelliJ LSP API | LSP support in IntelliJ | JetBrains |
| Symptom | Solution |
|---|---|
| SAP CDS Language Support for IntelliJ is not enabled in the IDE. | 🚫 The plugin is not compatible with the free IntelliJ Community Edition. Make sure you are using a commercial IntelliJ IDE such as IDEA Ultimate or WebStorm. |
| SAP CDS Language Support for IntelliJ version 7 or 8 cannot be updated to the current version. | The plugin version has been reset to 1.0.0 for the first JetBrains Marketplace release. Uninstall the previous version of the plugin. Install the latest version from the JetBrains Marketplace. |
| CDS file icons are missing and/or no syntax highlighting | Uninstall any previous versions of the plugin (File > Settings > Plugins). Remove the 'cds' TextMate Bundle (File > Settings > Editor > TextMate Bundles). Restart the IDE. Install the latest plugin version. |
To aid support, please include relevant log files in your report. Depending on the kind of problem encountered, you may want to include the logs from the IDE, the LSP client and/or the LSP server.
Logs produced by the IDE can be found by opening the Help menu and selecting Show Log in . See Locating IDE log files for more information.
Logging of the stdio communication between the LSP client and server (i.e., the protocol messages) can be activated by modifying your IDE's vmoptions file:
- Edit the file specific to your IntelliJ installation by opening the IDE and going to Help > Edit Custom VM Options....
- Add the following line:
-DDEBUG=cds-lsp
Alternatively, set the following environment variable for your IDE:
DEBUG=cds-lsp
These settings will also enable debug logging for the LSP server.
After restarting the IDE, find the logs in the plugin directory, at lib/cds-lsp/stdio.json.
To include debug logs produced by the LSP client (part of the IDE) and the SAP CDS Language Support for IntelliJ plugin, you need to enable the corresponding settings in the IDE:
- Open the Help menu and select Diagnostic Tools > Debug Log Settings….
- In the dialog that opens, add the following lines:
#com.intellij.platform.lsp
#cds-intellij
- Click OK to save the settings.
The LSP server logs to its own file, which you can locate by opening your system temporary directory, then the sub-folder cdxlsp, and finally heading to the file most recently modified at the time of the reported problem.
Hint: depending on your operating system, the temporary directory may be at one of the following locations:
| OS | Default location | Environment variables | Command |
|---|---|---|---|
| Windows | C:\Users\[username]\AppData\Local\Temp | %TEMP% | |
| macOS, Linux | /tmp | $TMPDIR | node -e "console.log(os.tmpdir())" |
If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.
Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.
Copyright © 2024 JetBrains s.r.o. IntelliJ IDEA and the IntelliJ IDEA logo are registered trademarks of JetBrains s.r.o.