<p> <a href="https://www.npmjs.com/package/eslint-define-config" target="_blank"> <img alt="NPM package" src="https://img.shields.io/npm/v/eslint-define-config.svg"> </a> <a href="https://www.npmjs.com/package/eslint-define-config" target="_blan
MIT License
Provide a defineConfig
function for .eslintrc.js
, and a defineFlatConfig
function for eslint.config.js
files.
# add eslint and eslint-define-config to project’s dev dependencies
npm add --save-dev eslint eslint-define-config
# or
yarn add --dev eslint eslint-define-config
# or
pnpm add --save-dev eslint eslint-define-config
By default only eslint
's rules are supported. To activate auto-suggestions for Rules of specific plugins, you need to install the respective types for that plugin.
Plugins can either support their own types, or they could be supported by the community in the @eslint-types
repository.
A list of community supported plugins can be found here.
.eslintrc.js
// @ts-check
const { defineConfig } = require('eslint-define-config');
/// <reference types="@eslint-types/typescript-eslint" />
module.exports = defineConfig({
root: true,
rules: {
// rules...
},
});
eslint.config.js
// @ts-check
const { defineFlatConfig } = require('eslint-define-config');
const js = require('@eslint/js');
const customConfig = require('./custom-config.js');
/// <reference types="@eslint-types/typescript-eslint" />
module.exports = defineFlatConfig([
js.configs.recommended,
customConfig,
{
plugins: {
// plugins...
},
rules: {
// rules...
},
},
]);
Improve your eslint configuration experience with:
// @ts-check
at the first line in your .eslintrc.js
or eslint.config.js
)Click on the thumbnail to play the video
⚠️ This feature is very new and requires the support of the respective plugin owners
Add a declare module
to your plugin package like this:
declare module 'eslint-define-config' {
export interface CustomRuleOptions {
/**
* Require consistently using either `T[]` or `Array<T>` for arrays.
*
* @see [array-type](https://typescript-eslint.io/rules/array-type)
*/
'@typescript-eslint/array-type': [
{
default?: 'array' | 'generic' | 'array-simple';
readonly?: 'array' | 'generic' | 'array-simple';
},
];
// ... more Rules
}
}
There are other interfaces that can be extended.
CustomExtends
CustomParserOptions
CustomParsers
CustomPlugins
CustomSettings