Skip to content

Feat: add sap-description-column-label ESLint rule#4542

Open
marcovieth wants to merge 20 commits intomainfrom
feat/rule-descriptionColumnLabel
Open

Feat: add sap-description-column-label ESLint rule#4542
marcovieth wants to merge 20 commits intomainfrom
feat/rule-descriptionColumnLabel

Conversation

@marcovieth
Copy link
Copy Markdown
Contributor

Ensures that the property referenced as the description (text) value via Common.Text has a meaningful Common.Label -- not a generic value such as "Name" or "Description", and not the same label as the ID property it describes.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 10, 2026

🦋 Changeset detected

Latest commit: 5d8bc7a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 15 packages
Name Type
@sap-ux/xml-odata-annotation-converter Minor
@sap-ux/odata-annotation-core-types Minor
@sap-ux/eslint-plugin-fiori-tools Minor
@sap-ux/fiori-annotation-api Patch
@sap-ux/annotation-generator Patch
@sap-ux/cds-odata-annotation-converter Patch
@sap-ux/odata-annotation-core Patch
@sap-ux/odata-vocabularies Patch
@sap-ux/fiori-elements-writer Patch
@sap-ux/fe-fpm-writer Patch
@sap-ux/fiori-app-sub-generator Patch
@sap-ux/cds-annotation-parser Patch
@sap-ux/fe-fpm-cli Patch
@sap-ux/repo-app-import-sub-generator Patch
@sap-ux/generator-simple-fe Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@marcovieth marcovieth marked this pull request as ready for review April 15, 2026 08:45
@marcovieth marcovieth requested review from a team as code owners April 15, 2026 08:45
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread .changeset/rich-meals-shake.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-description-column-label.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/src/rules/sap-description-column-label.ts Outdated
Comment thread packages/eslint-plugin-fiori-tools/src/rules/sap-description-column-label.ts Outdated
Comment thread packages/eslint-plugin-fiori-tools/src/rules/sap-description-column-label.ts Outdated
Copy link
Copy Markdown
Contributor

@lfindlaysap lfindlaysap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are my suggestions.

`trivialLabel`: The `Common.Label` annotation on the text property is too generic:

```xml
<!-- ProductBaseUnit uses UnitOfMeasure_Text as its description column via Common.Text annotation -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- ProductBaseUnit uses UnitOfMeasure_Text as its description column via Common.Text annotation -->
<!-- ProductBaseUnit uses UnitOfMeasure_Text as its description column using the Common.Text annotation -->

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done with commit 49af900

@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants