Skip to content

Latest commit

 

History

History

configs

README.md

Cloudify UI Common Configurations

npm

This package contains shared configuration for development tools:

  1. ESLint configurations - see eslint-*.json files
  2. TypeScript configurations - see tsconfig.*.json files
  3. Prettier configuration - see prettier-common.json file

Installation

npm install cloudify-ui-common-configs

More packages should be installed depending on the chosen configuration file you use. See details below.

Usage

ESLint

ESLint configs should be extended by every Cloudify UI project/module.

Usage

Once cloudify-ui-common-configs is installed as a dependency it is required to modify project's ESLint config (most probably .eslintrc or .eslintrc.json file) by adding the following entry (assuming ESLint config file is located in top level directory and it is a React project):

{
  "extends": ["./node_modules/cloudify-ui-common-configs/eslint-common-react.json"]
}

It is also required to install peer dependencies as specified in package.json. There are few configuration files that can be extended. The table below describes their purpose and dependencies necessary to be installed prior using each configuration file.

Note: eslint-common.json and eslint-common-jest.json don't extend AirBnB ESLint configuration, so they should not be used alone in the UI projects.

Configuration file Used for Dependencies
eslint-ts-overrides.json TypeScript-based projects @typescript-eslint/eslint-plugin, @typescript-eslint/parser
eslint-common.json a base for other configs eslint, eslint-config-prettier, eslint-plugin-import, eslint-plugin-prettier, eslint-plugin-no-unsanitized, eslint-plugin-security, eslint-plugin-security-node, eslint-plugin-xss
eslint-common-react.json React-based projects all from eslint-config-airbnb and eslint-common.json and eslint-plugin-react, eslint-plugin-react-hooks, eslint-plugin-jsx-a11y
eslint-common-node.json Node-based projects all from eslint-config-airbnb-base and eslint-common.json, eslint-plugin-node
eslint-common-cypress.json Cypress subprojects all from eslint-config-airbnb-base and eslint-common.json, eslint-plugin-cypress, eslint-plugin-chai-friendly
eslint-common-jest.json Jest subprojects eslint-plugin-jest
eslint-common-backend.json Backends eslint-common-node.json, eslint-common-jest.json

TypeScript

There are 3 possible base tsconfig.json files:

  1. tsconfig.base.json - contains compiler options that help maintain code quality. They allow using JavaScript and TypeScript in the same project.

    This configuration should be used for user-facing projects that do not need to be used as dependencies in other projects (not libraries).

  2. tsconfig.composite.json - extends tsconfig.base.json with settings necessary to allow generating declaration maps.

    This is useful for libraries, which are consumed by other user-facing projects.

  3. tsconfig.node.json- extends tsconfig.base.json with settings specific to ts-node projects.

To use an existing tsconfig as a base, specify the extends property in your tsconfig.json:

{
    "extends": "./node_modules/cloudify-ui-common-configs/tsconfig.base.json"
}

Prettier

Prettier config should be extended by every Cloudify UI project/module.

Once cloudify-ui-common-configs is installed as a dependency it is required to modify project's Prettier config (you should use JS version - .prettierrc.js file) by requiring common configuration the following way:

module.exports = require('./node_modules/cloudify-ui-common-configs/prettier-common.json');