@terminal-nerds/eslint-config
➡️ Extendable ESLint configuration, part of the terminal-nerds/configs project.
Prerequisites
ℹ️ 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
Basic usage
👣 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 @terminal-nerds/eslint-config
-
Create an ESLint configuration file -
.eslintrc.(c)js
. -
Extend this module package configuration.
const config = { extends: "@terminal-nerds", 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.
Used configurations & plugins
⚙️ This configuration module loads configurations and plugins options conditionally.
Configurations
Configurations | Version | Loading condition(s) |
---|---|---|
@unocss/eslint-config | ![@unocss/eslint-config version badge] |
unocss as dependency |
eslint-config-next |
next as dependency |
|
eslint-config-prettier |
prettier as dependency |
Plugins
Plugin | Version | Loading condition(s) |
---|---|---|
@docusaurus/eslint-plugin |
@docusaurus/core as dependency |
|
@emotion/eslint-plugin |
@emotion/css or @emotion/react as dependency |
|
@typescript-eslint/eslint-plugin |
typescript as dependency |
|
eslint-plugin-compat | - | |
eslint-plugin-diff |
ESLINT_PLUGIN_DIFF_ENABLE set to true in environment variables |
|
eslint-plugin-drizzle |
drizzle-orm as dependency |
|
eslint-plugin-es-x | - | |
eslint-plugin-import | - | |
eslint-plugin-jest-dom |
@testing-library/jest-dom as dependency |
|
eslint-plugin-jest-formatting |
jest or vitest as dependency |
|
eslint-plugin-jest |
jest or vitest as dependency |
|
eslint-plugin-jsdoc | - | |
eslint-plugin-jsx-a11y |
react or preact as dependency |
|
eslint-plugin-n | - | |
eslint-plugin-react-hooks |
react or preact as dependency |
|
eslint-plugin-react |
react or preact as dependency |
|
eslint-plugin-regexp | - | |
eslint-plugin-simple-import-sort | - | |
eslint-plugin-sonarjs | - | |
eslint-plugin-sql | - | |
eslint-plugin-storybook |
storybook as dependency |
|
eslint-plugin-svelte |
svelte as dependency |
|
eslint-plugin-tailwindcss |
tailwindcss as dependency |
|
eslint-plugin-testing-library |
@testing-library/jest-dom as dependency |
|
eslint-plugin-typescript |
typescript as dependency |
|
eslint-plugin-unicorn |
typescript as dependency |
Security
🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.
Contributing
🤝 Contributions of any kind are welcome!
Please refer to the monorepo (terminal-nerds/configs) project's CONTRIBUTING file for more information if you wish to get involved.
License
⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.