Share Configurations

To share your ESLint configuration, create a shareable config. You can publish your shareable config on npm so that others can download and use it in their ESLint projects.

This page explains how to create and publish a shareable config.

Creating a Shareable Config

Shareable configs are simply npm packages that export a configuration object or array. To start, create a Node.js module like you normally would.

While you can name the package in any way that you’d like, we recommend using one of the following conventions to make your package easier to identify:

Begin with eslint-config-, such as eslint-config-myconfig.
For an npm scoped module, name or prefix the module with @scope/eslint-config, such as @scope/eslint-config or @scope/eslint-config-myconfig.

In your module, export the shareable config from the module’s main entry point file. The default main entry point is index.js. For example:

// index.js
export default [
    {
        languageOptions: {
            globals: {
                MyGlobal: true
            }
        },

        rules: {
            semi: [2, "always"]
        }

    }
];
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Because the index.js file is just JavaScript, you can read these settings from a file or generate them dynamically.

Publishing a Shareable Config

Once your shareable config is ready, you can publish it to npm to share it with others. We recommend using the eslint and eslintconfig keywords in the package.json file so others can easily find your module.

You should declare your dependency on ESLint in the package.json using the peerDependencies field. The recommended way to declare a dependency for future-proof compatibility is with the “>=” range syntax, using the lowest required ESLint version. For example:

{
    "peerDependencies": {
        "eslint": ">= 9"
    }
}
1
2
3
4
5

If your shareable config depends on a plugin or a custom parser, you should specify these packages as dependencies in your package.json.

Using a Shareable Config

To use a shareable config, import the package inside of an eslint.config.js file and add it into the exported array, like this:

// eslint.config.js
import myconfig from "eslint-config-myconfig";

export default [
    ...myconfig
];
1
2
3
4
5
6

Overriding Settings from Shareable Configs

You can override settings from the shareable config by adding them directly into your eslint.config.js file after importing the shareable config. For example:

// eslint.config.js
import myconfig from "eslint-config-myconfig";

export default [
    ...myconfig,

    // anything from here will override myconfig
    {
        rules: {
            "no-unused-vars": "warn"
        }
    }
];
1
2
3
4
5
6
7
8
9
10
11
12
13

Because shareable configs are just npm packages, you can export as many configs as you’d like from the same package. In addition to specifying a default config using the main entry in your package.json, you can specify additional shareable configs by adding a new file to your npm package and then referencing it from your eslint.config.js file.

As an example, you can create a file called my-special-config.js in the root of your npm package and export a config, such as:

// my-special-config.js
export default {
    rules: {
        quotes: [2, "double"]
    }
};
1
2
3
4
5
6

Then, assuming you’re using the package name eslint-config-myconfig, you can access the additional config via:

// eslint.config.js
import myconfig from "eslint-config-myconfig";
import mySpecialConfig from "eslint-config-myconfig/my-special-config.js";

export default [
    ...myconfig,
    mySpecialConfig,

    // anything from here will override myconfig and mySpecialConfig
    {
        rules: {
            "no-unused-vars": "warn"
        }
    }
];
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15