eslint-plugin-no-barrel-files

ESLint plugin to disallow barrel files.

Why?

Barrel files can slow down your build/tests, can cause circular dependencies, and makes tree shaking more difficult.

• https://github.com/jestjs/jest/issues/11234
• https://github.com/vercel/next.js/issues/12557
• https://dev.to/tassiofront/barrel-files-and-why-you-should-stop-using-them-now-bc4
• https://flaming.codes/posts/barrel-files-in-javascript

Rules

• no-barrel-files

1// fail
2export * from "./foo";
3
4import Foo from "./foo";
5export default Foo;
6
7import Foo from "./foo";
8export { Foo };
9
10export { Moo } from './Moo';
11export { default as Moo } from './Moo';
12
13// pass
14const Foo = 'baz';
15function Bar() {}
16class Baz {}
17
18export default Foo;
19export { Bar, Baz }
20
21import { Moo } from './Moo';
22export const Baz = Moo;

Usage

Install

1npm install eslint-plugin-no-barrel-files --save-dev

ESLint config

This plugin supports both flat config and legacy config.

Flat config (ESLint 9+)

1import noBarrelFiles from "eslint-plugin-no-barrel-files";
2
3export default [
4  noBarrelFiles.flat,
5];

Legacy config (ESLint <9)

1module.exports = {
2    plugins: ['no-barrel-files'],
3    rules: {
4        'no-barrel-files/no-barrel-files': 'error'
5    }
6}

Contributing

If you need any additional features or you find a bug, feel free to submit a pull request or submit an issue.