@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

import fioriTools from '@sap-ux/eslint-plugin-fiori-tools';

export default [
    ...fioriTools.configs.recommended
];

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.

import fioriTools from '@sap-ux/eslint-plugin-fiori-tools';

export default [
    ...fioriTools.configs.recommended
];

1. 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](Excluding files with ignores).

   import fioriTools from '@sap-ux/eslint-plugin-fiori-tools';
   
   export default [
      {
         ignores: ['dist']
      },
         ...fioriTools.configs.recommended
   ];
   

2. Delete the .eslintignore file.

3. If the .eslintrc file contains only either of the following options, it can be deleted.

   {
    "extends": "plugin:@sap-ux/eslint-plugin-fiori-tools/defaultJS",
    "root": true
   }
   

   or

   {
    "extends": "plugin:@sap-ux/eslint-plugin-fiori-tools/defaultTS",
    "root": true
   }
   

   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.

4. 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.

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

6. 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

7. 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:

npx --yes @sap-ux/create@latest convert eslint-config

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

npx --yes @sap-ux/create@latest convert eslint-config --help

Rules

<div style="overflow-x: auto;">…