eslint-plugin-circuit-ui

@sumup-oss/eslint-plugin-circuit-ui

ESLint rules to help users follow best practices when using Circuit UI.

Installation

Depending on your preference, run one of the following in your terminal:

# With npm
npm install --save-dev @sumup-oss/eslint-plugin-circuit-ui

# With yarn v1
yarn add --dev @sumup-oss/eslint-plugin-circuit-ui

Usage

Add the plugin to your ESLint configuration file:

{
  "plugins": ["@sumup-oss/circuit-ui"]
}

Rules are configured under the rules section:

{
  "rules": {
    "@sumup-oss/circuit-ui/<rule-name>": "error"
  }
}

Supported Rules

• component-lifecycle-imports
• no-invalid-custom-properties
• no-deprecated-components
• no-deprecated-props
• no-renamed-props
• prefer-custom-properties
• renamed-organization-imports