Rules.md

Rules Reference

• Rules Reference
  • async-component-flags
  • csp-unsafe-inline-script
  • no-ambiguous-event-handler
  • no-deprecated-api
  • no-deprecated-component
  • no-deprecated-control-renderer-declaration
  • no-deprecated-library
  • no-deprecated-theme
  • no-globals
  • no-implicit-globals
  • no-pseudo-modules
  • parsing-error
  • prefer-test-starter
  • ui5-class-declaration
  • unsupported-api-usage

async-component-flags

Checks whether a Component is configured for asynchronous loading via the sap.ui.core.IAsyncContentCreation interface in the Component metadata or via async flags in the manifest.json.

Related information

• Use Asynchronous Loading
• Component Metadata
• sap.ui.core.IAsyncContentCreation

csp-unsafe-inline-script

Checks whether inline scripts are used in HTML files in accordance with Content Security Policy (CSP) best practices.

Related information

• Content Security Policy

no-ambiguous-event-handler

Checks whether event handlers in XML views/fragments are prefixed by a dot '.' (i.e. represent a controller method) or refer to a local name (via core:require import).

Related information

• Handling Events in XML Views

no-deprecated-api

Checks whether deprecated APIs, features or parameters are used in the project.

Related information

• Best Practices for Developers

no-deprecated-component

Checks for dependencies to deprecated components in manifest.json.

Related information

• Deprecated Themes and Libraries

no-deprecated-control-renderer-declaration

Checks whether the renderer of a control is declared correctly.

no-deprecated-library

Checks for dependencies to deprecated libraries in manifest.json and ui5.yaml.

Related information

• Deprecated Themes and Libraries

no-deprecated-theme

Checks for usage of deprecated themes in the code and HTML files.

Related information

• Deprecated Themes and Libraries

no-globals

Checks for the usage of global variables in the code.

Related information

• Best Practices for Developers

no-implicit-globals

Checks whether:

• modules are accessed via the global library namespace that is exposed by the library module of a UI5 library
• odata globals are used implicitly in bindings without an explicit import of the corresponding modules

Related information

• Best Practices for Developers

no-pseudo-modules

Checks for dependencies to pseudo modules in the code.

Related information

• Best Practices for Loading Modules - Migrating Access to Pseudo Modules

parsing-error

Syntax/parsing errors that appear during the linting process are reported with this rule.

prefer-test-starter

Checks whether test-related files are using the Test Starter concept.

Related information

• Test Starter

ui5-class-declaration

Checks whether the declaration of UI5 classes is correct. This rule only applies to TypeScript code where built-in ECMAScript classes are used instead of an .extend() call.

unsupported-api-usage

Checks whether the UI5 API is used correctly, for example, whether a formatter in a JavaScript/TypeScript binding declaration is of type function.