@costquest/eslint-plugin

Linting rules for Costquest projects using Javascript or Typescript.

Plugins allow us to use more complex rules that are not included in the base eslint ruleset.

Using in your project

1. Install dependencies

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

2. Create an eslint config file, eslint.config.js (note that this uses ESLint's new flat config)

import javascriptConfig from "@costquest/eslint-config/javascript";
import { defineConfig } from "eslint/config";

export default defineConfig([
    javascriptConfig,
    // Add or override rules
    {
        "prefer-const": "warn"
    }

]);

If your project is using typescript:

import typescriptConfig from "@costquest/eslint-config/typescript";
import { defineConfig } from "eslint/config";

export default defineConfig([
    typescriptConfig,
    // Add or override rules
    {
        "prefer-const": "warn"
    }

]);

If your project is using React (and typescript):

import reactTypescriptConfig from "@costquest/eslint-config/react-typescript";
import { defineConfig } from "eslint/config";

export default defineConfig([
    reactTypescriptConfig,
    // Add or override rules
    {
        "prefer-const": "warn"
    }

]);

Included Plugins

• eslint-comments
• eslint-plugin-unicorn
• eslint-plugin-react-hooks
• eslint-plugin-jsx-a11y
• eslint-plugin-react

Included Configs

Javascript

• Prettier
• eslint
• eslint-comments

Typescript

• typescript-eslint (strict)
• typescript-eslint (stylistic)

React with Typescript

• All typescript configs and...
• eslint-plugin-react recommended
• eslint-plugin-react jsx-runtime
• eslint-plugin-jsx-a11y strict
• eslint-plugin-react-hooks recommended