vscode-ui5-language-assistant
SAP's VS Code extension for SAPUI5 and OpenUI5: completion, validation, hover tooltips, go to definition, quick fix and formatting for XML views, and completion and validation for manifest.json.
Language support for UI5 XML views in VS Code, driven by SAPUI5 metadata that the extension downloads lazily. In a view it offers classes, aggregations, properties, events, associations, enum and boolean values and namespace prefixes, filtered by the type of the parent aggregation and the xmlns prefix in use, with deprecated and experimental nodes left out by default and a link to the SAPUI5 SDK in the suggestion tooltip. It reports unknown tags and attribute keys, duplicate IDs, wrong aggregation cardinality, malformed binding info and a missing ID when flexEnabled is true in manifest.json, and warns on deprecated classes, properties and events; the quick fix adds a generated ID. The metadata comes from the version in minUI5Version, the closest LTS version when that one cannot be retrieved, and 1.71 when it is 1.38 or older or undefined. The README says the validations and their severity are hard-coded and cannot be configured, and that CAP projects need the @sap/cds module installed.
Facts
Where it sits
Who is behind it
In the atlas: maintains 137, wrote 14@SAPmaintainerAlla VolkovContributes to this
In the atlas: contributes to 2@allaVolkovArtemis CoderContributes to this
In the atlas: contributes to 9@Artemis-Coder17Shahar SoelContributes to this
In the atlas: contributes to 2@bd82Florian VogtContributes to this
In the atlas: contributes to 50, wrote 2@flovogtJimmy JosephContributes to this
In the atlas: contributes to 11@Jimmy-Joseph19Johannes KolbeContributes to this
In the atlas: contributes to 10@johannes-kolbeKlaus KellerContributes to this
In the atlas: contributes to 15@Klaus-KellerMaruf RasullyContributes to this
In the atlas: contributes to 12@marufrasullymichawaiContributes to this
In the atlas: contributes to 2@michawaiMariana NabokaContributes to this
In the atlas: contributes to 1@MN-public22 contributors
What it declares
Every artifact
- Type
- IDE extension
- Origin
- By SAP
As an IDE extension
- Installs into
- VS Code
- Distributed through
- Visual Studio Marketplace
Connections
Editor help with source: completion, navigation, errors, refactoring
Catching problems in code, models and configuration by rules
CAP Node.js runtime
Download
README
quoted from SAP/ui5-language-assistant under Apache-2.0, readUI5 Language Assistant
This npm mono-repo contains editor related tooling for SAPUI5 and OpenUI5 projects.
It currently contains:
-
The UI5 language assistant VSCode Extension consisting of the following packages:
- @ui5-language-assistant/language-server UI5 Language Server.
- @ui5-language-assistant/context Common shared data model container (UI5 API loaded version cache, project information, ODATA services, manifest information, etc.) with utilities to load and parse the data used in other packages in this mono-repo.
- @ui5-language-assistant/fe UI5 Language Server extension to support SAP Fiori elements building blocks.
- @ui5-language-assistant/logic-utils Common shared logic and data structures related utilities used in other packages in this mono-repo.
- @ui5-language-assistant/semantic-model Data structure and related utils to represent the UI5 metadata.
- @ui5-language-assistant/semantic-model-types Type signatures for the semantic model.
- @ui5-language-assistant/settings Settings used in other packages in this mono-repo.
- @ui5-language-assistant/user-facing-text User facing text used in other packages in this mono-repo.
- @ui5-language-assistant/xml-views-completion Logic for UI5 XML views code assist.
- @ui5-language-assistant/xml-views-tooltip Logic for UI5 XML views hover tooltip.
- @ui5-language-assistant/xml-views-validation Logic for UI5 XML views semantic validations.
- @ui5-language-assistant/xml-views-quick-fix Logic for UI5 XML-Views quick-fixes.
- @ui5-language-assistant/xml-views-quick-fix Logic for UI5 XML-Views quick-fixes.
-
The wrapper module for SAP Business Application Studio simple extension containing UI5 Language Assistant bundled into VSCode extension vsix file
Support
Please open issues on github.
Contributing
See CONTRIBUTING.md.
Licensing
Copyright 2023 SAP SE. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
History
Others providing
- SAP Build CodeSAP Build CodeSAP's development environment on BTP for SAPUI5, SAP Fiori, mobile and CAP applications that run on the SAP BTP, Cloud Foundry Runtime, in which Joule generates models, services, logic, tests and apps.sap official, btpDevelopment environment on BTP for UI5, Fiori, mobile and CAP
- SAP Web IDE Full-StackSAP Web IDE Full-StackSAP's IDE service on BTP for SAPUI5 and SAP Fiori apps, full-stack SaaS applications, SAP S/4HANA extensions, hybrid mobile apps and IoT apps, with an SDK for extending the IDE itself.sap official, btpIDE service on SAP BTP for SAPUI5, Fiori and full-stack apps
- ui5plugin-linterui5plugin-linterA command-line linter for UI5 projects, run as ui5linter, that checks JavaScript and TypeScript classes, XML views and fragments, and i18n properties files.independent, ui5Command-line linter for UI5 classes, XML views and i18n files
- ui5pluginui5pluginThe SAPUI5 Extension for Visual Studio Code: completion, definitions, CodeLens, diagnostics, code actions, hover and an XML formatter for UI5 views, controllers and manifest.json.independent, ui5SAPUI5 extension for Visual Studio Code
- @satiroglu/kaev@satiroglu/kaevA command line that runs rule-based checks over a SAPUI5 or OpenUI5 project, reporting each finding with a rule id, a category, a severity, a confidence and the file it sits in.independent, ui5Rule-based checker for SAPUI5 and OpenUI5 projects
- @ui5/linter@ui5/linterSAP's static analysis tool for UI5 projects: it scans JavaScript, TypeScript, XML, JSON and other files for deprecated APIs, global variables and possible CSP violations, and fixes part of them with --fix.sap official, ui5Static analysis tool for UI5 projects
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:sap-vscode-ui5-language-assistant- JSON
- /artifacts/sap-vscode-ui5-language-assistant.json
- MCP
- Connecting an agent