@quartzds/eslint-config v1.5.2

@quartzds/eslint-config

Shareable ESLint configuration for Quartz design system packages.

📦 Plugins

This configuration uses the following plugins:

• @typescript-eslint/eslint-plugin
• eslint-plugin-eslint-comments
• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-jsx-a11y
• eslint-plugin-node
• eslint-plugin-playwright
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-simple-import-sort
• eslint-plugin-sonarjs
• eslint-plugin-storybook
• eslint-plugin-unicorn

💿 Installation

The recommended installation of this configuration:

npm install --save-dev @quartzds/eslint-config eslint-import-resolver-node eslint-plugin-{eslint-comments,import,node,simple-import-sort,sonarjs,unicorn} eslint

The following dependencies may also be installed to extend this configuration:

The minimal installation of this configuration:

npm install --save-dev @quartzds/eslint-config eslint

📖 Usage

The shareable configuration can be configured in the ESLint configuration file:

{
  "extends": ["@quartzds/eslint-config"]
}

Using the @quartzds/eslint-config export will automatically extend the configuration based on the optional peer dependencies that are installed. If this behavior is not desirable, each extension may also be used individually:

{
  "extends": [
    "@quartzds/eslint-config/base",
    "@quartzds/eslint-config/eslint-comments",
    "@quartzds/eslint-config/import",
    "@quartzds/eslint-config/jest",
    "@quartzds/eslint-config/jsx-a11y",
    "@quartzds/eslint-config/node",
    "@quartzds/eslint-config/playwright",
    "@quartzds/eslint-config/react",
    "@quartzds/eslint-config/react-hooks",
    "@quartzds/eslint-config/simple-import-sort",
    "@quartzds/eslint-config/sonarjs",
    "@quartzds/eslint-config/storybook",
    "@quartzds/eslint-config/typescript",
    "@quartzds/eslint-config/unicorn"
  ]
}

🔧 Configuration

See each plugin's documentation for available configuration.

⚖️ License

See the LICENSE file for license rights and limitations.