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
- abap-adt-apiabap-adt-apiA JS/TS client for the ADT resources an ABAP system exposes, so a program outside the system can do against it what the maintainer calls a good share of what the Eclipse tools do.independent, abapJS/TS client for the ADT resources of an ABAP systemfrom ABAP
- abap2UI5 Playgroundabap2UI5 PlaygroundABAP in the editor on the left and the abap2UI5 app it builds on the right, both inside one browser tab: the framework is transpiled to JavaScript at build time and the class in the editor is compiled when Run is pressed.community org, abapIn-browser ABAP editor beside the abap2UI5 app it buildsfrom ABAP
- abap2UI5 for VS Codeabap2UI5 for VS CodeA VS Code extension for abap2UI5 apps: F9 starts the app class in a preview beside the source, Ctrl+F3 activates the class and reloads it, and the abap2UI5 linter runs in the editor while you type.community org, abapVS Code extension to preview, activate and lint abap2UI5 appsfrom ABAP
- vscode-tabl-ddicvscode-tabl-ddicA VS Code extension that registers .tabl.ddic files, the DDIC DDL form of an ABAP table definition, as a language of their own with a TextMate grammar for syntax highlighting, and nothing more.community org, abapVS Code syntax highlighting for .tabl.ddic table definitionsfrom ABAP
- HammerHammerA native macOS code editor for ABAP and CDS, with an Object Navigator, Transport Organizer, Data Browser and Gateway Client in the same app as the editor.independent, abapNative macOS code editor for ABAP and CDSfrom ABAP
- cds-eclipse-plugincds-eclipse-pluginEclipse plugin for the CDS language.independent, capEclipse plugin for the CDS languagefrom CAP
- @arc-mcp/adt-ls@arc-mcp/adt-lsA TypeScript SDK over adt-ls, the headless language server SAP ships inside ABAP Development Tools for VS Code, so a program drives it without the discovery, JVM and handshake work.independent, abapTypeScript SDK over SAP's headless adt-ls language serverfrom ABAP
- abapthemesabapthemesThree colour themes for ABAP source in ABAP Development Tools for Eclipse, shipped as an Eclipse plugin and installed from the maintainer's own update site.independent, abapThree colour themes for ABAP source in ADT for Eclipsefrom ABAP
- 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 CAPfrom BTP/BAIP
- SAP Business Application StudioSAP Business Application StudioSAP's development environment for business applications, delivered as a cloud service and opened in a browser, where work happens in preconfigured dev spaces.sap official, btpBrowser-based development environment with dev spacesfrom BTP/BAIP
- 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 appsfrom BTP/BAIP
- cds-intellijcds-intellijSAP CDS language support for IntelliJ IDEA.sap official, capSAP CDS language support for IntelliJ IDEAfrom CAP
- Cloud ALM Link for ADTCloud ALM Link for ADTAn Eclipse plugin that shows the transports and SAP Cloud ALM features behind an ABAP object, and turns Cloud ALM IDs in source comments into links.independent, abapEclipse plugin linking ABAP transports to SAP Cloud ALM featuresfrom ABAP
- ABAP Call HierarchyABAP Call HierarchyAn Eclipse plugin that shows which members a class method, function module or subroutine calls, read from its own ADT backend in the system and published on a beta update site only.independent, abapEclipse plugin showing the call hierarchy of ABAP membersfrom ABAP
- abap-call-hierarchyabap-call-hierarchyThe ADT backend needed by the separate ABAP Call Hierarchy Eclipse plugin, installed in the ABAP system with abapGit and still in beta, which its maintainer calls not feature complete.independent, abapADT backend for the ABAP Call Hierarchy Eclipse pluginfrom ABAP
- abap-tags-backendabap-tags-backendThe ADT backend needed by the separate ABAP Tags Eclipse plugin, installed in the ABAP system with abapGit; an upgrade to v2.0.0 or later runs a migration program for its new database tables.independent, abapADT backend for the ABAP Tags Eclipse pluginfrom ABAP
- ABAP TagsABAP TagsAn Eclipse plugin for putting arbitrary tags on repository objects, with a Tag Manager view, tagged object search and tag import and export, served by its own ADT backend in the system.independent, abapEclipse plugin for tagging ABAP repository objectsfrom ABAP
- BellaBellaAn Eclipse plugin that puts Claude into ABAP Development Tools: explain, generate, rework and implement from the editor's context menu, completion as ghost text, and a chat whose tools reach the system through the developer's existing ADT logon.independent, abapEclipse plugin bringing Claude into ABAP Development Toolsfrom ABAP
- ABAP Syntax HighlightingABAP Syntax HighlightingA VS Code extension that registers .abap files as the language abap and colours them with a TextMate grammar.independent, abapVS Code syntax highlighting for .abap filesfrom ABAP
- abapfs_extensionsabapfs_extensionsABAP imported with abapGit that sets the stateful session flag on systems older than 7.51, so an HTTP client of the ADT resources can update objects there.independent, abapABAP objects enabling ADT updates on systems older than 7.51from ABAP
- ABAP remote filesystemABAP remote filesystemA Visual Studio Code extension that opens an ABAP system over ADT as an editable filesystem and exposes system tools to GitHub Copilot and external MCP clients.independent, abapVS Code extension editing ABAP systems over ADT as a filesystemfrom ABAP
- ABAP Development Tools for EclipseABAP Development Tools for EclipseSAP's Eclipse plugins for ABAP: source, dictionary and CDS editors, Project Explorer, Outline and ABAP Unit, calling ADT resources on the connected system.sap official, abapSAP's Eclipse plugins for ABAP development over ADTfrom ABAP
- ABAP Development Tools for VS CodeABAP Development Tools for VS CodeSAP's ABAP tools in VS Code: editing, debugging, ABAP Unit, ATC and transports for classes, CDS and RAP objects, over RFC to an on-premise or Private Cloud system and HTTP to a cloud one, with Joule's ADT MCP server and code completion behind an AI-unit licence.sap official, abapSAP's ABAP tools in VS Code for editing, debugging, ATC and transportsfrom ABAP
- @sap/cds-lsp@sap/cds-lspLanguage server for CDS — the engine behind completion, navigation and inline errors in every supported editor.sap official, capLanguage server for CDSfrom CAP
- cds-textmate-grammarcds-textmate-grammarThe TextMate grammar for the CDS language, which highlights .cds files where the CDS language server does not run, most visibly in GitHub's own file viewer through Linguist.sap official, capTextMate grammar for the CDS languagefrom CAP
- @sap/ux-cds-odata-language-server-extension@sap/ux-cds-odata-language-server-extensionAdds the OData annotation features to @sap/vscode-cds, the CDS plug-in for Visual Studio Code: completion, micro-snippets, diagnostics, vocabulary documentation, Go to Definition and an i18n check inside a .cds file.sap official, capOData annotation features for the @sap/vscode-cds extensionfrom CAP
- @sap/vscode-cds@sap/vscode-cdsSAP CDS language support for Visual Studio Code and Business Application Studio, published as an npm library.sap official, capCDS language support for VS Code and Business Application Studiofrom CAP
- @saptools/hana-lens@saptools/hana-lensCompiles every CAP package in a workspace into one minified CSN cache, so "where is this entity and what columns does it have" is a query rather than a monorepo load.independent, capWorkspace-wide CSN cache for querying CAP entities and columnsfrom CAP
- @saptools/sqltools@saptools/sqltoolsA command line that turns the HANA service binding of a Cloud Foundry app into a connection for the SQLTools extension in VS Code, written to the workspace's .vscode/settings.json.independent, btpSQLTools connection from a Cloud Foundry app's HANA bindingfrom BTP/BAIP
- zed-cds-extensionzed-cds-extensionCDS language support for the Zed editor, wiring the CDS language server into it.independent, capCDS language support for the Zed editorfrom CAP
- my-ide-actionsmy-ide-actionsA collection of eight ABAP Development Tools IDE Actions covering class creation, conversion of classic Open SQL to ABAP SQL, code snippets and RAP tooling.independent, abapCollection of ABAP Development Tools IDE Actionsfrom ABAP
- @cbs-consulting/cds-eslint@cbs-consulting/cds-eslintAn ESLint plugin for CDS files carrying one consultancy's own rules, published so that the consultancy's projects lint their CDS models the same way.independent, capESLint plugin with one consultancy's rules for CDS filesfrom CAP
- @cbs-consulting/tools@cbs-consulting/toolsShared ESLint configuration for SAPUI5 and CAP projects, the config rather than the rules, so a team adopts a house style by adding one dependency.independent, capShared ESLint configuration for SAPUI5 and CAP projectsfrom CAP
- 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 filesfrom UI5
- 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 Codefrom UI5
- eslint-plugin-better-cap-configeslint-plugin-better-cap-configA set of ESLint rules that read CAP configuration and flag the cds settings that have since been deprecated, putting that check in the linter a project already runs, with no dependencies of its own.independent, capESLint rules flagging deprecated CAP configurationfrom CAP
- hana-linterhana-linterA command line that checks the names of the native SAP HANA artifact files in a CAP project, and the identifiers inside them, against regex rules the project keeps in a config file.independent, capRegex naming rules for SAP HANA artifacts in a CAP projectfrom CAP
- @sap/eslint-plugin-cds@sap/eslint-plugin-cdsSAP's ESLint plugin for CDS, carrying the model and environment rules capire calls best practice and universal for every CAP project.sap official, capSAP's ESLint plugin for CDSfrom CAP
- @sap-ux/eslint-plugin-fiori-tools@sap-ux/eslint-plugin-fiori-toolsESLint rules from the Fiori tools team, aimed at the parts of a project their generators produce.sap official, capESLint rules for projects the Fiori tools generators producefrom CAP
- @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 projectsfrom UI5
- @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 projectsfrom UI5
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