README.md: EN | 日本語 | 繁體中文 | हिंदी

eslint-plugin-nimbus-clean

A comprehensive linting solution that sweeps your code clean. Combined rules for ESLint helps to produce high quality code by detecting suspicious patterns, bugs. Keep the code clean and consistent.

Table of Contents

• Installation
• Usage
  • Legacy config
    • Full config
    • Incrementally improvements
  • Flat config
    • Full config
    • Incrementally improvements
    • Separate rules
  • Prettier settings (optional)
• License
• Contributions
• Show your support
• Contributors

Installation

Here you can find instructions how to install it via: npm, yarn, pnpm.

You'll first need to install ESLint and TypeScript:

npm i eslint --save-dev
npm i typescript

# Or run this to use yarn
yarn add eslint --dev
yarn add typescript

# Or run this to use pnpm
pnpm add eslint --save-dev
pnpm add typescript

Next, install eslint-plugin-nimbus-clean:

npm install eslint-plugin-nimbus-clean --save-dev

# Or run this to use yarn
yarn add eslint-plugin-nimbus-clean --dev

# Or run this to use pnpm
pnpm add eslint-plugin-nimbus-clean --save-dev

Next, install all peerDependencies for this plugin:

npx install-peerdeps eslint-plugin-nimbus-clean

# Or run this to use yarn
npx install-peerdeps eslint-plugin-nimbus-clean --yarn

# Or run this to use pnpm
npx install-peerdeps eslint-plugin-nimbus-clean --pnpm

Usage

Legacy config

Suitable for ESLint version < 9

Full config

It's recommended for new projects or if you want to see all ESLint errors and warnings for existing projects.

Add nimbus-clean to the extends or plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 13,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true,
      "modules": true,
      "experimentalObjectRestSpread": true
    }
  },
  "ignorePatterns": [
    "**/*",
    "node_modules"
  ],
  "settings": {
    "react": {
      "pragma": "React",
      "fragment": "Fragment",
      "version": "detect"
    },
    "import/resolver": {
      "typescript": {
        "alwaysTryTypes": true
      }
    }
  },
  "extends": [
    "plugin:nimbus-clean/recommended"
  ],
  "plugins": [
    "nimbus-clean"
  ]
}

Incrementally improvements

If you have existing project big/old/etc. you can apply nimbus-clean config setting incrementally:

• plugin:nimbus-clean/common
• plugin:nimbus-clean/prettier
• plugin:nimbus-clean/import
• plugin:nimbus-clean/simpleImportSort
• plugin:nimbus-clean/react
• plugin:nimbus-clean/promise
• plugin:nimbus-clean/unicorn
• plugin:nimbus-clean/sonarjs
• plugin:nimbus-clean/typescript
• plugin:nimbus-clean/perfectionist

{
  ...
  "extends": [
    "plugin:nimbus-clean/common",
    "plugin:nimbus-clean/prettier",
    ...
  ],
  "plugins": [
    "nimbus-clean"
  ]
}

Flat config

Suitable for ESLint >= 9

Full config

eslint.config.js from javascript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";

const config = [
  ...nimbusCleanPlugin.configs.flat.recommended,
  // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{js,jsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
      parserOptions: {
        ecmaFeatures: { jsx: true },
        ecmaVersion: "latest",
        sourceType: "module",
      },
    },
  },
];

export default config;

eslint.config.js from typescript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";
import tsLint from "typescript-eslint";

export default tsLint.config(
  ...nimbusCleanPlugin.configs.flat.recommended,
  // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{ts,tsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
    },
  },
  {
    settings: {
      "import/resolver": {
        node: true,
        typescript: true,
      },
    },
  },
);

Incrementally improvements

If you have existing project big/old/etc. you can apply nimbus-clean config setting incrementally:

• nimbusCleanPlugin.configs.flat.common
• nimbusCleanPlugin.configs.flat.prettier
• nimbusCleanPlugin.configs.flat.import
• nimbusCleanPlugin.configs.flat.simpleImportSort
• nimbusCleanPlugin.configs.flat.react
• nimbusCleanPlugin.configs.flat.reactHooks
• nimbusCleanPlugin.configs.flat.jsxA11y
• nimbusCleanPlugin.configs.flat.promise
• nimbusCleanPlugin.configs.flat.unicorn
• nimbusCleanPlugin.configs.flat.sonarjs
• nimbusCleanPlugin.configs.flat.typescript
• nimbusCleanPlugin.configs.flat.perfectionist
• nimbusCleanPlugin.configs.flat.testingLibrary

eslint.config.js from javascript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";

const config = [
    ...nimbusCleanPlugin.configs.flat.common,
    ...nimbusCleanPlugin.configs.flat.prettier,
  // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{js,jsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
      parserOptions: {
        ecmaFeatures: { jsx: true },
        ecmaVersion: "latest",
        sourceType: "module",
      },
    },
  },
];

export default config;

eslint.config.js from typescript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";
import tsLint from "typescript-eslint";

export default tsLint.config(
  ...nimbusCleanPlugin.configs.flat.common,
  ...nimbusCleanPlugin.configs.flat.prettier,
  // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{ts,tsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
    },
  },
  {
    settings: {
      "import/resolver": {
        node: true,
        typescript: true,
      },
    },
  },
);

Separate rules

For flexible customization you can also use separate rules in your configs:

• nimbusCleanPlugin.rules.recommended
• nimbusCleanPlugin.rules.common
• nimbusCleanPlugin.rules.import
• nimbusCleanPlugin.rules.sonarjs
• nimbusCleanPlugin.rules.prettier
• nimbusCleanPlugin.rules.react
• nimbusCleanPlugin.rules.reactHooks
• nimbusCleanPlugin.rules.reactRefresh
• nimbusCleanPlugin.rules.promise
• nimbusCleanPlugin.rules.unicorn
• nimbusCleanPlugin.rules.perfectionist
• nimbusCleanPlugin.rules.typescriptRules

eslint.config.js from javascript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";

const config = [
    ...({
      ...nimbusCleanPlugin.configs.flat.common,
      rules: {
        ... nimbusCleanPlugin.rules.common,
        // Your rules
      }
    }),
    ...nimbusCleanPlugin.configs.flat.prettier,
    // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{js,jsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
      parserOptions: {
        ecmaFeatures: { jsx: true },
        ecmaVersion: "latest",
        sourceType: "module",
      },
    },
  },
];

export default config;

eslint.config.js from typescript project

import nimbusCleanPlugin from "eslint-plugin-nimbus-clean";
import globals from "globals";
import tsLint from "typescript-eslint";

export default tsLint.config(
  ...({
    ...nimbusCleanPlugin.configs.flat.common,
    rules: {
      ... nimbusCleanPlugin.rules.common,
      // Your rules
    }
  }),
  // OR
  {
    rules: {
      ...nimbusClean.rules.flat.typescript,
    },
  },
  // Other configs

  { ignores: ["dist"] },
  {
    files: ["**/*.{ts,tsx}"],
    languageOptions: {
      ecmaVersion: 2020,
      globals: globals.browser,
    },
  },
  {
    settings: {
      "import/resolver": {
        node: true,
        typescript: true,
      },
    },
  },
);

Prettier settings (optional)

If you don't have a .prettierrc config, please add it (for example):

{
   "singleQuote": true,
   "printWidth": 150,
   "useTabs": false,
   "tabWidth": 2,
   "trailingComma": "all",
   "semi": false
 }

License

This code is licensed under the MIT License.

Contributions

Before making any contributions, refer to here.

Show your support

Star (⭐️) this repository if it helped you!

Contributors

Thanks go to these wonderful people: