@sap-ux/eslint-plugin-fiori-tools weekly downloads statistics

@sap-ux/eslint-plugin-fiori-tools

Custom linting plugin for SAP Fiori apps

Installation

npm: npm install --save @sap-ux/eslint-plugin-fiori-tools

Yarn: yarn add @sap-ux/eslint-plugin-fiori-tools

pnpm: pnpm add @sap-ux/eslint-plugin-fiori-tools

Usage

To consume this module, add @sap-ux/eslint-plugin-fiori-tools to your project's eslint config file, for example, eslint.config.mjs. You must specify one of the following configurations:

• recommended: Contains rules for JavaScript & TypeScript on both production and test code. • recommended-for-s4hana: contains rules for JavaScript & TypeScript on both production and test code. This configuration is recommended for SAP internal use.

eslint.config.mjs

Manually Migrate from eslint@8, @sap-ux/eslint-plugin-fiori-tools@0.6.x, or eslint-plugin-fiori-custom

All rules from eslint-plugin-fiori-custom have been migrated to @sap-ux/eslint-plugin-fiori-tools version 9.

Note: ESLint 9 requires you to use the new flat config. 1. Create the eslint.config.mjs file.

2. Copy any values from the .eslintignore file (if it exists) into the eslint.config.mjs file by adding the ignores array.

For more information, see https://eslint.org/docs/latest/use/configure/configuration-files#excluding-files-with-ignores.

3. Delete the .eslintignore file. 4. If the .eslintrc file contains only either of the following options, it can be deleted. or Note: If you have custom rules or configuration in your .eslintrc file, do not delete your .eslintrc file. For information about how to migrate your custom rules, see Migrate to v9.x.

5. In the package.json file, performing the following:

• Remove eslint-plugin-fiori-custom, if it exists. • Update eslint to version ^9.

Update @sap-ux/eslint-plugin-fiori-tools to version ^9.

6. Execute in the project root directory: npm install.

7. Find any references to fiori-custom/ in your source code and replace them with @sap-ux/fiori-tools/: for example,

//eslint-disable fiori-custom/sap-browser-api-warning becomes //eslint-disable @sap-ux/fiori-tools/sap-browser-api-warning

8. Execute in the project root directory: npm run lint. Check the output for errors or warnings and fix them.

Automatically Migrate from eslint@8, @sap-ux/eslint-plugin-fiori-tools@0.6.x, or eslint-plugin-fiori-custom

To automatically migrate from eslint@8, @sap-ux/eslint-plugin-fiori-tools@0.6.x, or eslint-plugin-fiori-custom to eslint@9 and @sap-ux/eslint-plugin-fiori-tools@9 (or higher), execute the following command in the project root directory:

For more information about the @sap-ux/create command, run

Rules

| Since | Rule | Description | Recommended | Recommended for S/4HANA |

| new | sap-micro-chart-requires-navigation-entity | Ensures that micro chart measures and dimensions reference properties using a 1:n navigation entity path. | | ✅ | | 10.16.0 | sap-no-inline-delete-with-multiselect | Ensures that inlineDelete and multiselect are not both enabled in the same table settings, as they are mutually exclusive and will cause the application to fail. | | ✅ | | 10.15.0 | sap-no-comma-in-section-title | Ensures that section and subsection titles in object pages for SAP Fiori elements applications do not contain commas. | | ✅ | | 10.14.0 | sap-no-path-hidden-on-interactive-columns | A UI.Hidden annotation with a dynamic path must not be used on sortable or filterable columns. | | ✅ | | 10.12.0 | sap-field-group-in-table-type-restriction | Ensures UI.FieldGroup is not used in a GridTable, AnalyticalTable, or TreeTable, because it is only supported in a ResponsiveTable. | | ✅ | | 10.11.0 | sap-no-deep-collection-facets | Ensures UI.CollectionFacet elements are not nested at third level or deeper. | | ✅ | | 10.10.0 | sap-no-single-facet-in-collection | Ensures UI.CollectionFacet is not used when it contains only a single UI.ReferenceFacet. | | ✅ | | 10.8.0 | sap-cloud-dev-adaptation-status | Ensures that cloudDevAdaptationStatus is defined in the sap.fiori section of the manifest.json file. | | ✅ | | 10.7.6 | sap-no-live-mode | Ensures that live mode is not enabled. | | ✅ | | 10.2.0 | sap-description-column-label | Ensures that the description text property referenced using the Common.Text annotation has a meaningful Common.Label annotation. It must not be a generic value such as "Name" or "Description", and not the same label as the ID property. | | ✅ | | 9.12.0 | sap-text-arrangement-hidden | Ensures that the text property referenced by a UI.TextArrangement annotation using the Common.Text annotation is not hidden by the UI.Hidden annotation | | ✅ | | 9.11.0 | sap-no-data-field-intent-based-navigation | Ensures neither DataFieldForIntentBasedNavigation nor DataFieldWithIntentBasedNavigation are used in tables or form fields in SAP Fiori elements applications. | | ✅ | | 9.10.0 | sap-condensed-table-layout | Requires condensedTableLayout to be enabled when using a grid table, analytical table, or tree table. | | ✅ | | 9.9.0 | sap-strict-uom-filtering | Ensures that disableStrictUomFiltering is not set to true in sap.fe.app manifest configuration | | ✅ | | 9.8.0 | sap-table-personalization | Ensures that all table personalization options are enabled in the OData V4 applications. | | ✅ | | 9.7.0 | sap-anchor-bar-visible | Anchor Bar Visible should not be set to false in manifest settings for object page headers (except form entry object pages). | | ✅ | | 9.5.0 | sap-table-column-vertical-alignment | Ensures tableColumnVerticalAlignment Configuration for Responsive Type Tables in SAP Fiori Elements applications | | ✅ | | 9.4.0 | sap-enable-export | Ensures that the export to Excel functionality for tables in OData V4 and OData V2 applications is enabled | | ✅ | | 9.4.0 | sap-enable-paste | Ensures that the paste functionality for tables in OData V4 and OData V2 applications is enabled | | ✅ | | 9.3.1 | sap-state-preservation-mode | Ensures Valid statePreservationMode Configuration in SAP Fiori Elements | | ✅ | | 9.1.0 | sap-copy-to-clipboard |…

Description from the npm listing.