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 a variety of IntelliJ IDEs, paid and community editions, including IDEA and WebStorm. Check https://www.jetbrains.com/ to find out which option is best for you.
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 > CDS.
- 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 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.
Note: Support for Community editions of IntelliJ IDEs is currently in beta stage and requires manual installation
from GitHub. Tap Shift twice, then select Install Plugin from Disk...
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) |
| LSP4IJ plugin | LSP support in IntelliJ | Red Hat |
| Symptom | Solution |
|---|---|
| SAP CDS Language Support for IntelliJ is not enabled in the IDE. | 1.x versions of the plugin are not compatible with the free IntelliJ Community Edition. Make sure you are using a version ≥ 2.x of the plugin. |
| 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 LSP4IJ plugin, the CDS Language Support Plugin, the LSP client–server (stdio) communication, 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.
To include any errors occurring in the LSP4IJ Plugin in the IDE logs, click View > Tool Windows > Language Servers. Click on CDS Language Server. On the right-hand side, open the Debug tab on the right and select Error reporting: In log. After selecting Trace: Verbose, you'll find the stdio communication after clicking on the language-server instance (below 'CDS Language Server' on the left) and opening the Traces tab on the right.
To include debug logs produced by 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 (omit sub-categories if not needed):
cds-intellij
cds-intellij/TextMate Bundle
cds-intellij/Code Style
cds-intellij/Language Server
- Click OK to save the settings.
To enable further logging and debugging, enable plugin debug mode by setting the following environment variable for your IDE 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
Restart the IDE to apply the changes.
This setting will enable:
- logging of the stdio communication between the LSP client and server (i.e., the LSP messages),
- tracing for the LSP server (see below),
- Node.js debugging for the LSP server, allowing you to attach a debugger.
Open the stdio logs by going to Tools > CDS > LSP Stdio Logs > Show Log File in your IDE. Alternatively, copy the file path by going to Tools > CDS > LSP Stdio Logs > Copy Log File Path.
Alternatively, find the log file in the plugin directory, at lib/cds-lsp/stdio.json.
Open the LSP server logs by going to Tools > CDS > LSP Server Logs > Show Log File in your IDE. Alternatively, copy the file path by going to Tools > CDS > LSP Server Logs > Copy Log File Path.
Alternatively, find the log file in your system temporary directory, sub-folder cdxlsp.
Alternatively, if your project has a subfolder .cds-lsp with a file .settings.json inside, the LSP server will log to that folder instead.
LSP-server tracing is set to level verbose by default in plugin debug mode.
To change verbosity, add the setting CDS_LSP_TRACE_COMPONENTS=*:debug to the environment variables for the LSP server by going to File > Settings > Languages & Frameworks > CDS in your IDE and adding it to the Additional env for LSP server field (separate multiple env variables with a semicolon). Restart the IDE to apply the changes.
Available trace levels are infrastructure, error, warning, info, verbose, and debug (ascending verbosity).
To disable tracing, set CDS_LSP_TRACE_COMPONENTS= (empty value).
Note that for large projects, more verbose tracing may significantly inflate logs and negatively impact performance. Use it with care.
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.