@sap/cds-lsp

# Changelog All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org/). The format is based on [Keep a Changelog](https://keepachangelog.com/). ## 9.9.0 - 2026-04-22 ### Added - WorkspaceSymbols API: `/x` to get index flags - WorkspaceSymbols: also include models defined in build tasks ### Fixed - support lookup dirs defined in subfolders e.g. pom.xml (resolve cds env per project root instead of workspace root) - WorkspaceSymbols: NodeJS V8 crashed for very large workspaces - WorkspaceSymbols: filter out symbols from ignored files - add quotes around the binary in the default cds-typer command to support paths with non-alphanumeric characters ### Also see - `@sap/cds-compiler` 6.9.0 ## 9.8.0 - 2026-03-08 ### Fixed - running CDS Typer in WSL projects - indentation of annotations to entities with annotated actions ### Also see - `@sap/cds-compiler` 6.8.0 ## 9.7.0 - 2026-01-29 ### Added - support for multi-cursor range expansion/shrinking - support folding ranges, especially for consecutive `using` statements ### Fixed - formatter: align element names after `key` keyword only ### Also see - `@sap/cds-compiler` 6.7.1 ## 9.6.3 - 2026-01-12 ### Added - JSON schema for user settings - progress reporting for persistency operations ### Changed - disable type generation for current session when preconditions not fulfilled after first try ### Fixed - element formatting: align names after `key` keyword only ## 9.6.2 - 2026-01-02 ### Fixed - CSN files cannot be persisted currently - telemetry issue ## 9.6.1 - 2026-01-02 ### Fixed - crash when starting server ## 9.6.0 - 2025-12-29 ### Added - (Experimental) persistency of where-used index This feature allows to persist/restore where-used indexes on a per-file basis to speed up indexing of large projects with many root models. It is currently experimental and must be enabled via user setting `cds.workspace.persistency.enabled`. There are a couple of user settings to fine tune the behavior + `cds.workspace.persistency.enabled`: general enablement. All other settings have no effect if this is disabled. + `cds.workspace.persistency.persistAfterSave`: when a file is saved its index is persisted. + `cds.workspace.persistency.persistAfterCompile`: when (closed) CDS files are compiled (also as part of another model compilation) their index gets persisted. + `cds.workspace.persistency.restoreBeforeCompile`: when CDS files are part of a compilation their persisted index is used if matching + `cds.workspace.persistency.restoreAfterStartup`: restore all persisted indexes after start-up + `cds.workspace.persistency.indexAllAfterStartup`: index all files not yet persisted + `cds.workspace.persistency.garbageCollectOrphanedIndexesAfterStartup`: index files are written per content. Delete index files with outdated content after start-up + `cds.workspace.persistency.garbageCollectOrphanedIndexesAfterNSaves`: Delete index files with outdated content after specified number of `Save` requests + `cds.workspace.persistency.reindexAfterCompileIfRestored`: If files are part of a compilation and a matching index exist, still index again. ### Fixed - Syntax highlighting in bracketed expressions ### Changed - `@sap/cds-lsp` now uses es2024 (NodeJS 22) as bundled output format - Custom request `cds/statusMessage` now supports an `id` argument for better UX and simpler life-cycle. Clients must close a currently shown status bar item with the same id before showing a new one with the id. ### Removed - User setting `cds.workspace.debounceFastChanges`, now always enabled ### Also see - `@sap/cds-compiler` 6.6.0 ## 9.5.1 - 2025-11-28 ### Changed - Compatibility with `@sap/cds 9.5` ### Also see - `@sap/cds-compiler` 6.5.0 - `@sap/cds` 9.5.0 ### Fixed - Syntax highlighting in `annotate` statements with constraints containing function calls ## 9.5.0 - 2025-11-24 ### Added - `format-cds` CLI + support piping - format single src from stdin to stdout + support forward-slashed paths on Windows - Telemetry without client. Can be disabled via user setting `sapbas.telemetryEnabled` ### Changed - `*.json` files are no longer scanned and parsed heuristically if they contain CSN. Those files need to be used from a CDS file to be seen e.g. in `Workspace Symbols`. However, files ending with `.csn.json` or `.csn` are still considered as CSN files. ## 9.4.0 - 2025-09-29 ### Fixed - Code completion for annotations: + In certain cases proposals added a superfluous `@` character + Entries in annotation expressions could be shown twice + SQL functions could have been suggested in annotation expressions ### Removed - Temporary user setting `cds.workspace.fastDiagnosticsMode`. The default so far `clear` is now the only mode. ### Also see - `@sap/cds-compiler` 6.4.0 ## 9.3.0 - 2025-08-29 ### Changed - Important: minimum required NodeJS version is now 22.15.1 ### Fixed - Element names are now correctly highlighted even without type specification ### Also see - `@sap/cds-compiler` 6.3.0 ## 9.2.1 - 2025-08-08 ### Changed - OData Annotation Modeler's sub features can be enabled distinctively. For performance reasons, **only _code completion_ and _hover_ are enabled by default**. Enable others via user settings: `cds.contributions.features.<feature>` - Performance optimizations when updating dependency net of CDS file dependencies ### Fixed - _Using_ paths which end with a folder name were not resolved correctly - Formatter support for `==` operator ### Also see - `@sap/cds-compiler` 6.2.2 ## 9.2.0 - 2025-07-29 ### Added - goto implementation for NodeJS services, entities, events, actions and functions, services and entities for Java ### Also see - `@sap/cds-compiler` 6.2.0 ## 9.1.2 - 2025-07-21 ### Added - Formatting options `whitespaceBeforeColonInParamList` and `whitespaceAfterColonInParamList` to control whitespace around colons in parameter lists ### Fixed - Workspace symbols could have been incomplete due to a bug in the where-used index ## 9.1.1 - 2025-07-10 ### Changed - Maximum log-file size can now be increased to at most 1 GB (default limit unchanged at 10 MB) - Telemetry: + error reporting now sends same error only once per session + periodic statistics changed from every 5 minutes to every 30 minutes ### Fixed - Colons in type paths are no longer aligned with other colons, nor are they padded with spaces ## 9.1.0 - 2025-06-30 ### Added - Performance/Responsiveness: + Reduce _"lagging red underline"_ while typing - configurable via user setting `cds.workspace.fastDiagnosticsMode` + Outdated compilations in background are aborted fast. This increases responsiveness and reduces CPU usage and is especially useful for large projects with many files. - Formatter: New option `argsInNewLine` to put multiple arguments to e.g. function calls on a new line - Document/Workspace Symbols: use distinct kinds for `Association` and `Composition` elements ### Changed - Formatter: Chained method-like function calls are now broken into separate lines ### Fixed - Formatter: + Original empty lines are now correctly preserved before single-lined blocks + Separate alignment of annotations before resp. within projection-like entities ### Also see - `@sap/cds-compiler` 6.1.0 ## 9.0.1 - 2025-06-02 ### Added - Support for Node.js 24 ### Also see - `@sap/cds-compiler` 6.0.10 ## 9.0.0 - 2025-05-27 ### Added - formatting option `boolOpsAtLineEnd` to position `and`, `or` operators at line end - Hovering over errors shown explanation for many error types - Hovering over built-in types shows documentation ### Changed - Change license from SAP DEVELOPER LICENSE AGREEMENT '3.1' to '3.2 CAP v2' - where-used functionality now based on new index - more compact formatting of `case` statements ### Fixed - Separate alignment of annotations to entity and select items - Highlighting of parenthesized annotations with strings containing a colon - Highlighting of comments in queries ### Also see - `@sap/cds-compiler` 6.0.8 ## 8.9.1 - 2025-04-07 ### Fixed - Formatting of annotations in parentheses with values containing spaces ## 8.9.0 - 2025-04-01 ### Fixed - Auto update of **Annotation Modeler** plugin did not work - _Document highlights_ could show wrong ranges for namespaces ### Changed - _Initialize_ request now accepts _initializationOptions_ with top-level `cds` child. Previously only the direct children of the `cds` user settings node were accepted - this is now deprecated and will be removed in next major. ### Also see - `@sap/cds-compiler` 5.9.0 ## 8.8.1 - 2025-03-17 ### Changed - new CDS parser is used ### Also see - `@sap/cds-compiler` 5.8.2 ## 8.8.0 - 2025-03-05 ### Added - `format-cds` CLI now considers ignore files like `.cdsignore` and `.gitignore` - preparation to support new CDS parser - support documentLink resolution for `LSP4IJ`-based IDE integrations ### Changed - minimum required NodeJS version is now 20.15.1 ### Also see - `@sap/cds-compiler` 5.8.0 ## 8.5.1 - 2024-12-02 ### Changed - enabling `newParser` via `cds.env` will no longer interfer with language server - improved telemetry messages ### Also see - `@sap/cds-compiler` 5.5.2 ## 8.5.0 - 2024-11-26 ### Added - Report request statistics via `telemetry/event` notification to client. Enable via process env var `CDS_LSP_TELEMETRY_FEATURE=true` ### Removed - With `@sap/cds 8.5.0` one of the default locations for translation folders (`assets/i18n`) was removed ### Also see - `@sap/cds-compiler` 5.5.0 ## 8.4.5 - 2024-11-13 ### Added - refactoring `using` statements when renaming/deleting files or folders now considers ignore files (.cdsignore or .gitignore) and will not refactor ignored files ### Changed - (performance) expensive workspace scanning is only done during renaming/deleting files or folders if those contain CDS files ## 8.4.4 - 2024-11-08 ### Added - user setting to disable refactoring support when renaming/deleting CDS files (`cds.refactoring.files.rename.enabled` and `cds.refactoring.files.delete.enabled`) ### Changed - performance improved when scanning the workspace and calculating refactorings when renaming/deleting CDS files ### Also see - `@sap/cds-compiler` 5.4.2 ## 8.4.3 - 2024-11-05 ### Fixed - deleting CDS files will now suggest to remove `using` statements without artifacts ## 8.4.2 - 2024-11-02 ### Added - Rename or move of CDS files and folders will update all `using` statements to the renamed file - Deletion of CDS files or folders will show all `using` statements to the renamed file with possibility to remove those. Note: The referencing files will likely have compilation errors afterward. ### Fixed - highlighting of escaped identifiers and parameter lists - `using` path proposals could have been suggesting JS files instead of CDS files in certain cases - on Windows if client mixes upper- and lowercase drive letters some requests could have failed - CDS Typer was called when deleting a file which led to a misleading error output - Analysis of dependencies failed when handling non-npm `package.json` files (e.g. from `pnpm` lacking `name` property) ### Changed - minimum required NodeJS version is now (back to) 20.9.0 ### Also see - `@sap/cds-compiler` 5.4.0 ## 8.3.2 - 2024-10-01 ### Added - support for annotation modeler to remove certain code completions from compiler in favor of more suitable ones - show absolute name and kind of artifact in hover and completion details - analyze-dependencies command now supports rendering to `svg` or `json` string ### Fixed - highlighting of CASE-statement keywords when put in their own line - analysis of dependencies for certain cases ### Changed - minimum required NodeJS version is now 20.15.1 ### Also see - `@sap/cds-compiler` 5.3.0 ## 8.2.1 - 2024-08-30 ### Added - code completion for artifacts within `using` statements now also completes single name segments with complete name ### Changed - minimum required NodeJS version is now 20.9.0 - hover and completion proposal details now show artifact kind ### Fixed - highlighting of element names in annotate statements and of special element names `entity`, `type`, `event` - completion: rename of source folders led to wrong using path proposals - completion: using path proposals did not work in multi-line using statements - maintain translation quickfix sent wrong document version ### Also see - `@sap/cds-compiler` 5.2.0 ## 8.0.0 - 2024-06-25 ### Changed - cds-lsp will use embedded cds-compiler (v5) if compiler in workspace is < v5 ### Fixed - highlighting of annotations after bracketed expressions and comments in parameter lists - exception in graphical file dependency analysis - node version check now runs outside bundle ### Also see - `@sap/cds-compiler` 5.0.4 ## 7.9.1 - 2024-05-10 ### Fixed - `annotate` elements snippet now functions correctly near annotations to elements ## 7.9.0 - 2024-05-03 ### Fixed - code completion for elements snippet now works when annotating artifacts using paths such as `MyService.SomeEntity` or when triggered at particular positions including line start - some installations of IntelliJ on Windows did not work properly due to different URI encoding - maintain translation quickfix could have used an existing translation file of a reuse component ### Also see - `@sap/cds-compiler` 4.9.0 ## 7.8.2 - 2024-04-09 ### Fixed - performance issue with indexing CDS files with many annotations ## 7.8.1 - 2024-04-07 ### Changed - formatter now puts `actions` keyword after projection or query in a new line ### Fixed - workspace/symbols request could have shown interactive popup if LSP plugins are slow - indexing of entities with enum elements that led to wrongly reported unused imports - indexing of namespaces after internal XSN changes ## 7.8.0 - 2024-03-25 ### Changed - formatting logging now includes whitespace even if it may be reduced to empty string, relative alignment positions, and details on inserting delayed items ### Fixed - code completion for annotations with `![]` identifiers ### Also see - `@sap/cds-compiler` 4.8.0 ## 7.6.1 - 2024-02-26 ### Fixed - elements snippet now works when annotating artifacts in namespaces and/or contexts or if the brace after the elements is still missing ## 7.6.0 - 2024-02-07 ### Added - `format-cds` CLI now supports `--check` which tests given CDS sources if formatted according settings and fails otherwise (for CI/CD). For some erroneous CDS sources which cannot be formatted the exit code is `2`. - hover over import path of `using` statement shows `README.md` or `package.json#description` if absolute (i.e. module) import ### Changed - formatting option `alignAfterKey` option now applies to views and projections as well - supportability: snapshot versions are now shown in log already with `verbose` level - cds-lsp is now using `es2022` ### Fixed - removed padding after unary plus, minus or parameter colon - artifact-elements snippet in `annotate` statement now appears regardless of cursor position between braces (or logs reason for not appearing) - highlighting after semicolon in certain contexts - on Windows editor potentially no longer updated diagnostics for sources with annotations - wrong diagnostics about unused imports - first code completion could have been slow as workspace was scanned unnecessarily - code completion for annotations was not shown in certain cases - `untitled` i.e. new not yet saved files no longer worked in VSCode ### Also see - `@sap/cds-compiler` 4.6.2 ## 7.5.0 - 2023-12-20 ### Added - unused imports are reported as warning and grayed out incl. quickfix to remove them - snippet proposals for artifact elements in an `annotate` statement - new user setting `cds.contributions.enablement.additionalAnalyticalAnnotations` (default: off) to get annotation support for analytical queries (experimental) ### Fixed - padding and highlighting of identifiers with Unicode characters - highlighting of `stored` keyword ## 7.4.0 - 2023-11-16 ### Changed - minimum required NodeJS version is now 18.15.0 - formatting of projections now similar to that of views - trace overhead is now zero if turned off, but trace components must be set once before starting the language server via environment var e.g. `CDS_LSP_TRACE_COMPONENTS=*:error,workspace:info` - markdown formatting inside doc comments is now done with `marked` parser AST instead of `remark`. Previously, this was enabled by default but due to slightly different formatting this feature is disabled by default, now. Thus, already formatted markdown won't be changed and thus won't lead to file changes when used in CI/CD via `format-cds` command. Enable it via user setting `formatDocComments`. ### Fixed - padding of quoted identifiers - treat only /** (no additional asterisks) as start of doc comments - highlighting of comments within braced select item lists - update of diagnostics could have got lost ### Removed - workspace validation modes `OpenEditorsAndDirectSources` and `OpenEditorsDirectSourcesAndDirectDependencies` are no longer supported. In real-world models they led to high CPU usage and slow responsiveness. Any of these user setting values are now treated as `ActiveEditorOnly` if supported by IDE, else `OpenEditorsOnly`. ### Added - (Experimental): `cds-lsp` can now be used in-process. `ServerStarted.start` method has new optional `options` parameter which allows to use any [supported values](https://github.com/microsoft/vscode-languageserver-node/blob/c4f80308b155d79cc479ec9d33fba254ba93fdd2/client/src/main.ts#L134-L136) e.g. Readable/WritableStream. ### Also see - `@sap/cds-compiler` 4.4.0 ## 7.3.0 - 2023-10-09 ### Added - support for `cdsc.moduleLookupDirectories` ### Changed - formatting of action and function parameters according to existing newlines ### Fixed - highlighting of identifiers, annotations, actions, functions, comments, and more - highlighting of queries in entity definitions - highlighting of keywords and literals in `type` statements - formatting of escaped names and `order by` clauses ### Also see - `@sap/cds-compiler` 4.3.0 ## 7.2.0 - 2023-09-03 ### Changed - refactored data structures of where-used index to keep file indexes independent of each other - (beta): reuse file indexes in most situations to speed up indexing - can be disabled via user setting `cds.workspaceValidationOptimistic` - annotation handler is only called for completion if cursor at reasonable annotation position - workspace symbol query has new switch `/a` to include auto-exposed entities - rewritten indexing of annotations to boost performance - resolution of reference AST nodes is now cached to boost performance - elements of `mixin`s now use `LSP.SymbolKind.Field` (was: Operator) for outline ### Fixed - highlighting of custom types starting with built-in name - explicit annotation definition is now searched in all file indexes as annotations are not dependent on imports via `using` statement - _semantic_ outline now only shows first non-empty line of docs as VSCode does not support multi-line docs in semantic outline ### Also see - `@sap/cds-compiler` 4.2.2 ## 7.0.0 - 2023-06-13 ### Added - support for `.d.ts` type generation from `cds` model files upon save - support for CDS ternary operator (highlighting, formatting, where-used) - support for `stored` elements (where-used) - support for annotated `returns` statements ### Also see - `@sap/cds-compiler` 4.0.0 ## 6.8.0 - 2023-05-02 ### Fixed - where-used index could be incomplete with latest OData annotation plugin - formatting of quoted identifiers enclosed in square brackets ### Added - custom request to get lsp properties - formatting and highlighting of ternary conditions ### Changed - now using Typescript 5.0 ### Also see - `@sap/cds-compiler` 3.9.2 ## 6.7.0 - 2023-03-31 ### Added - code completion for `using` paths now + supports mono repos + for _npm package_ proposals show details of `description` property of `package.json` unless `README.md` exists + improved ordering ### Changed - _Analyze Dependencies_ + folders which are npm package roots are rendered with their package name, in brown color + enhance contrast - use white font color for dark background colors + improved UX when installing required Graphviz extension ### Fixed - `format-cds` command-line tool failed to run - _Analyze Dependencies_ + some clusters (folders) with same parent cluster were rendered outside ### Removed - Quickfix to migrate (long-time removed) `cds.doc` annotation to doc comment ### Also see - `@sap/cds-compiler` 3.8.2 ## 6.6.1 - 2023-03-03 ### Fixed - `@sap/cds-lsp` could not be installed manually ## 6.6.0 - 2023-02-28 ### Added - type generation now detects project root - contribution api with new `indexAndValidate` callback ### Fixed - highlighting of the last of a number of element names in a projection - formatting of query `from A:B`: removed colon padding - type generation stopped working after failure until next LSP restart ### Changed - updated capire CDL docs - used in code completion details ### Also see - `@sap/cds-compiler` 3.7.2 ## 6.5.1 - 2023-02-20 ### Added - The special `up_` element is now supported in navigation - support of upcoming cds-compiler (3.6.3 `main` branch as of today) ### Changed - `mixin` is now mapped to `LSP.SymbolKind.Operator` (was default `String`) - a commit hash of the last commit is now included in release under _dist/state_ - target platform back to `es2020` for compatibility in China cloud (still Theia on Node14) ### Fixed - Closing a CDS file led to 'forgetting' the content in the index. This resulted in: + `workspace/symbols` not showing all definitions + error messages of symbols not found + navigation broken for 'closed' definitions - formatting and highlighting of nested element and enum extensions - code completion for keywords and identifiers may have used wrong compiler messages, thus not working as expected ### Removed - Legacy code to support cds-compiler v1 and v2 (vscode-cds contains cds-lsp 6.0.3 to continue support of those) ### Also see - `@sap/cds-compiler` 3.6.2 ## 6.5.0 - 2023-01-30 ### Added - _@sap/cds-lsp_ can now trigger a globally installed cds type generator when saving a model file. This feature is still **experimental** and must be enabled via user setting `cds.typeGenerator.enabled`. - The annotation contribution API has a new optional callback. Now a contribution can add where-used relationships inside annotations to the global where-used index. (A complete index is a prerequisite for refactoring.) The feature is still **experimental** and might change in future. ### Fixed - _workspace/symbols_ request didn't include definitions of a file after it was closed. ### Removed - `@sap/cds-lsp@6.5.0` no longer supports working with a `@sap/cds-compiler` <= 3. Please use `@sap/cds-lsp@6.0.3` when having an older compiler in your project. **Note:** our extension for _Visual Studio Code_ (`@sap/vscode-cds`) contains both mentioned versions of _@sap/cds-lsp_ to continue supporting all major compiler versions. - `@cds.doc` annotation, which was marked as deprecated for a long time, is no longer considered in requests like _document/hover_. Please use doc comments (`/** ... */`) instead. The quick fix to migrate from _@cds.doc_ to _doc comments_ is still in place, but is likely to be removed in near future. ### Also see - `@sap/cds-compiler` 3.6.0 ## 6.4.0 - 2022-12-15 ### Added - new formatting options `whitespaceBeforeColonInAnnotation` and `whitespaceAfterColonInAnnotation` for specific configuration in annotations ### Changed - non-inline pre-annotations are now prefixed with an empty line to separate them from preceding elements ### Also see - `@sap/cds-compiler` 3.5.0 ## 6.3.0 - 2022-11-01 ### Added - formatting of artifact and type extensions - syntax highlighting of element extensions - syntax highlighting of numbers and some known types ### Fixed - formatting of extensions with selectItems - format-cds script didn't find .cdsprettier.json ### Also see - `@sap/cds-compiler` 3.4.0 ## 6.2.2 - 2022-10-17 ### Added - cds-lsp bin script for easier integration into custom editors/IDEs ### Fixed - syntax highlighting of comments ### Removed - legacy custom ParseTreeCommand ## 6.2.0 - 2022-09-30 ### Added - document link resolution of 'folder' using paths to csn index files - new formatting options `keepPreAnnotationsInOriginalLine` and `keepPostAnnotationsInOriginalLine` - auto-exposed entities are now included in semantic Outline (user setting) - code completion for annotations on auto-exposed entities ### Removed - removed formatting option `keepAnnotationsInOriginalLine` (will be migrated to the new options when set in .cdsrc.json) ### Changed - improved Java compatibility of TextMate grammar ### Fixed - fixed syntax highlighting for `extend`, attribute names, type structs, new integer types, and some keywords - fixed formatting of bracketed expressions and annotations standing in their own lines - fixed formatting of actions and functions inside aspects - fixed alignment of multiple annotations per line ### Also see - `@sap/cds-compiler` 3.3.2 ## 6.0.3 - 2022-07-08 ### Changed - added authentication and new build task names to cds schema ## 6.0.2 - 2022-07-06 ### Fixed - fixed incompatibilities with compiler 3.0.2 ### Also see - `@sap/cds-compiler` 3.0.2 ## 6.0.0 - 2022-07-01 ### Added - support for new major cds-compiler 3.0.0 - new user setting `cds.workspaceSymbols.caseInsensitive` (default off) to search case-insensitive - new user setting `cds.outline.semantical` (default off) to show outline in a rather semantical structure as opposed to a flat list - analyze dependencies now supports coloring of layers for monorepos - env.cdsc is now also considered for code completion - custom requests to format given content with given options (e.g. for a _formatting options config UI_) and to get path of options file ### Changed - minimum required NodeJS version is now 16.11.1 - updated to Language Server Protocol v3.17.0 + definition request now returns both, name range and scope range ### Fixed - fixed glitches in cds schema support for `package.json`, `.cdsrc.json` and `.cdsrc-private.json` - fixed highlighting for empty block comments `/**/` ### Also see - `@sap/cds-compiler` 3.0.0 ## 5.5.9 - 2022-05-09 ### Added - support syntax highlighting for escape sequences in template strings - option to disable 'footprint' traces resulting in **no** overhead - code lens statistics ### Fixed - completion proposals inside comments to turn on/off formatting - find references could have shown wrong entries from localized context ### Changed - updated included capire docs ## 5.5.7 - 2022-04-05 ### Fixed - syntax highlighting in BAS ### Changed - consume cds-compiler 2.13.8 ## 5.5.6 - 2022-03-31 ### Added - unit test for textmate grammar ### Changed - ignore filtering is now lazy - formatting options docs are now generated - consume cds-compiler 2.13.6 ### Fixed - no longer set NODE_ENV to production - highlighting of single quoted strings ## 5.5.5 - 2022-03-03 ### Added - schema file for `cds` section in `package.json`, `.cdsrc.json` and `.cdsrc-private.json` ### Fixed - code completion for annotations no longer propose `@` if inside an annotation ## 5.5.4 - 2022-02-28 ### Added - new code-formatting options for `action`s and `function`s: + `alignActionNames` (aligns names) + `alignActionReturns` (aligns `returns` keywords) ### Changed - removed obsolete code-formatting option `alignAsInElements` (calculated fields use `=` now) - textmate grammar additionally compatible with Ruby regex engine ### Fixed - code formatting: + separate post-annotation with blank + remove erroneous newlines around cardinality and filter in `select` + separate projection items with newlines - code completion for annotations now correctly handle e.g: @aaa.| entity - references for annotations: plugins now get all file indexes ## 5.5.3 - 2022-02-04 ### Added - test support for contribution providers ### Changed - CDS language server back to Node 12 (5.5.0 required Node 14 which led to problems in BAS) - typings for contribution implementors are now bundled and accessible directly via `@sap/cds-lsp` ### Fixed - format-cds CLI was not working under certain circumstances - syntax highlighting glitches - code formatting of nested projections ## 5.5.0 - 2022-01-28 ### Added - Command-line interface for code formatter - CDS language server is now bundled and minified to speed up initialization - workspace symbols query now supports filters for kinds ### Changed - consume cds-compiler 2.12.0 - code completion for `index.cds` files will now render just the folder - performance: revalidate file on focus got only if stale index - memory consumption: indexes are now cached per file, no longer per compilation ### Fixed - `enum` was not indexed - `composition` of aspect was not indexed - symbols contained localized entries with recent compiler versions - workspaces with _many_ workspace folders could lead to stop lsp - syntax highlighting is now better aligned with CDS grammar: + multi-lined strings disabled + backslash escaping disabled + doubled quotes inside strings to reproduce single quotes + element types now include scopes and length/size arguments ## 5.4.0 - 2021-12-03 ### Added - progress indication for initialization, configuration changed, references and workspace symbols - support for protocol:selectionRange (though, VSCode has a bug and does not consider it currently) ### Fixed - goto definition of certain references was wrong - symlinks were not followed when scanning workspace - (speedup) indexes could've gone stale even model file hasn't changed ### Changed - consume cds-compiler 2.11.0 - import artifact quickfix now shortens the using path - @sap/cds/common.cds now included by default - speedup initialization: no scan/read workspace, reusing source files first read by compiler, unless reference or workspaceSymbols require a scan - speedup: cache missed paths when compiler resolves using paths - speedup: only consider models from app/srv/db folders (according cds env) for references and workspace symbols - speedup when config changes: revalidation of files only if relevant settings changed - speedup resolution of using paths - speedup: cds env is now loaded synchronously in-process - speedup: calculate annotation diagnostics only for active file - speedup: dynamic registration of configurable requests now done asynchronously at startup - speedup: files to index for references now ordered by rank ## 5.3.0 - 2021-09-23 ### Added - doc comments are automatically aligned ### Fixed - certain localized elements were still indexed - new i18n entry in properties file has corrupted existing last entry - inconsistency in dependency calculation could have led to incorrect revalidations after a change ### Changed - translation support is now lazy - performance improvements when translation files changed - last workspace/symbols are cached now to speed up CAP explorer - user setting cds.workspace.scanCsn has now three modes: Off, ByFileExtension (new default) and InspectJson ## 5.2.0 - 2021-07-30 ### Added - new validation mode _ActiveEditorOnly_ (new default) for clients indicating support via capability _workspace.didChangeActiveEditor_. Other clients remain using _OpenEditorsOnly_ as default. The new mode reduces number of compilations during editing and thus improves responsiveness. - new command to analyze using dependencies of CDS model files. It will create a graphviz dot file that can be viewed with an appropriate viewer. Getting an overview of file dependencies can help to keep your project architecture clean. ### Changed - consume cds-compiler 2.5.0 ## 5.1.1 - 2021-07-05 ### Changed - consume cds-compiler 2.4.4 - new performance relevant user settings + `cds.workspace.debounceFastChanges`: skip intermediate compilations when typing - enabled by default + `cds.workspace.scanDependentModules`: skip scanning of node_modules - enabled by default, speeds up start-up time Note: - when using code completion for global identifiers (see `cds.completion.workspaceSymbols.minPrefixLength`) this option needs to be enabled - for code completion of import paths in `using` statements this option needs to be enabled ## 5.1.0 - 2021-06-22 ### Note This is a quality release focusing on performance for large models. There are new user settings and some have changed their defaults. Best performance is achieved with default settings, except `cds.contributions.enablement.odata` which should be switched `off` to speed up compilation, unless feature is needed. Additonal hints to increase performance: - Within _SAP Business Application Studio_: close `CAP Data Models and Services` view, otherwise it will ask for all workspace symbols at every change. - Settings: `Cds � Contributions � Enablement: Odata`: switch off as already mentioned above - Settings: `Editor � Goto Location: Alternative Definition Command`: do not select `goToReferences`, otherwise being already on a definition will trigger find references which requires all dirty models to be recompiled. - Settings: `Workbench � Editor � Limit: Enabled`: switch on - Settings: `Workbench � Editor � Limit: Value`: lower the number. If open editors have `using` dependencies, a change in one editor will lead to a recompile of releated editors. - Commands `Go to References` / `Find All References` will recompile all models that might have changed due to a change in a depending model. If there are index models it often means the complete workspace is being recompiled. Until a further change, reference calculation is resonably fast. - Command `Go to Symbol in Workspace` will recompile the complete workspace once, then it is reasonable fast - Changing settings in `CDS` section will currently perform a complete workspace invalidation i.e. required indexes will lead to recompilations on-demand as described above - Changing certain `cds.env` settings e.g. folder configurations will invalidate the workspace as well ### Changed - consume cds-compiler 2.3.2 - user settings + cds.workspaceValidationMode new default: OpenEditorsOnly + cds.workspace.scanCsn new settings with default switch off (before implicitly on) + cds.quickfix.importArtifact new setting with default off (before implicitly on) ## 5.0.5 - 2021-05-11 ### Fixed - asynchronous scanning of workspace blocked and led to high cpu usage (mostly on Linux/macOS) ## 5.0.3 - 2021-05-06 ### Changed - consume cds-compiler 2.2.4 - bug fixes ## 5.0.1 - 2021-04-22 ### Changed/Fixed - where-used for namespaces also for compiler v2 - new query flag for workspace symbols: /n to include implicit namespaces ## 5.0.0 - 2021-04-02 ### Note This is a major release which comes with @sap/cds-compiler v2. It still supports cds-compiler v1 if used in your project or via global @sap/cds-dk. ### Added - semantic highlighting - to be enabled via user setting `cds.semanticHighlighting.enabled` - new API for annotation handler to support semantic highlighting ### Changed - consume cds-compiler 2.1.4 ## 4.4.1 - 2021-03-17 ### Added - preliminary support for cds-compiler 2.x ## 4.4.0 - 2021-03-01 ### Changed - optimizations for decreased memory consumption - consume cds-compiler 1.50.0 ## 4.3.0 - 2021-02-01 ### Added - asynchronous initialization for annotation plugins (#923) - find references for annotation plugins (#929) - revalidate workspace after an initial annotation plugin installation (#930) ### Changed - new user options for where-used request (#877) until now this functionality was enabled by default and now needs to be enabled via user options + generic annotations - where a certain annotation 'class' or 'namespace' is used + strings literals - where same string literals are used - consume cds-compiler 1.49.0 - compatibility with early versions of cds-compiler 2.x - simplified consumption of CDS textmate grammar for Jetbrain IDEs ### Fixed - dependency analysis for compilation: if a changed file has dependencies to the roots, but the root models do not cover it, no longer it will compile multiple times - translation code action was not shown in the context of annotations - code completion for annotations had a trailing @ (#883) - annotation assignment spanned beyond semantical end (#838) - code formatting of brackets enclosing multiple elements in annotations had wrong indentation - indexing of `on` condition for elements was broken - update regex to highlight `one` and `many` keyword properly ## 4.2.0 - 2020-11-27 ### Added - quickfix for deprecated identifiers - support for quickfixes in annotation handler - internal support for incremental text updates - improved supportability with extended statistic logs ### Changed - consume cds-compiler 1.46.4 ### Fixes - for annotation handler and others ## 4.1.2 - 2020-11-12 ### Changed - cds-lsp itself no longer dynamically registers file system watching for VSCode, BAS and Eclipse, as those configure it client-side ### Fixes - bug fixes ## 4.1.1 - 2020-11-06 ### Fixed - support for mono repo file system layouts did not work in certain cases - completion proposals for annotations were not shown at top of the list if inside an annotation ## 4.1.0 - 2020-10-30 ### Added - support mono repo file system layouts - user option to format snippets after completion - user option to disable odata plugin - detection of slow running odata plugin (when validating) incl. user options to disable and fine tune - user option for omitRedundantTypesInSnippets for annotations ### Changed - install/update contributions completely async - completion no longer suggests types when values are meant - project cds-lsp settings overrule all - consume cds-compiler 1.45.0 ### Fixed - validation of annotation plugins led to 100% cpu load - globally installed cds was not reliably found - code completion for annotation plugins did not work inside annotations at @ characters - bug fixes ### Note From version 4.1.0 on, @sap/cds-lsp requires NodeJS 12.14+ ## 4.0.0 - 2020-09-30 ### Added - Plugin support for domain specific annotation handlers, featuring - diagnostics - code completion - hover information - goto definition - quickfix to maintain translation - auto-installation/update with user setting for npm registry - code completion inside string literals and `![...]` identifiers is automatically triggered by `/` character (additionally to `.` and `@`) - snippets applied via code completion are now formatted - `action`s and their parameters are now indexed and support code navigation, hover etc. ### Changed - consume cds-compiler 1.42.0 ### Fixed - bug fixes ### Note From version 4.0.0 on, @sap/cds-lsp requires NodeJS 12.8+ (was 10.16+) ## 3.5.0 - 2020-09-01 ### Added - Code completion proposes identifiers not yet imported in current file and generates corresponding `using` statement - user setting: minimum number of characters required to propose those identifiers (`cds.completion.workspaceSymbols.minPrefixLength`). Default is -1 (=off) - user setting: limit number of global identifiers (`cds.completion.workspaceSymbols.maxProposals`). Default is -1 (=unlimited) - Code formatting: options `whitespaceBeforeColon` and `whitespaceAfterColon` are now supported inside anonymous structure types - Code formatting: support configuration of alignment of COMPOSITION structs (option `alignCompositionStructToRight`) ### Changed - consume cds-compiler 1.39.0 ## 3.4.3 - 2020-08-05 ### Changed - consume cds-compiler 1.35.0 ## 3.4.2 - 2020-07-28 ### Added - new user setting `cds.completion.workspaceSymbols` (default `off`) to add workspace symbols to code completion proposals - query for workspace symbols allows new option `/f` to consider fully qualified name ### Changed - consume cds-compiler 1.34.0 ### Fixed - bug fixes ## 3.4.0 - 2020-07-10 ### Added - support for docComments (/** ... */) + hover over artifact will consider docComment + snippet to create + formatting will beautify docComments, incl. new option maxDocCommentLine + quickFix to convert @cds.doc annotation to docComment incl. beautify + distinct syntax highlighting for docComments - quickFix to generate using statement for not yet imported artifacts + sorted by module and artifact name, beautified - semantic code completion for elements, enums, actions and parameters in annotate and extend (via cds-compiler 1.32.0) - syntax highlighting identifiers, including variants delimited with \![...] - identifier completion proposals are prioritized by message severity - messages may now contain related information - added INSTALLATION.md for 3rd party IDE integrations ### Changed - consume cds-compiler 1.32.0 - updated README.md with feature list ### Fixed - enum keyword was wrongly syntax highlighted - when an ignored source file is closed, potential messages are wiped - annotations of extensions were not indexed - bug fixes ## 3.3.2 - 2020-04-26 ### Changed - remove optional odata annotation handler due to build issues ## 3.3.1 - 2020-04-24 ### Changed - consume cds-compiler 1.26.2 ## 3.3.0 - 2020-04-24 ### Added - use global @sap/cds/common if locally not available ### Changed - consume cds-compiler 1.26.0 - (alpha): diagnostics and hover support for external annotation providers ### Fixed - Minor fixes and improvements ## 3.2.1 - 2020-03-30 ### Changed - consume cds-compiler 1.24.4 ## 3.2.0 - 2020-03-16 ### Changed * remove option for compiler location - LSP will always search Project->Global(via DK&CDS)->BuiltIn now - remove irrelevent formatting option (trimTrailingWhitespace) - consume cds-compiler 1.24.3 ### Fixed - formatting failed (seen in Eclipse, VSCode works) due to off-by-one error - global npm root for Business App Studio was not found with `compiler.location` option `ProjectThenGlobalThenBuiltIn` ## 3.1.4 - 2020-03-04 ### Added - _extend_ definitions are now shown in outline and workspace symbols - api (alpha) for external annotation providers ### Changed - consume cds-compiler 1.24.0 ## 3.1.3 - 2020-02-24 ### Added - pick up compiler and env via global cds-dk if cds not (yet) in project ### Changed - consume cds-compiler 1.23.2 ## 3.1.2 - 2020-02-11 ### Added * code formatting * options can now be overridden in source comments e.g. // @formatter tabSize:3 * new option to add/remove final line break * new option to trim trailing whitespace ### Changed * consume cds-compiler 1.23.1 ### Fixed * in some cases csn files with .json extension where not detected and thus workspace symbols were incomplete ## 3.1.1 - 2020-01-30 ### Added * code formatting * option to keep original empty lines * language server protocol 3.15: implement serverInfo in onInitialize ### Fixed * formatting options were taken from homedir instead of preferring from project ## 3.1.0- 2020-01-24 ### Added * translation support * now with all formats supported by runtime (.properties, .json, .csv) incl. quick fixes to create missing entries * now with customizations supported by runtime (filename, folder name, fallback_bundle, default_language) * if entries of fallback language are missing but are defined for default language the latter ones are used * if property files or json nodes or csv header only has default language defined (and not raw), quick fix will use default language * quick fix for json and csv formats now try to keep entries sorted * navigation from translation reference in cds source files to value supported for all formats * allow .cdsprettier.json to be located in user home dir ### Changed * code formatting * improve alignment of types, values, and preceding `:` or `=` operators * consume cds-compiler 1.22.0 ### Fixed * code formatting * fix, improve, and allow to better adjust alignments and whitespace * fix alignment of annotations in `annotate` statement * fix casing of and indentation after `Association` and `Composition` * fix formatting of parts of `select` statement in case of nesting and after `in` * fix positioning of brace `{` after annotation if requested to be kept in previous line * fix bug where token starting with `$` was merged * in the past file changes via watcher were automatically sent for all files in VSCode. In recent versions of VSCode this has changed to only sent files supported by language server type (cds). A fix was made to dynamically register for relevant side-files like package.json, .cdsrc.json, all supported translation file formats, ignore files to keep track of changed environment ## 3.0.0 - 2019-12-16 Official support for code formatting ### Changed * code completion * more snippet variants for extend * no longer differ entity suggestions between within service or outside * base types with parameters now suggested as simply keyword w/o params and additional suggestion as snippet (param names now enclosed in < >) * changed label indicator for snippets from <> to ellipsis * consume cds-compiler 1.21.1 * code formatting * rework formatting options: add/remove options according to relevance, rename/group options for clarity, change default behavior in some cases * various improvements, including in case statements and bracketed conditions ### Fixed * code formatting * fix alignment of annotations in views * safely identify unreserved keywords ## [2.1.21] ### Fixes * Fix indentation after element definitions using Association or Composition ## [2.1.20] ### Added * support LSP configuration via settings file in workspace incl. logs in workspace ### Changed * consume cds-compiler 1.20.3 ### Fixed * fix: extraction of root models did no longer work since @sap/cds#3.19 * code formatting * Fix indentation of keywords `union`, `except`, and `minus` * Make alignments more consistent generally * Improve readability by padding operators with blanks * Improve alignment of bracketed conditions ## [2.1.19] * consume cds-compiler 1.20.0 * fixes and enhancements in code formatting ## [2.1.18] * syntax highlighting: now supports 'default' keyword, plus minor fixes * removed dependencies to ts-md5 and vscode-uri * **for all IDE providers**: _out_ folder was renamed to _lib_ * new internal URI handling: especially on Windows no longer encode drive letter colon ## [2.1.17] * minor text polishing for config UI ## [2.1.16] * fixes and enhancements for code formatting * renamed settings file to .cdsprettier.json * schema with parentOption and basic markdown support for label (new) and description * renamed tmLanguage for syntax highlighting * consume cds-compiler 1.19.2 ## [2.1.15] * fixes and enhancements for code formatting * clean-ups in LSP project setup * consume cds-compiler 1.19.1 ## [2.1.13] * fix regression: schema file was not included ## [2.1.12] * fix minor issues ## [2.1.11] * schema for formatting options with category, description, code sample, suboptions, enum values * now sits on node 10+ * consume cds-compiler 1.18.1 ## [2.1.10] * Fixes and enhancement for syntax highlighting and code formatting ## [2.1.9] * Syntax highlighting now uses different classifications (=colors) for annotations and comments * Support user settings in $LSP/.cds-lsp/.settings.json for IDEs which do not support user settings (Eclipse, Intellij, ...) * No longer report compiler messages for csn files * Preparation for config editor for formatting options * Deadlock detection and prevention for code formatting incl. option to cancel or try best in case * Use json parsing from compiler for csn files (which allows comments etc.) * Fixes and enhancements in source formatting * consume cds-compiler 1.17.3 ## [2.1.8] * code formatting - many fixes and enhancements * now on by default but still experimental * syntax highlighting reworked for CDL and CQL keywords * where-used index now with using path segments * updated cds documentation (in code completion) * outline now shows contexts and services with fully qualified name * other fixes and improvements * consume cds-compiler 1.17.0 ## [2.1.7] * consume cds-compiler 1.16.2 * fixes and improvements ## [2.1.6] * beautify: improve alignment of comments and robustness * bug fix: outline showed entries not contained in file ## [2.1.5] * consume cds-compiler 1.16.1 * beautification for annotations and CQL ## [2.1.4] * consume cds-compiler 1.15.0 * user option to enable beautify: cds.experimental.beautify.enable (default false) ## [2.1.3] * consume cds-compiler 1.14.0 ## [2.1.2] * consume cds-compiler 1.13.4 * using compiler from project workspace now default ## [2.1.1] * consume cds-compiler 1.13.1 * performance improvements (fewer compilations and reduced memory footprint) * Links to folders in using statement are now resolved ## [2.1.0] * consume cds-compiler 1.12.1 * new where-used index with less memory consumption and support for references of custom annotations, built-in types, string constants and better tracking of identifiers in CQL * targets of using statement now rendered as links (via documentLink request) ## [2.0.8] * performance optimizations for translation support * consume cds-compiler 1.10.0 ## [2.0.7] * new switch: cds.compiler.markMissingI18nDefault (default: off) to show problem markers for unresolved i18n references * bug fixes ## [2.0.6] * consume cds-compiler 1.9.0 * bug fixes