Skip to content

Docs(eslint-plugin-fiori-tools): add cds code snippets to rule documentation#4623

Merged
AlinaGovoruhina merged 5 commits into
mainfrom
eslint-fiori/add-doc-cds-code-snippets
May 11, 2026
Merged

Docs(eslint-plugin-fiori-tools): add cds code snippets to rule documentation#4623
AlinaGovoruhina merged 5 commits into
mainfrom
eslint-fiori/add-doc-cds-code-snippets

Conversation

@AlinaGovoruhina
Copy link
Copy Markdown
Contributor

@AlinaGovoruhina AlinaGovoruhina commented Apr 30, 2026 •
edited
Loading

Add CDS Code Snippets to ESLint Rule Documentation

Documentation

Added CDS annotations examples for 2 rules, Hidden-text-arrangement rule docs will be updated when the rule is updated to support CAP.

Changes

  • .changeset/tall-hounds-unite.md: Added a patch changeset entry describing the addition of CDS annotation code examples to rules documentation.

  • docs/rules/sap-no-data-field-intent-based-navigation.md: Added CDS annotation equivalents for all existing XML code examples, covering:

    • Incorrect usage of UI.DataFieldForIntentBasedNavigation and UI.DataFieldWithIntentBasedNavigation in UI.LineItem
    • Incorrect usage within UI.FieldGroup
    • Correct usage with Common.SemanticObject annotated on entity properties
    • Correct UI.LineItem and UI.FieldGroup patterns using UI.DataField

  • docs/rules/sap-width-including-column-header.md:

    • Added a CDS annotation example for the correct UI.LineItem configuration alongside the existing XML example.
    • Added a clarifying comment (<!-- Include at least 6 data fields -->) to the XML example.
    • Removed redundant XML annotation sections from both the incorrect patterns and the "How to Fix" sections, streamlining the documentation.
    • Minor wording fix in the "How to Fix" section (removed reference to "or annotations").
  • 🔄 Regenerate and Update Summary
PR Bot Information

Version: 1.20.37

  • Correlation ID: d08614d8-6148-49f7-8ed0-5711867d6406
  • LLM: anthropic--claude-4.6-sonnet
  • Summary Prompt: Default Prompt
  • Event Trigger: pull_request.opened
  • Output Template: Default Template
  • File Content Strategy: Full file content

@AlinaGovoruhina AlinaGovoruhina added the eslint-plugin-fiori-tools @sap-ux/eslint-plugin-fiori-tools label Apr 30, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 30, 2026 •
edited
Loading

🦋 Changeset detected

Latest commit: 3dd5325

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

This PR includes changesets to release 1 package
Name Type
@sap-ux/eslint-plugin-fiori-tools 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

@AlinaGovoruhina AlinaGovoruhina changed the title (eslint-plugin-fiori-tools): add cds code snippets to rule documentation Docs(eslint-plugin-fiori-tools): add cds code snippets to rule documentation Apr 30, 2026
@AlinaGovoruhina AlinaGovoruhina marked this pull request as ready for review April 30, 2026 09:43
@AlinaGovoruhina AlinaGovoruhina requested a review from a team as a code owner April 30, 2026 09:43
@hyperspace-insights
Copy link
Copy Markdown
Contributor

hyperspace-insights Bot commented Apr 30, 2026

Summary

The following content is AI-generated and provides a summary of the pull request:

Docs(eslint-plugin-fiori-tools): Add CDS Code Snippets to Rule Documentation

Documentation

📝 Added CDS annotation code examples to the eslint-plugin-fiori-tools rule documentation, complementing the existing XML annotation examples for better developer guidance.

