{"id":14978246,"url":"https://github.com/dipiash/eslint-plugin-nimbus-clean","last_synced_at":"2025-10-28T08:32:03.503Z","repository":{"id":192819804,"uuid":"686649007","full_name":"dipiash/eslint-plugin-nimbus-clean","owner":"dipiash","description":"A comprehensive linting solution that sweeps your code clean. Fly through your codebase with ease and precision!","archived":false,"fork":false,"pushed_at":"2024-03-12T18:54:49.000Z","size":252,"stargazers_count":7,"open_issues_count":7,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-24T09:53:39.306Z","etag":null,"topics":["eslint","eslint-config","eslint-plugin","eslint-rules","eslintconfig","eslintrc","hacktoberfest","import","javascript","nodejs","perfectionist","prettier","react","reactjs","sonarjs","typescript","unicorn"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/eslint-plugin-nimbus-clean","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dipiash.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-03T13:52:25.000Z","updated_at":"2024-05-15T21:22:23.127Z","dependencies_parsed_at":null,"dependency_job_id":"2539bd21-3e06-4366-8335-dad25a7f3cf7","html_url":"https://github.com/dipiash/eslint-plugin-nimbus-clean","commit_stats":null,"previous_names":["dipiash/eslint-plugin-nimbus-clean"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipiash%2Feslint-plugin-nimbus-clean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipiash%2Feslint-plugin-nimbus-clean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipiash%2Feslint-plugin-nimbus-clean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipiash%2Feslint-plugin-nimbus-clean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dipiash","download_url":"https://codeload.github.com/dipiash/eslint-plugin-nimbus-clean/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859904,"owners_count":16556031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eslint","eslint-config","eslint-plugin","eslint-rules","eslintconfig","eslintrc","hacktoberfest","import","javascript","nodejs","perfectionist","prettier","react","reactjs","sonarjs","typescript","unicorn"],"created_at":"2024-09-24T13:57:08.048Z","updated_at":"2025-10-28T08:32:03.478Z","avatar_url":"https://github.com/dipiash.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub CI](https://github.com/dipiash/eslint-plugin-nimbus-clean/actions/workflows/ci.yml/badge.svg)\n[![npm version](https://badge.fury.io/js/eslint-plugin-nimbus-clean.svg?v=0.2.4)](https://badge.fury.io/js/eslint-plugin-nimbus-clean)\n[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fdipiash%2Feslint-plugin-nimbus-clean\u0026count_bg=%2379C83D\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=hits\u0026edge_flat=false)](https://hits.seeyoufarm.com)\n\n# eslint-plugin-nimbus-clean\n\nA 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.\n\n## Table of Contents\n\n\u003c!-- toc --\u003e\n\n- [Installation](#installation)\n- [Usage](#usage)\n  * [Config](#config)\n    + [Incrementally improvements](#incrementally-improvements)\n    + [Separate rules](#separate-rules)\n  * [Prettier settings (optional)](#prettier-settings-optional)\n- [License](#license)\n- [Contributions](#contributions)\n- [Show your support](#show-your-support)\n- [Contributors](#contributors)\n\n\u003c!-- tocstop --\u003e\n\n### Installation\n\n**Requires ESLint `\u003e=9.20.0`, [flat config](https://eslint.org/docs/latest/use/configure/configuration-files), and [ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#how-can-i-make-my-typescript-project-output-esm).**\n\nHere you can find instructions how to install it via: `npm`, `yarn`, `pnpm`.\n\nYou'll first need to install [ESLint](https://eslint.org/) and TypeScript:\n\n```sh\nnpm i eslint --save-dev\nnpm i typescript\n\n# Or run this to use yarn\nyarn add eslint --dev\nyarn add typescript\n\n# Or run this to use pnpm\npnpm add eslint --save-dev\npnpm add typescript\n```\n\nNext, install `eslint-plugin-nimbus-clean`:\n\n```sh\nnpm install eslint-plugin-nimbus-clean --save-dev\n\n# Or run this to use yarn\nyarn add eslint-plugin-nimbus-clean --dev\n\n# Or run this to use pnpm\npnpm add eslint-plugin-nimbus-clean --save-dev\n```\n\nNext, install all peerDependencies for this plugin:\n\n```sh\nnpx install-peerdeps eslint-plugin-nimbus-clean\n\n# Or run this to use yarn\nnpx install-peerdeps eslint-plugin-nimbus-clean --yarn\n\n# Or run this to use pnpm\nnpx install-peerdeps eslint-plugin-nimbus-clean --pnpm\n```\n\n### Usage\n\n#### Config\n\nSuitable for ESLint \u003e= 9\n\n`eslint.config.mjs` from **javascript** project\n\n```javascript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\n\nconst config = [\n  ...nimbusCleanPlugin.configs.recommended,\n  // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{js,jsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n      parserOptions: {\n        ecmaFeatures: { jsx: true },\n        ecmaVersion: \"latest\",\n        sourceType: \"module\",\n      },\n    },\n  },\n];\n\nexport default config;\n```\n\n`eslint.config.mjs` from **typescript** project\n\n```typescript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\nimport tsLint from \"typescript-eslint\";\n\nexport default tsLint.config(\n  ...nimbusCleanPlugin.configs.recommended,\n  // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{ts,tsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n    },\n  },\n  {\n    settings: {\n      \"import/resolver\": {\n        node: true,\n        typescript: true,\n      },\n    },\n  },\n);\n```\n\n##### Incrementally improvements\n\nIf you have existing project big/old/etc. you can apply `nimbus-clean` config setting incrementally:\n- `nimbusCleanPlugin.configs.common`\n- `nimbusCleanPlugin.configs.prettier`\n- `nimbusCleanPlugin.configs.import`\n- `nimbusCleanPlugin.configs.simpleImportSort`\n- `nimbusCleanPlugin.configs.react`\n- `nimbusCleanPlugin.configs.reactHooks`\n- `nimbusCleanPlugin.configs.jsxA11y`\n- `nimbusCleanPlugin.configs.promise`\n- `nimbusCleanPlugin.configs.unicorn`\n- `nimbusCleanPlugin.configs.sonarjs`\n- `nimbusCleanPlugin.configs.typescript`\n- `nimbusCleanPlugin.configs.perfectionist`\n- `nimbusCleanPlugin.configs.testingLibrary`\n\n`eslint.config.mjs` from **javascript** project\n\n```javascript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\n\nconst config = [\n    ...nimbusCleanPlugin.configs.common,\n    ...nimbusCleanPlugin.configs.prettier,\n  // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{js,jsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n      parserOptions: {\n        ecmaFeatures: { jsx: true },\n        ecmaVersion: \"latest\",\n        sourceType: \"module\",\n      },\n    },\n  },\n];\n\nexport default config;\n```\n\n`eslint.config.mjs` from **typescript** project\n\n```typescript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\nimport tsLint from \"typescript-eslint\";\n\nexport default tsLint.config(\n  ...nimbusCleanPlugin.configs.common,\n  ...nimbusCleanPlugin.configs.prettier,\n  // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{ts,tsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n    },\n  },\n  {\n    settings: {\n      \"import/resolver\": {\n        node: true,\n        typescript: true,\n      },\n    },\n  },\n);\n```\n\n##### Separate rules\n\nFor flexible customization you can also use separate rules in your configs:\n- `nimbusCleanPlugin.rules.recommended`\n- `nimbusCleanPlugin.rules.common`\n- `nimbusCleanPlugin.rules.import`\n- `nimbusCleanPlugin.rules.sonarjs`\n- `nimbusCleanPlugin.rules.prettier`\n- `nimbusCleanPlugin.rules.react`\n- `nimbusCleanPlugin.rules.reactHooks`\n- `nimbusCleanPlugin.rules.reactRefresh`\n- `nimbusCleanPlugin.rules.promise`\n- `nimbusCleanPlugin.rules.unicorn`\n- `nimbusCleanPlugin.rules.perfectionist`\n- `nimbusCleanPlugin.rules.typescriptRules`\n\n`eslint.config.mjs` from **javascript** project\n\n```javascript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\n\nconst config = [\n    ...({\n      ...nimbusCleanPlugin.configs.common,\n      rules: {\n        ... nimbusCleanPlugin.rules.common,\n        // Your rules\n      }\n    }),\n    ...nimbusCleanPlugin.configs.prettier,\n    // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{js,jsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n      parserOptions: {\n        ecmaFeatures: { jsx: true },\n        ecmaVersion: \"latest\",\n        sourceType: \"module\",\n      },\n    },\n  },\n];\n\nexport default config;\n```\n\n`eslint.config.mjs` from **typescript** project\n\n```typescript\nimport nimbusCleanPlugin from \"eslint-plugin-nimbus-clean\";\nimport globals from \"globals\";\nimport tsLint from \"typescript-eslint\";\n\nexport default tsLint.config(\n  ...({\n    ...nimbusCleanPlugin.configs.common,\n    rules: {\n      ... nimbusCleanPlugin.rules.common,\n      // Your rules\n    }\n  }),\n  // OR\n  {\n    rules: {\n      ...nimbusClean.rules.typescript,\n    },\n  },\n  // Other configs\n\n  { ignores: [\"dist\"] },\n  {\n    files: [\"**/*.{ts,tsx}\"],\n    languageOptions: {\n      ecmaVersion: 2020,\n      globals: globals.browser,\n    },\n  },\n  {\n    settings: {\n      \"import/resolver\": {\n        node: true,\n        typescript: true,\n      },\n    },\n  },\n);\n```\n\n#### Prettier settings (optional)\n\nIf you don't have a `.prettierrc` config, please add it (for example):\n   ```prettier\n   {\n      \"singleQuote\": true,\n      \"printWidth\": 150,\n      \"useTabs\": false,\n      \"tabWidth\": 2,\n      \"trailingComma\": \"all\",\n      \"semi\": false\n    }\n   ```\n\n### License\n\nThis code is licensed under the [MIT](/LICENSE) License.\n\n### Contributions\n\nBefore making any contributions, refer to [here](/CONTRIBUTING.md).\n\n### Show your support\nStar (⭐️) this repository if it helped you!\n\n### Contributors\n\nThanks go to these wonderful people:\n\n\u003ca href=\"https://github.com/dipiash/eslint-plugin-nimbus-clean/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=dipiash/eslint-plugin-nimbus-clean\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipiash%2Feslint-plugin-nimbus-clean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdipiash%2Feslint-plugin-nimbus-clean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipiash%2Feslint-plugin-nimbus-clean/lists"}