{"id":19755843,"url":"https://github.com/cap-js/cds-intellij","last_synced_at":"2026-03-07T16:03:25.971Z","repository":{"id":229004158,"uuid":"768115323","full_name":"cap-js/cds-intellij","owner":"cap-js","description":"SAP CDS Language Support for IntelliJ","archived":false,"fork":false,"pushed_at":"2025-04-22T10:36:28.000Z","size":1269,"stargazers_count":14,"open_issues_count":10,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-22T10:59:19.747Z","etag":null,"topics":["cap","cds","intellij-plugin"],"latest_commit_sha":null,"homepage":"https://cap.cloud.sap/docs/cds/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cap-js.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-06T13:53:23.000Z","updated_at":"2025-04-10T15:33:27.000Z","dependencies_parsed_at":"2024-03-26T11:30:59.786Z","dependency_job_id":"5c24075a-7171-4c69-a075-04fd20fdfaec","html_url":"https://github.com/cap-js/cds-intellij","commit_stats":null,"previous_names":["cap-js/cds-intellij"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cap-js%2Fcds-intellij","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cap-js%2Fcds-intellij/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cap-js%2Fcds-intellij/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cap-js%2Fcds-intellij/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cap-js","download_url":"https://codeload.github.com/cap-js/cds-intellij/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251691530,"owners_count":21628336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cap","cds","intellij-plugin"],"created_at":"2024-11-12T03:13:41.371Z","updated_at":"2026-03-07T16:03:25.964Z","avatar_url":"https://github.com/cap-js.png","language":"Java","funding_links":[],"categories":["Tools"],"sub_categories":[],"readme":"![SAP CDS Language Support for IntelliJ](.assets/logo.png) [![IntelliJ](.assets/IntelliJ_IDEA_icon.svg)](https://www.jetbrains.com/)\n\n# SAP CDS Language Support for IntelliJ\n\n[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/cds-intellij)](https://api.reuse.software/info/github.com/cap-js/cds-intellij)\n[![Main build passing](https://github.com/cap-js/cds-intellij/actions/workflows/main.yml/badge.svg)](https://github.com/cap-js/cds-intellij/actions/workflows/main.yml)\n[![Release build passing](https://github.com/cap-js/cds-intellij/actions/workflows/release.yml/badge.svg)](https://github.com/cap-js/cds-intellij/actions/workflows/release.yml)\n![IntelliJ Version](https://img.shields.io/jetbrains/plugin/v/com.sap.cap.cds)\n\u003c!-- ![IntelliJ Downloads](https://img.shields.io/jetbrains/plugin/d/com.sap.cap.cds) --\u003e\n\n## Description\n\nWelcome to **SAP CDS Language Support for IntelliJ**. It is a plugin for [IntelliJ](https://www.jetbrains.com/idea/) IDEs\nthat provides editing and development support for the [CDS](https://cap.cloud.sap/docs/cds/) language as used in the SAP Cloud Application Programming Model (CAP).\n\n### Features\n\nLook at our [comprehensive list of features](./FEATURES.md).\n\n![Code Completion](.assets/syntax+completion+diagnostics.png)\n\n## Requirements\n\n### Supported IDEs\n\nThis plugin is compatible with a [variety of IntelliJ IDEs](https://plugins.jetbrains.com/plugin/25209-sap-cds-language-support), **paid** and **community** editions, including IDEA and WebStorm.  Check https://www.jetbrains.com/ to find out which option is best for you.\n\n### Operating Systems\n\nTested on Windows, macOS, and Linux.\n\n\n## Download and Installation\n\nPrepare your environment:\n\n1. Install [![required Node.js version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.unpkg.com%2F%40sap%2Fcds-lsp%2Fpackage.json\u0026query=%24.engines.node\u0026label=Node.js\u0026cacheSeconds=3600)](https://nodejs.org/en/)\n   on your computer if not already present.\n2. Register the new Node.js installation in your IntelliJ IDE by going to *File \u003e Settings \u003e Languages \u0026 Frameworks \u003e CDS*.\n3. If you have installed the SAP CDS Language Support for IntelliJ plugin from a ZIP file before, uninstall it.\n     - Note: we have reset the current plugin version to `1.0.0` for the first JetBrains Marketplace release, to clarify that the feature set is still incomplete.\n\nInstall or update the plugin:\n\n1. In your IntelliJ IDE, go to *File \u003e Settings \u003e Plugins*.\n2. Click the _Marketplace_ tab.\n3. Search for \"SAP CDS Language Support\" and click *Install*.\n\n**Note:** Support for **_Community_** editions of IntelliJ IDEs is currently in **beta** stage and requires manual installation\nfrom [GitHub](https://github.com/cap-js/cds-intellij/releases). Tap `Shift` **twice**, then select _Install Plugin from Disk..._\n\n\n## How to Obtain Support\n\n[Create an issue](https://github.com/cap-js/cds-intellij/issues) in this repository if you find a bug or have questions about the content.\n\nFor additional support, [ask a question in SAP Community](https://answers.sap.com/questions/ask.html).\n\n#### Terms\n\n- Language servers: provide language-specific features like code completion, diagnostics, etc.\n- Language Server Protocol (LSP): common protocol for communication between IDEs and language servers.\n\nSAP CDS Language Support for IntelliJ is based on the following components:\n\n| Component                                                                                       | Role                                                                             | Publisher              |\n|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|------------------------|\n| [CDS Language Server](https://www.npmjs.com/package/@sap/cds-lsp) (cds-lsp, running on Node.js) | SAP CDS Language Support                                                         | SAP                    |\n| CDS TextMate bundle                                                                             | CDS syntax highlighting                                                          | (shipped with cds-lsp) |\n| [LSP4IJ plugin](https://plugins.jetbrains.com/plugin/23257-lsp4ij)                              | [LSP](https://microsoft.github.io/language-server-protocol/) support in IntelliJ | Red Hat                |\n\n\n### Known Compatibility Issues\n\n| Symptom                                                                                        | Solution                                                                                                                                                                                                           |\n|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 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.                                                             |\n| CDS file icons are missing and/or no syntax highlighting                                       | Uninstall any previous versions of the plugin *(File \u003e Settings \u003e Plugins)*. Remove the 'cds' TextMate Bundle *(File \u003e Settings \u003e Editor \u003e TextMate Bundles)*. Restart the IDE. Install the latest plugin version. |\n\n### Logs\n\nTo aid support, please include relevant log files in your report.\nDepending 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**.\n\n#### IDE Logs\n\nLogs produced by the IDE can be found by opening the _Help_ menu and selecting *Show Log in \u003cplatform-dependent tool\u003e*.\nSee [Locating IDE log files](https://intellij-support.jetbrains.com/hc/en-us/articles/207241085-Locating-IDE-log-files) for more information.\n\n#### LSP4IJ Plugin Logs and Stdio Communication\n\nTo include any errors occurring in the LSP4IJ Plugin in the IDE logs, click *View \u003e Tool Windows \u003e 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.\n\n#### CDS Language Support Plugin Logs\n\nTo include debug logs produced by the SAP CDS Language Support for IntelliJ plugin, you need to enable the corresponding settings in the IDE:\n- Open the _Help_ menu and select _Diagnostic Tools \u003e Debug Log Settings…_.\n- In the dialog that opens, add the following lines (omit sub-categories if not needed):\n```\ncds-intellij\ncds-intellij/TextMate Bundle\ncds-intellij/Code Style\ncds-intellij/Language Server\n```\n- Click _OK_ to save the settings.\n\n#### Plugin Debug Mode\n\nTo 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:\n- Edit the file specific to your IntelliJ installation by opening the IDE and going to *Help \u003e Edit Custom VM Options...*.\n- Add the following line:\n```\n-DDEBUG=cds-lsp\n```\n\nAlternatively, set the following environment variable for your IDE:\n```\nDEBUG=cds-lsp\n```\n\nRestart the IDE to apply the changes.\n\nThis setting will enable:\n- **tracing** for the LSP server (see below),\n- Node.js **debugging** for the LSP server, allowing you to attach a debugger.\n\n##### Stdio Logs\n\nOpen the stdio logs by going to *View \u003e Tool Windows \u003e Language Servers*, selecting the CDS Language Server, and viewing the *Traces* tab.\n\nAlternatively, find the log file in the [plugin directory](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs), at `lib/cds-lsp/stdio.json`.\n\n##### LSP Server Logs and Tracing\n\nOpen the LSP server logs by going to *Help \u003e Find Action \u003e CDS \u003e LSP Server Logs \u003e Show Log File* in your IDE. Alternatively, copy the file path by going to *Tools \u003e CDS \u003e LSP Server Logs \u003e Copy Log File Path*.\n\nThe log file will be located:\n- in your system temporary directory, sub-folder `cdxlsp`, by default;\n- in a subfolder `.cds-lsp` of your project, if that subfolder contains a `.settings.json` file.\n\n###### Trace Level\n\nLSP-server tracing is set to level `verbose` by default in _plugin debug mode_.\n\nTo change verbosity, add the setting `CDS_LSP_TRACE_COMPONENTS=*:debug` to the environment variables for the LSP server by going to *File \u003e Settings \u003e Languages \u0026 Frameworks \u003e 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.\n\nAvailable trace levels are `infrastructure`, `error`, `warning`, `info`, `verbose`, and `debug` (ascending verbosity).\nTo disable tracing, set `CDS_LSP_TRACE_COMPONENTS=` (empty value).\n\nNote that for large projects, more verbose tracing may significantly inflate logs and negatively impact performance. Use it with care.\n\n\n## Contributing\n\nIf 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](https://developercertificate.org/).\n\n\n## Telemetry and Data Collection\n\nThis plugin collects usage data to help improve SAP products and enhance the user experience. The collected data is sent to SAP in accordance with our [Privacy Statement](https://www.sap.com/about/legal/privacy.html).\n\nIf you prefer not to share usage data, you can disable telemetry by setting `sapbas.telemetryEnabled` to false in your IDE settings: *File \u003e Settings \u003e Languages \u0026 Frameworks \u003e CDS \u003e Language Server \u003e Telemetry*.\n\n\n## License\n\nCopyright (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](LICENSE) file.\n\nCopyright © 2024 JetBrains s.r.o. IntelliJ IDEA and the IntelliJ IDEA logo are registered trademarks of JetBrains s.r.o.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-js%2Fcds-intellij","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-js%2Fcds-intellij","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-js%2Fcds-intellij/lists"}