feat: Initial content (#1)

flovogt · web-flow · commit c88d09e64d39 · 2025-07-25T11:32:51.000+02:00
Add basic files.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,26 @@
+# see http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+
+[.*]
+trim_trailing_whitespace = true
+end_of_line = lf
+indent_size = 4
+insert_final_newline = true
+
+[*.{css,html,js,cjs,mjs,jsx,ts,cts,mts,tsx,less,txt,json,yml,md}]
+trim_trailing_whitespace = true
+end_of_line = lf
+indent_size = 4
+insert_final_newline = true
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+@UI5/ui5-team-cor-fnd
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,44 @@
+name: Bug Report
+description: Report a bug in UI5 MCP
+type: Bug
+body:
+  - type: markdown
+    attributes:
+      value: | 
+        Please have a look at our [contributing guidelines](https://github.com/UI5/mcp/blob/main/CONTRIBUTING.md#report-bugs) on reporting issues.
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: What is the issue and how can we reproduce it?
+      description: |
+        To help us understand and resolve the issue efficiently, please provide a **minimal reproducible example** (required) and steps that clearly illustrate the unexpected behavior.
+      value: |
+        1. Open the sample https:// ...
+        2. Click on ...
+        3. ... --> **Issue:** ...
+        
+        #### Error:
+        > ...
+        
+        #### Expected behavior:
+        ...
+    validations:
+      required: true
+  - type: input
+    id: version-ui5-mcp
+    attributes:
+      label: Which UI5 MCP version is your project targeting?
+      description: Share the UI5 MCP version where the issue occurs.
+    validations:
+      required: true
+  - type: checkboxes
+    id: issue-checked
+    attributes:
+      label: Confirmation
+      description: |
+        To avoid duplicates and ensure efficient issue resolution, please double-check existing issues.
+      options:
+        - label: I have searched the existing issues and reviewed the relevant documentation as well as the API reference.
+          required: true
+        - label: I am not disclosing any internal or sensitive information.
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -0,0 +1,34 @@
+name: Feature Request
+description: Request a new feature for UI5 MCP
+type: Feature
+body:
+  - type: markdown
+    attributes:
+      value: | 
+        Please have a look at our [contributing guidelines](https://github.com/UI5/mcp/blob/main/CONTRIBUTING.md#request-features) on requesting features to be added to UI5 MCP.
+  - type: textarea
+    id: background-information
+    attributes:
+      label: Why are you proposing this feature?
+      description: A clear and concise description of the underlying scenario to be covered and whats's missing in UI5 MCP. Provide any relevant background information that helps explain why this feature would be beneficial.
+      placeholder: A clear and concise description of the underlying scenario to be covered and whats's missing in UI5 MCP. Provide any relevant background information that helps explain why this feature would be beneficial.
+    validations:
+      required: true
+  - type: textarea
+    id: possible-solution
+    attributes:
+      label: How should a possible solution look like?
+      description: A clear and concise description of what you want to happen.
+      placeholder: A clear and concise description of what you want to happen.
+  - type: textarea
+    id: alternative-solution
+    attributes:
+      label: Are there alternative approaches?
+      description: A clear and concise description of any alternative solutions or features you've considered.
+      placeholder: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Any further information you would like to share?
+      description: Add any other context or screenshots about the feature request here.
+      placeholder: Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+**Thank you for your contribution!** 🙌
+
+To get it merged faster, kindly review the checklist below:
+
+## Pull Request Checklist
+- [ ] Reviewed the [Contributing Guidelines](https://github.com/UI5/mcp/blob/main/CONTRIBUTING.md#-contributing-code)
+    + Especially the [How to Contribute](https://github.com/UI5/mcp/blob/main/CONTRIBUTING.md#how-to-contribute) section 
+- [ ] [No merge commits](https://github.com/UI5/mcp/blob/main/docs/Guidelines.md#no-merge-commits)
+- [ ] [Correct commit message style](https://github.com/UI5/mcp/blob/main/docs/Guidelines.md#commit-message-style)
diff --git a/.github/in-solidarity.yml b/.github/in-solidarity.yml
@@ -0,0 +1 @@
+_extends: ietf/terminology
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,40 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+# No permissions are required for this workflow
+permissions: {}
+
+jobs:
+  test:
+    name: General checks, tests and coverage reporting
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js 24
+      uses: actions/setup-node@v4.0.2
+      with:
+        node-version: 24
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Perform ESLint check
+      run: npm run lint
+
+    - name: Perform Licenses check
+      run: npm run check-licenses
+
+    - name: Perform dependency check
+      run: npm run depcheck
+
+    - name: Perform build
+      run: npm run build-test
+
+    - name: Run tests
+      run: npm run coverage
diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml
@@ -0,0 +1,22 @@
+name: Commit Message Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v6
diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml
@@ -0,0 +1,22 @@
+name: Issue/Pull Request Handling
+on:
+  schedule:
+    - cron: '00 20 * * *'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    name: Flag and close stale issues
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v9
+        with:
+          stale-issue-message: 'This issue has been automatically marked as stale because it has been open for 60 days with no activity. It will be closed in 10 days if no further activity occurs.'
+          stale-issue-label: 'stale'
+          stale-pr-label: 'stale'
+          days-before-stale: 60
+          days-before-close: 10
+          only-labels: 'information required'
diff --git a/.github/workflows/reuse-compliance.yml b/.github/workflows/reuse-compliance.yml
@@ -0,0 +1,21 @@
+name: REUSE
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+# No permissions are required for this workflow
+permissions: {}
+
+jobs:
+  compliance-check:
+    name: Compliance Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Execute REUSE Compliance Check
+      uses: fsfe/reuse-action@v5
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,112 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# build / generate output
+dist
+
+# Gatsby files
+.cache/
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+.DS_Store
+
+# IDEs
+.vscode/
+*.~vsdx
+.idea/
+*.sublime-workspace
+
+# Generated code
+/lib/
+
+# Temporary files
+/tmp/
+/test/tmp/
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -0,0 +1 @@
+npm run hooks:pre-push
diff --git a/.husky/skip.js b/.husky/skip.js
@@ -0,0 +1,5 @@
+if (process.env.CI) {
+	process.exit(0);
+} else {
+	process.exit(1);
+}
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,3 @@
+# Enforce public npm registry
+registry=https://registry.npmjs.org/
+lockfile-version=3
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
diff --git a/SUPPORT.md b/SUPPORT.md
diff --git a/docs/Guidelines.md b/docs/Guidelines.md
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
