Skip to content

New no-escaped-anno-brackets eslint rule #2565

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

Open
schiwekM wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New no-escaped-anno-brackets eslint rule #2565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions tools/cds-lint/rules/no-escaped-anno-brackets/correct/db/schema.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
namespace sap.capire.bookshop;

@UI.LineItem: [{
Value : title,
@UI.Importance : #High,
}]
entity Books {
key ID : Integer;
@mandatory title : localized String(111);
@mandatory author : Association to Authors;
}
11 changes: 11 additions & 0 deletions tools/cds-lint/rules/no-escaped-anno-brackets/incorrect/db/schema.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
namespace sap.capire.bookshop;

@UI.LineItem: [{
Value : title,
![@UI.Importance] : #High, // escaped annotation syntax is unnecessary [!code error]
}]
entity Books {
key ID : Integer;
@mandatory title : localized String(111);
@mandatory author : Association to Authors;
}
50 changes: 50 additions & 0 deletions tools/cds-lint/rules/no-escaped-anno-brackets/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
outline: [2,2]
breadcrumbs:
- CDS Lint
- Rules Reference
status: released
---

<script setup>
import PlaygroundBadge from '../../components/PlaygroundBadge.vue'
</script>

# no-escaped-anno-brackets

## Rule Details

The escaped annotation syntax `![@...]` is unnecessary in modern CAP CDS. Inline annotations can be written as `@...` directly. This rule reports usages of the old escaped syntax and provides an autofix to replace them.

## Examples

#### ✅ &nbsp; Correct example

In the following example, inline annotations use the modern `@...` syntax without escaping:

::: code-group
<<< correct/db/schema.cds#snippet{cds:line-numbers} [db/schema.cds]
:::
<PlaygroundBadge
name="no-escaped-anno-brackets"
kind="correct"
:rules="{'@sap/cds/no-escaped-anno-brackets': ['error', 'show']}"
:files="['db/schema.cds']"
/>

#### ❌ &nbsp; Incorrect example

This example shows the old escaped annotation syntax `![@UI.Importance]` which is unnecessary and should be replaced with `@UI.Importance`:

::: code-group
<<< incorrect/db/schema.cds#snippet{cds:line-numbers} [db/schema.cds]
:::
<PlaygroundBadge
name="no-escaped-anno-brackets"
kind="incorrect"
:rules="{'@sap/cds/no-escaped-anno-brackets': ['error', 'show']}"
:files="['db/schema.cds']"
/>

## Version
This rule was introduced in `@sap/eslint-plugin-cds 4.2.3`.
Loading