-
Notifications
You must be signed in to change notification settings - Fork 2
feat(ui5): Add UI5 Guidelines as 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
32
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.
+586
−6
Open
Changes from all commits
Commits
Show all changes
32 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 c15de7e
refactor: Consolidate ui5-guidelines into plugins/ui5/
d3xter666 2e00c51
refactor: Cleanup
d3xter666 21907b5
refactor: Revert plugin description
d3xter666 89b35b8
docs: Adjust Readme
d3xter666 f437d6a
revert: Plugin.json to initial state
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 |
|---|---|---|
| @@ -1,21 +1,91 @@ | ||
| # UI5 plugin for Claude | ||
| # UI5 Plugin for Claude | ||
|
|
||
| Complete SAPUI5 / OpenUI5 plugin for Claude Code with MCP tools, API documentation access, linting capabilities, and development guidelines. | ||
|
|
||
| --- | ||
|
|
||
| ## Key Features | ||
|
|
||
| - Helps with the creation of new UI5 projects when working with Claude Code | ||
| - Supports the developer to detect and fix UI5-specific errors | ||
| - Provides additional UI5-specific information for Claude Code | ||
| ### 🛠️ MCP Tools | ||
| - **Create and validate UI5 projects** - Project scaffolding and validation | ||
| - **Access API documentation** - Query UI5 control APIs and documentation | ||
| - **Run UI5 linter** - Code quality validation and best practices checks | ||
| - **UI5 tooling integration** - Version info and project management | ||
|
|
||
| ### 📋 Skills: ui5-best-practices | ||
|
|
||
| Development guidelines and coding standards derived from official SAP UI5 guidelines: | ||
| - **Async module loading** - sap.ui.define patterns | ||
| - **Data binding with OData types** - Type-safe data binding | ||
| - **CSP compliance** - Content Security Policy best practices | ||
| - **TypeScript event handlers** - Modern event handling (UI5 >= 1.115.0) | ||
| - **CAP integration** - Integration with SAP Cloud Application Programming Model | ||
| - **Form creation rules** - Form and SimpleForm patterns | ||
| - **i18n management** - Internationalization workflows | ||
| - **Component initialization** - ComponentSupport patterns | ||
|
|
||
| **Note**: For TypeScript conversion specifically, use the separate [`ui5-typescript-conversion`](https://github.com/UI5/plugins-claude/tree/main/plugins/ui5-typescript-conversion) plugin. | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| Via Claude CLI: | ||
| ### Via Claude CLI | ||
| ```bash | ||
| claude plugin install ui5@claude-plugins-official | ||
| ``` | ||
|
|
||
| In Claude Code: | ||
| ### In Claude Code | ||
| ``` | ||
| /plugin install ui5@claude-plugins-official | ||
| ``` | ||
|
|
||
| ### Manual Installation | ||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/UI5/plugins-claude.git | ||
| cd plugins-claude/plugins/ui5 | ||
|
|
||
| # Link to Claude plugins directory | ||
| ln -s $(pwd) ~/.claude/plugins/ui5 | ||
| ``` | ||
|
|
||
| Enable in `~/.claude/settings.json`: | ||
| ```json | ||
| { | ||
| "enabledPlugins": { | ||
| "ui5": true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Restart Claude to load the plugin. | ||
|
|
||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| ### MCP Tools | ||
| Use MCP tools explicitly when you need specific UI5 tooling functions: | ||
| ``` | ||
| "Use get_api_reference to look up sap.m.Button" | ||
| "Run ui5 linter on my project" | ||
| "Get UI5 version information" | ||
| ``` | ||
|
|
||
| ### Skills (Auto-Triggered) | ||
| Skills trigger automatically when you ask UI5-related questions: | ||
| ``` | ||
| "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?" | ||
| "How to handle TypeScript events in UI5 >= 1.115.0?" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Support | ||
|
|
||
| - **Plugin Issues**: [GitHub Issues](https://github.com/UI5/plugins-claude/issues) | ||
| - **SAP UI5 Documentation**: [ui5.sap.com](https://ui5.sap.com) | ||
| - **Claude Code Documentation**: [claude.ai/code](https://claude.ai/code) | ||
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.
Once you merge this, I will also list the
integration cardsskill hereThere 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.
You can do it now, we’ll just have conflicts eventually 😅