\n\n## About\n\n**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**.\n\nThis configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.\n\nMore information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).\n\n## Getting Started\n\n### Prerequisites\n\n[Node.js](https://nodejs.org/) >= 20.11.0\n\n### Installation\n\n```sh\nnpm install --save-dev \\\n eslint@^9.22.0 \\\n eslint-plugin-promise@^7.2.1 \\\n eslint-plugin-unicorn@^63.0.0 \\\n eslint-plugin-import-x@^4.6.1 \\\n globals@^17.0.0 \\\n typescript@^5.9.3 \\\n typescript-eslint@^8.32.0 \\\n eslint-config-conventions@latest\n```\n\nDependencies are:\n\n- [ESLint](https://github.com/eslint/eslint)\n- [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)\n - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)\n - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)\n - [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x)\n- [globals](https://github.com/sindresorhus/globals)\n- [TypeScript](https://github.com/Microsoft/TypeScript)\n- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint): tooling which enables ESLint to support TypeScript.\n- This package: `eslint-config-conventions`\n\n### Configuration\n\n#### `eslint.config.js`\n\n```js\nimport { defineConfig } from \"eslint/config\"\nimport configConventions from \"eslint-config-conventions\"\n\nexport default defineConfig(...configConventions, {\n files: [\"**/*.ts\", \"**/*.tsx\"],\n languageOptions: {\n parser: typescriptESLint.parser,\n parserOptions: {\n projectService: true,\n tsconfigRootDir: import.meta.dirname,\n },\n },\n})\n```\n\n#### Configuration with [Prettier](https://prettier.io/) (recommended)\n\n```sh\nnpm install --save-dev prettier\n\n# Create an empty config file to let editors and other tools know you are using Prettier\n# You can personalize it with your own rules\necho \"{}\" > .prettierrc.json\n```\n\nThat's all! No need to update the `eslint.config.js` configuration.\n\nWe discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration.\n\n#### `package.json`\n\n```json\n{\n \"scripts\": {\n \"lint:eslint\": \"eslint . --max-warnings 0\",\n \"lint:prettier\": \"prettier . --check\"\n }\n}\n```\n\n### Usage\n\n```sh\nnode --run lint:eslint\n# or to apply automatic fixes to code\nnode --run lint:eslint -- --fix\n\n# Validate code formatting in all supported languages by Prettier\nnode --run lint:prettier\n```\n\n### `.oxlintrc.json` (if using [oxlint](https://oxc.rs/))\n\n```json\n{\n \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n \"extends\": [\"node_modules/eslint-config-conventions/.oxlintrc.json\"],\n \"options\": {\n \"typeAware\": true,\n \"typeCheck\": true,\n \"denyWarnings\": true,\n \"reportUnusedDisableDirectives\": \"error\"\n }\n}\n```\n\n## Contributing\n\nAnyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.\n\nThe steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n## License\n\n[MIT](./LICENSE)\n","readmeFilename":"README.md"}
![\"CONTRIBUTING\"](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\"){kind=icon}
\n ![\"Licence](\"https://img.shields.io/badge/licence-MIT-blue.svg\"){kind=icon}
\n ![\"Contributor](\"https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\"){kind=icon}
\n ![\"lint](\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop\"){kind=icon}
\n ![\"test](\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop\"){kind=icon}
\n ![\"Conventional](\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\"){kind=icon}
\n ![\"semantic-release\"](\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"){kind=icon}
\n ![\"npm](\"https://img.shields.io/npm/v/eslint-config-conventions.svg\")
\n