Skip to content

docs: revised editor docs #1868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged

docs: revised editor docs #1868

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
107e33b
docs: revised editor docs
manwithafox May 22, 2025
e1f9a91
Update tools/cds-editors.md
renejeglinsky May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions tools/cds-editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,14 +346,6 @@ Keeps track of the active editor in focus. Only changes there are immediately va
The *ActiveEditorOnly* mode is especially useful in situations when navigating through a large model, that is, having multiple files open (even if they are not shown as tabs)
and editing a file that the others directly or indirectly depend on.

::: warning Large models can lead to **high CPU and memory load**
If switched to *OpenEditorsAndDirectSources*, all model files on every change, for example typed character, are recompiled.

If switched to _OpenEditorsOnly_, all open files, for example split tabs, are recompiled.

The high resource consumption might impact the editor's responsiveness.
:::

##### Cds > Contributions > [Enablement: Odata](vscode://settings/cds.contributions.enablement.odata)

Default: *on*
Expand Down Expand Up @@ -406,7 +398,7 @@ You want to create a preview of a specific _.cds_ file in your project. You can

##### Visualize CDS file dependencies

Use the command from the context menu on a folder or CDS file.
Use the command from the context menu on a folder or CDS file, or from within the popup when hovering over an _import_ path at the end of a _using_ statement.

A selection popup appears to choose one of three modes:

Expand Down Expand Up @@ -446,7 +438,7 @@ Until a further change, reference calculation is reasonably fast.
- Changing settings in _CDS_ section will currently perform a complete workspace invalidation, that is, required indexes will lead to recompilations on demand as described above.
- Changing certain `cds.env` settings, for example folder configurations, will invalidate the workspace as well.

### CDS Source Formatter <Beta /> { #cds-formatter}
### CDS Source Formatter { #cds-formatter}

The CDS code formatter provides a command line interface. Use it as a pre-commit hook or within your CI/CD pipeline to ensure consistent formatting.

Expand Down