➡️ Extendable ESLint configuration, part of the adchitects/configs project.
ℹ️ This configuration package require these tools to use locally on your device(s):
- Latest Node.js LTS (Long-Term Support) version
- One of Node.js package managers:
- Latest ESLint version
👣 Follow the steps below:
-
Install it with the Node.js package manager of your choice (in our case, we use pnpm).
pnpm install --save-dev eslint @adchitects/eslint-config
-
Create an ESLint configuration file -
.eslintrc.(c)js
. -
Extend this module package configuration.
const config = { extends: "@adchitects", env: { // Specify the environment(s) // https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments browser: true, node: true, }, }; module.exports = config;
📖 For the ESLint CLI usage, please refer to its documentation.
⚙️ This configuration module loads configurations and plugins options conditionally.
Configurations | Version | Loading condition(s) |
---|---|---|
eslint-config-next | next as dependency |
|
eslint-config-prettier | prettier as dependency |
Plugin | Version | Loading condition(s) |
---|---|---|
@typescript-eslint/eslint-plugin | typescript as dependency |
|
eslint-plugin-compat | - | |
eslint-plugin-diff | Set one of environment variables: CI or CONTINUOUS_INTEGRATION to true |
|
@emotion/eslint-plugin | @emotion/css or @emotion/react as dependency |
|
eslint-plugin-import | - | |
eslint-plugin-jest | jest or vitest as dependency |
|
eslint-plugin-jest-dom | @testing-library/jest-dom as dependency |
|
eslint-plugin-jest-formatting | jest or vitest as dependency |
|
eslint-plugin-json-schema-validator | - | |
eslint-plugin-jsonc | - | |
eslint-plugin-jsx-a11y | react or preact as dependency |
|
eslint-plugin-node | - | |
eslint-plugin-react | react or preact as dependency |
|
eslint-plugin-react-hooks | react or preact as dependency |
|
eslint-plugin-regexp | - | |
eslint-plugin-sonarjs | - | |
eslint-plugin-sql | - | |
eslint-plugin-storybook | sb or storybook or @storybook/react as dependency |
|
eslint-plugin-testing-library | @testing-library/jest-dom as dependency |
|
eslint-plugin-unicorn | - | |
eslint-plugin-yml | - |
🔐 For more information, please refer to the Security section at the root of the adchitects/configs monorepo.
🤝 Contributions of any kind are welcome!
Please refer to the monorepo (adchitects/configs) project's CONTRIBUTING file for more information if you wish to get involved.
⚖️ For more information, please refer to the License section at the root of the adchitects/configs monorepo.