Changes

  • .changeset/tall-hounds-unite.md: Added a patch changeset entry describing the addition of CDS annotation code examples to rules documentation.

  • docs/rules/sap-no-data-field-intent-based-navigation.md: Added CDS annotation equivalents alongside all existing XML examples, covering:

    • Incorrect usage of UI.DataFieldForIntentBasedNavigation and UI.DataFieldWithIntentBasedNavigation in UI.LineItem
    • Incorrect usage within UI.FieldGroup
    • Correct usage with Common.SemanticObject annotated on entity properties (Step 1)
    • Correct UI.LineItem and UI.FieldGroup patterns using UI.DataField (Step 2)

  • docs/rules/sap-width-including-column-header.md:

    • Added a CDS annotation example for the correct UI.LineItem configuration alongside the existing XML example.
    • Added a clarifying comment (<!-- Include at least 6 data fields -->) to the XML example.
    • Removed redundant XML annotation sections from the incorrect patterns and the "How to Fix" sections, streamlining the documentation.
    • Minor wording fix in the "How to Fix" section (removed reference to "or annotations").
  • 🔄 Regenerate and Update Summary
  • ✏️ Insert as PR Description (deletes this comment)
  • 🗑️ Delete comment
PR Bot Information

Version: 1.20.37

  • Output Template: Default Template
  • Correlation ID: c04571c5-c74f-4db9-85ca-732cf5035256
  • File Content Strategy: Full file content
  • LLM: anthropic--claude-4.6-sonnet
  • Summary Prompt: Default Prompt
  • Event Trigger: pull_request.ready_for_review

hyperspace-insights[bot]
hyperspace-insights Bot reviewed Apr 30, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@hyperspace-insights hyperspace-insights Bot left a comment

Choose a reason for hiding this comment

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

The PR is a documentation-only change that adds helpful CDS annotation examples alongside existing XML ones. The changes are generally correct and improve the documentation, but there are a few issues worth addressing: an extraneous UI.HeaderFacets block in the "incorrect FieldGroup" example that muddies what the rule violation actually is, a trailing space on a code-fence tag, a property name mismatch between aligned XML and CDS examples, and a pre-existing typo (manifes.json) that this PR did not fix.

PR Bot Information

Version: 1.20.37

  • Correlation ID: c04571c5-c74f-4db9-85ca-732cf5035256
  • Agent Instructions:
  • File Content Strategy: Full file content
  • LLM: anthropic--claude-4.6-sonnet
  • Event Trigger: pull_request.ready_for_review

Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-no-data-field-intent-based-navigation.md
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-no-data-field-intent-based-navigation.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-no-data-field-intent-based-navigation.md Outdated
Comment thread packages/eslint-plugin-fiori-tools/docs/rules/sap-width-including-column-header.md Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 11, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@AlinaGovoruhina AlinaGovoruhina merged commit c520b5e into main May 11, 2026
18 checks passed
@AlinaGovoruhina AlinaGovoruhina deleted the eslint-fiori/add-doc-cds-code-snippets branch May 11, 2026 06:50
devinea added a commit that referenced this pull request May 12, 2026
@devinea
Merge remote-tracking branch 'origin/main' into claude_desktop_suppor…
23c8438 
…t_take2

* origin/main:
  Project modules update 12.05.2026 (5242) (#4661)
  update skill name (#4658)
  chore: apply latest changesets
  feat: Display unhandled exceptions from the Controller extension inside the Info Center. (#4627)
  chore: apply latest changesets
  feat: update splitter for new ui (#4648)
  chore: apply latest changesets
  tbi(generator-odata-downloader): Make self contained (#4656)
  chore: apply latest changesets
  fix: change confirm replace additional message based on environment (#4628)
  chore: apply latest changesets
  fix(sap-systems-ext): add new create new command (#4645)
  chore: apply latest changesets
  (fiori-mcp-server) add additional guidance on the adding of extension in fiori (#4643)
  test: update skill (#4651)
  chore: apply latest changesets
  fix: Add fragment list to model for custom fragments (#4601)
  chore: apply latest changesets
  Docs(eslint-plugin-fiori-tools): add cds code snippets to rule documentation (#4623)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hyperspace-insights hyperspace-insights[bot] hyperspace-insights[bot] left review comments

@marufrasully marufrasully marufrasully approved these changes

@lfindlaysap lfindlaysap lfindlaysap approved these changes

Assignees

No one assigned

Labels

eslint-plugin-fiori-tools @sap-ux/eslint-plugin-fiori-tools

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AlinaGovoruhina @marufrasully @lfindlaysap