@cbs-consulting/tools

@cbs-consulting/tools is a configuration package that provides shared ESLint configurations for developing SAPUI5 and/or SAP Cloud Application Programming Model (SAP CAP) applications. Furthermore, it includes a Prettier configuration to ensure consistent code formatting across projects.

ESLint

Installation

There are separate rule sets per framework and language. All these rule sets are based on a common rule set.

SAPUI5 (JavaScript)

For SAPUI5 projects using JavaScript, install the following dev dependencies:

npm install --save-dev @cbs-consulting/tools eslint

SAPUI5 (TypeScript)

For SAPUI5 projects using TypeScript, install the following dev dependencies:

npm install --save-dev @cbs-consulting/tools eslint typescript-eslint

SAP CAP (JavaScript)

For SAP CAP projects using JavaScript, install the following dev dependencies:

npm install --save-dev @cbs-consulting/tools eslint @sap/cds @sap/eslint-plugin-cds

SAP CAP (TypeScript)

For SAP CAP projects using TypeScript, install the following dev dependencies:

npm install --save-dev @cbs-consulting/tools eslint typescript-eslint @sap/cds @sap/eslint-plugin-cds

Usage

To use the ESLint configurations, create or extend the relevant configuration in the eslint.config.mjs file.

SAPUI5

JavaScript

import ui5JsConfig from "@cbs-consulting/tools/eslint/ui5/js/eslint.config.mjs";

export default ui5JsConfig;

TypeScript

import ui5TsConfig from "@cbs-consulting/tools/eslint/ui5/ts/eslint.config.mjs";

export default ui5TsConfig;

SAP CAP

JavaScript

import capJsConfig from "@cbs-consulting/tools/eslint/cap/js/eslint.config.mjs";

export default capJsConfig;

TypeScript

import capTsConfig from "@cbs-consulting/tools/eslint/cap/ts/eslint.config.mjs";

export default capTsConfig;

Prettier

Installation

Install the necessary packages via npm:

npm install --save-dev @cbs-consulting/tools prettier prettier-plugin-organize-imports @prettier/plugin-xml

To use the Prettier configuration, extend it in your prettier.config.mjs file:

import prettierConfig from "@cbs-consulting/tools/prettier/prettier.config.mjs";

export default prettierConfig;

UI5 Linter

npm install --save-dev @cbs-consulting/tools @ui5/linter

To use the UI5 Linter configuration, create a configuration file ui5lint.config.mjs.

import ui5LinterConfig from "@cbs-consulting/tools/ui5linter/ui5lint.config.mjs";

export default ui5LinterConfig;

License

This package is licensed under the MIT License.