Skip to content

Latest commit

 

History

History

vscode-ui5-language-assistant

README.md

UI5 Language Support

This VS Code extension provides SAPUI5 language editor support.

Features

XML Views Auto-Complete/Context-Assist

Description

The tool provides the following support:

  • Relevant filters to suggestions. For example:

    • Only classes that match the parent aggregation's type are offered.
    • In a "full" aggregation with cardinality 0..1, no more suggestions are made.
    • Only classes inside the xmlns prefix used are offered.
    • Deprecated and experimental SAPUI5 nodes are not be offered by default (configurable).

  • Additional text for ease of use. For example:

    • Auto-insertion of name for closing tags for classes and aggregations.
    • Auto-insertion of ="" for attribute key suggestions.
    • Auto-insertion of the xmlns prefix for classes and aggregation tags.

  • Tooltips displayed while browsing the suggestions including a clickable link to the SAPUI5 SDK (Demo Kit).

Availability

The feature is available in the following:

  • XML tags:

    • Classes
    • Aggregations

  • XML attribute keys:

    • Properties
    • Events
    • Associations
    • Namespace prefixes

  • XML attribute values:

    • Enum values
    • Boolean values
    • Namespaces fully qualified names
    • metaPath values in building blocks
    • contextPath values for Chart building blocks
    • filterBar values from the current file in building blocks
    • Property binding info when possible
    • Aggregation binding info when possible

XML View Validations

Description

The list of validations and their severity are currently hard-coded and cannot be configured by the end user.

Validation List

  • Errors:

    • Invalid boolean values
    • Unknown attribute keys
    • Unknown eum values
    • Unknown xmlns namespace
    • Unknown tag names
    • Duplicate ID tags
    • Wrong cardinality of aggregation
    • Wrong type of tags inside aggregations
    • Missing or empty ID when flexEnabled is true in manifest.json (stableID)
    • Property binding info or aggregation binding info
      • missing key
      • missing or extra colon(s)
      • missing or wrong value
      • missing or extra comma(s)
      • duplicate keys
      • unknown key or char(s)
      • recursive composite bindings (only property binding info)

  • Warnings:

    • Use of deprecated classes
    • Use of deprecated aggregations
    • Use of deprecated properties
    • Use of deprecated events
    • Use of deprecated associations
    • References to annotations that cannot be found in current project
    • References to filter bars that cannot be found in current file
    • Use of context paths that do not lead to the annotations of types expected for the given building block

Relevant User/Workspace

  • UI5LanguageAssistant.LimitUniqueIdDiagnostics is set off by default to check all *.fragment.xml and *.view.xml files for unique IDs. If you like to limit this validation to the current file, set it on.

XML View Quick Fix

Description

Quick Fix will be shown for some validations when hovering over a diagnostic or from the problems view.

Quick Fixes List

  • Missing or empty ID when flexEnabled is true in manifest.json (stableID).
    • Will add a generated ID.
    • Supports both fixing a single missing ID or all missing IDs in an entire file.

XML View Hover Tooltips

Description

Tooltips will be shown when hovering over an item.

Availability

The feature is available in the following:

  • XML tags:

    • Classes
    • Aggregations

  • XML attribute keys:

    • Properties
    • Events
    • Associations
    • Aggregations

  • XML attribute values:

    • Enum values
    • SAPUI5 Namespaces
    • Name of property binding info or aggregation binding info

XML View Go To Definition

Description

The tool provides navigation to project files referenced in xml fragments or views with Go To Definition. The standard keyboard shortcuts for Go To Definition are Ctr / Command + Click or F12.

Availability

The feature is available for:

  • references to controller files in the following XML attributes:
    • controllerName
    • core:require
    • template:require

Semantic Highlighting

Description

Property binding info and aggregation binding are displayed semantically highlighted to let you easily grasp the sense of dense code.

Make sure that semantic highlighting is enabled. For more information, see Enablement of semantic highlighting

XML View Format

Description

The tool can format *.view.xml and *.fragment.xml files with prettier

Relevant User/Workspace settings

  • UI5LanguageAssistant.SplitAttributesOnFormat is set on by default and places each attribute on a new line on formatting.

manifest.json Auto-Complete and Validations

Description:

Implemented using the UI5 manifest.json schema.

Installation

From the VS Code Marketplace

In the UI5 Language Assistant VS Code marketplace page, click Install.

From GitHub Releases

  1. Go to GitHub Releases.
  2. Search for the .vsix archive under ui5-language-assist\@x.y.z releases. (Replace x.y.z with the desired version number.)
  3. Follow the instructions for installing an extension from a .vsix file in the VSCode's guide.

Usage

This extension's features are automatically enabled when opening/editing relevant SAPUI5 source files. For SAPUI5 XML views, this means:*.view.xml or *.fragment.xml files.

Note that the extension lazily downloads the SAPUI5 metadata needed for its features. This means that there may be a delay between starting VS Code and having the relevant features available.

When working with CAP projects, make sure you have @sap/cds module installed. For this, run npm install on your project. This command will download and install all necessary modules from the npm package repository.

Enabling offline work

You can set up a local web server to host one or more supported versions of SAP UI5 SDK and register it in the user/workspace setting "UI5LanguageAssistant.SAPUI5WebServer". This overrides the public CDN of SAP UI5 SDK in the extension and enables offline work with the apps having the matching hosted "minUI5Version" in manifest.json. When configuring local web server, make sure it responds to the exact UI5 version defined in manifest.json e.g <your.local.web.server>/1.111.0

Note: Once online, UI5 Language Assistant also caches required resources for offline usage and performance optimization.

Limitations

UI5 version and framework

This extension derives the UI5 version in the following sequence:

  1. If the exact version defined in the minUI5Version setting is not retrievable from local cache or CDN, the closest available LTS version is used.
  2. If the version is 1.38 or older, or if minUI5Version is not defined, fall back to 1.71 (latest patch level) is applied.
  3. If minUI5Version is provided in incorrect format, the latest patch version available in CDN is used.

The framework(SAPUI5/OpenUI5) is derived from the ui5.yaml file. This defaults to SAPUI5.

Custom controls

This extension does not currently support custom controls, some features, such as validations, may use heuristics to guess that a tag is a custom control. However, no auto-complete is currently offered for custom controls.

Support

You can open issues on GitHub.

Contributing

See CONTRIBUTING.md.

Licensing

Copyright 2022 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.