-
Notifications
You must be signed in to change notification settings - Fork 2
feat(ui5): Offer UI5 Guidelines as Claude Skills #49
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.
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
d3xter666
wants to merge
27
commits into
main
Choose a base branch
from
feat-ui5-skills
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
dea1652
feat(ui5-guidelines): Add consolidated testing and metrics system
d3xter666 75283bd
feat(ui5-guidelines): Phase 2.1 - improve triggering and extract Type…
d3xter666 e3c6feb
feat(ui5-guidelines): Phase 2.2 - extract Integration Cards references
d3xter666 2eec626
feat(ui5-guidelines): Phase 2.3 - refactor test framework to TypeScri…
d3xter666 d9a034b
feat(ui5-guidelines): Phase 2.4 - expand test coverage and add sample…
d3xter666 a392928
docs(ui5-guidelines): Update documentation for v2.1.0 release
d3xter666 065cff8
refactor(test): Phase 1 - High priority fixes from code review
d3xter666 f2cf11b
refactor(skills): Phase 2.1 - Extract ui5-best-practices references
d3xter666 a195b70
refactor(skills): Phase 2.2 - Extract ui5-typescript-expert references
d3xter666 e731b1a
refactor(skills): Phase 2.3 - Extract ui5-integration-cards references
d3xter666 dd442d3
test: Add 12 new test cases for improved coverage
d3xter666 ee51469
docs: Add comprehensive code review fixes summary
d3xter666 fd814da
docs: Consolidate documentation (72% reduction)
d3xter666 a93421f
docs: Add comprehensive user guide and documentation summary
d3xter666 a100516
feat: Consolidate docs, fix scripts, add coverage analysis
d3xter666 1764e77
feat: Consolidate docs, fix scripts, add coverage analysis
d3xter666 26805a5
feat: Clean plugin for distribution - remove test infrastructure
d3xter666 c2e1c50
fix: Remove ui5-guidelines test references from root
d3xter666 4d9569a
refactor: Remove ui5-integration-cards skill from ui5-guidelines plugin
d3xter666 a9851bf
refactor: Remove redundant skills and consolidate ui5-guidelines to s…
d3xter666 f801715
ci: Add dist directory to gitignore
d3xter666 58694ae
refactor: Adjust SKILL with the minimal required information and addr…
d3xter666 617d4f6
docs: Refactor i18n scenarios recommendation
d3xter666 cbb95fc
docs: Revise CSP policy
d3xter666 14af67e
fix: Prettier formatting & styling
d3xter666 48d80a7
refactor: Remove redundant information
d3xter666 ae63342
docs: Update README.md
d3xter666 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,3 +51,4 @@ jspm_packages/ | |
|
|
||
| # Temporary files | ||
| /tmp/ | ||
| dist/ | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| { | ||
| "name": "ui5-guidelines", | ||
| "version": "3.0.0", | ||
| "description": "UI5 development guidelines and best practices plugin derived exclusively from official SAP UI5 guidelines. Covers async module loading, ComponentSupport initialization, data binding with OData types, i18n management, CSP compliance, TypeScript event handlers (UI5 >= 1.115.0), MCP tooling integration, CAP integration patterns, and form creation rules. Essential for writing modern, maintainable UI5 code.", | ||
| "author": { | ||
| "name": "SAP SE" | ||
| }, | ||
| "homepage": "https://github.com/UI5/plugins-claude", | ||
| "repository": "https://github.com/UI5/plugins-claude", | ||
| "license": "Apache-2.0", | ||
| "keywords": [ | ||
| "sap", | ||
| "ui5", | ||
| "sapui5", | ||
| "openui5", | ||
| "claude", | ||
| "plugin", | ||
| "guidelines", | ||
| "best practices", | ||
| "coding standards", | ||
| "async loading", | ||
| "odata types", | ||
| "data binding", | ||
| "cap integration", | ||
| "typescript", | ||
| "csp" | ||
| ], | ||
| "skills": ["skills/ui5-best-practices"] | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| .DS_Store | ||
| *.backup |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # UI5 Guidelines Plugin | ||
|
|
||
| UI5 development guidelines and best practices for Claude Code. | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| ### 📋 ui5-best-practices | ||
|
|
||
| Covers modern UI5 coding standards and architectural patterns derived from official SAP UI5 guidelines: | ||
| - Async module loading | ||
| - Data binding with OData types | ||
| - CSP compliance | ||
| - TypeScript event handlers | ||
| - CAP integration | ||
| - Form creation rules | ||
| - MCP tooling integration | ||
|
|
||
| **Note**: For TypeScript conversion, use the separate [`ui5-typescript-conversion`](https://github.com/UI5/plugins-claude/tree/main/plugins/ui5-typescript-conversion) plugin. | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/UI5/plugins-claude.git | ||
| cd plugins-claude/plugins/ui5-guidelines | ||
|
|
||
| # Link to Claude plugins directory | ||
| ln -s $(pwd) ~/.claude/plugins/ui5-guidelines | ||
| ``` | ||
|
|
||
| Enable in `~/.claude/settings.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "enabledPlugins": { | ||
| "ui5-guidelines": true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Restart Claude to load the plugin. | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| Skills trigger automatically when you ask UI5-related questions. No commands needed. | ||
|
|
||
| **Examples:** | ||
| ``` | ||
| "How do I set up async module loading in UI5?" | ||
| "Show me how to use OData types in data binding" | ||
| "What's the correct way to create forms in UI5?" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Support | ||
|
|
||
| - **Plugin Issues**: [GitHub Issues](https://github.com/UI5/plugins-claude/issues) | ||
| - **SAP UI5 Documentation**: [ui5.sap.com](https://ui5.sap.com) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be a separate plugin? I think it would be better to integrate the skill into the existing "ui5" plugin so users get it automatically together with the MCP server
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It’s like that in the JIRA description. Also, the typescript skill is under another namespace.
I don’t mind putting it in the ‘ui5’ namespace