eslint-flat-config-utils

Utils for managing and manipulating ESLint flat config arrays

Documentation

Install

1npm i eslint-flat-config-utils

Utils

Most of the descriptions are written in JSDoc, you can find more details in the documentation via JSR.

Here listing a few highlighted ones:

concat

Concatenate multiple ESLint flat configs into one, resolve the promises, and flatten the array.

1// eslint.config.mjs
2import { concat } from 'eslint-flat-config-utils'
3
4export default concat(
5  {
6    plugins: {},
7    rules: {},
8  },
9  // It can also takes a array of configs:
10  [
11    {
12      plugins: {},
13      rules: {},
14    }
15    // ...
16  ],
17  // Or promises:
18  Promise.resolve({
19    files: ['*.ts'],
20    rules: {},
21  })
22  // ...
23)

composer

Create a chainable composer that makes manipulating ESLint flat config easier.

It extends Promise, so that you can directly await or export it to eslint.config.mjs

1// eslint.config.mjs
2import { composer } from 'eslint-flat-config-utils'
3
4export default composer(
5  {
6    plugins: {},
7    rules: {},
8  }
9  // ...some configs, accepts same arguments as `concat`
10)
11  .append(
12    // appends more configs at the end, accepts same arguments as `concat`
13  )
14  .prepend(
15    // prepends more configs at the beginning, accepts same arguments as `concat`
16  )
17  .insertAfter(
18    'config-name', // specify the name of the target config, or index
19    // insert more configs after the target, accepts same arguments as `concat`
20  )
21  .renamePlugins({
22    // rename plugins
23    'old-name': 'new-name',
24    // for example, rename `n` from `eslint-plugin-n` to more a explicit prefix `node`
25    'n': 'node'
26    // applies to all plugins and rules in the configs
27  })
28  .override(
29    'config-name', // specify the name of the target config, or index
30    {
31      // merge with the target config
32      rules: {
33        'no-console': 'off'
34      },
35    }
36  )
37
38// And you can directly return the composer object to `eslint.config.mjs`

extend

Extend another flat config from a different root, and rewrite the glob paths accordingly:

1import { extend } from 'eslint-flat-config-utils'
2
3export default [
4  ...await extend(
5    import('./sub-package/eslint.config.mjs'),
6    './sub-package/'
7  )
8]

Sponsors

License

MIT License © 2023-PRESENT Anthony Fu