feat(ui5): Add SAP Fiori guidelines skill - #129
Open
hinzzx wants to merge 1 commit into
Open
Conversation
Member
|
I would like to also mention "OpenUI5" in the skill. So, controls only available in SAPUI5 should be marked with "SAPUI5". Controls available in both with "OpenUI5 / SAPUI5". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new
ui5-fiori-guidelinesskill to theui5plugin.It helps pick the right SAP Fiori / UI5 control for a given use case, and flags the wrong one before it ships.
Why
The most common UI5 mistake isn't syntax, it's reaching for the wrong control.
A
sap.m.Barused as an app header, a responsive table handed thousands of rows, a hand-builtDialogwhere aMessageBoxbelongs. These compile, look fine in review, then bite later as UX and performance problems.The existing skills cover how to write UI5 well. None of them covered which control to use in the first place. This fills that gap.
What's in it
A
SKILL.mdrouter with a Wrong to Right table, a use-case to component map, and a set of short one-line rules.For each control it gives both names, the SAPUI5 class and the
ui5-*web component tag, and says so explicitly when a control only exists in one of them.Eleven reference files under
references/, read on demand, one per topic (actions, inputs, containers, navigation, lists and tables, display, messages, AI, upload, theming tokens, and a review checklist).A
REFRESH.mdthat documents how to re-sync the skill against SAP sources. It reports drift and proposes edits, a human reviews and applies. No unattended writes.Notes for reviewers
The skill loads automatically through the plugin's
skills/directory scan, so noplugin.jsonchange was needed.Also we've reworked and restructured the below-mentioned skill a little bit, as it appears we've had similar ideas.
Credits:
https://github.com/SAP/ai-skills-library/tree/main/skills/sap-fiori-guidelines