sapui5-linter

Detects deprecated APIs, globals, and manifest issues in SAPUI5 and OpenUI5 projects.

Updated May 18, 2026
One-click install
npx skills add https://github.com/Melik1986/axon-erp-api --skill sapui5-linter-melik1986
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sapui5-linter
Source: https://github.com/Melik1986/axon-erp-api/tree/main/cursor/skills/sapui5-linter
Command: npx skills add https://github.com/Melik1986/axon-erp-api --skill sapui5-linter-melik1986

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @ui5/linter, and includes references (resource) components.

What problem does it solve? SAPUI5 and OpenUI5 codebases accumulate deprecated API usage, global variable references, CSP violations, and outdated manifest properties that block UI5 2.x migration. Manually auditing JavaScript, TypeScript, XML views, and manifest.json files across a project is slow and error-prone. ## Core Features & Use Cases - Static Code Analysis: Runs @ui5/linter to detect 19 rule categories including no-deprecated-api, no-globals, csp-unsafe-inline-script, and manifest modernization issues. - Autofix Guidance: Applies automatic fixes for global references, supported deprecated APIs, event handler notation, and manifest properties, with dry-run preview via UI5LINT_FIX_DRY_RUN. - CI/CD Integration: Provides templates for GitHub Actions, GitLab CI, Jenkins, Husky pre-commit hooks, and lint-staged workflows with JSON, Markdown, and HTML report formats. - Use Case: Before migrating an app to UI5 2.x, run ui5lint --details to inventory all deprecated Core and jQuery.sap calls, apply autofixes, then manually refactor the unsupported sync-to-async APIs. ## Quick Start Ask the assistant to set up the UI5 Linter in your project and run an initial lint check with detailed output.

Frequently Asked Questions about sapui5-linter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up UI5 Linter in my SAPUI5 project?▼

Install @ui5/linter globally with npm install --global @ui5/linter or locally as a devDependency, then run ui5lint from the project root. Optionally create a ui5lint.config.mjs file to define ignore patterns and target files.

How to autofix deprecated APIs in UI5 code?▼

Run ui5lint --fix to automatically correct supported issues like global references, some deprecated Core and Configuration APIs, event handler notation, and manifest properties. Preview changes first with UI5LINT_FIX_DRY_RUN=true ui5lint --fix, then review with git diff.

Does UI5 Linter support TypeScript and XML views?▼

Yes, UI5 Linter analyzes JavaScript, TypeScript, XML views and fragments, JSON files like manifest.json, HTML bootstrap scripts, and YAML files such as ui5.yaml. It includes rules specific to TypeScript class declarations.

What are the limitations of UI5 Linter autofix?▼

Autofix cannot convert synchronous APIs to asynchronous patterns, handle code outside sap.ui.define or sap.ui.require blocks, or replace APIs lacking direct equivalents. Many Core methods and most jQuery.sap APIs require manual refactoring.

Why is ui5lint reporting parsing errors?▼

Parsing errors usually indicate syntax errors in the analyzed source files or configuration files. Check the flagged files for invalid JavaScript, TypeScript, or XML syntax, and verify your ui5lint.config file has no syntax mistakes.

How do I integrate UI5 Linter into GitHub Actions CI?▼

Add a workflow step that installs dependencies with npm ci and runs ui5lint --quiet --format json to fail builds on errors. You can also upload HTML reports as artifacts and use caching to speed up repeated lint runs.