barrelgun

Generate your barrel files like a cowboy 🤠

Flexible NodeJS generator for barrel files (index.js) and more!

Usage

Create a config file barrelgun.config.js

1/** @type {Array<import("barrelgun").BarrelgunConfigBarrel>} */
2const barrels = [
3		{
4			path: "src/components/index.ts",
5			files: "*.component.{ts,tsx}",
6		},
7		{
8			path: "test/tests.spec.js",
9			files: "**/*.spec.js",
10			lineTemplate: (file) => `export {${file.replace(/[/.]/, '_')} from '${file}';`,
11			fileTemplate: (files, lineTemplate: LineTemplate) =>
12				`// Do not touch of you will be fired!			
13${files.reverse().map(file => lineTemplate(file))}
14// You have been warned!`,
15		},
16	];
17
18module.exports = {barrels};

and run barrelgun

1npx barrelgun shoot -c barrelgun.config.js

The following structure will be created

.
├── barrelgun.config.js
├── src
│   └── components
│       ├── button.component.tsx
│       ├── dialog.component.ts
│       └── index.js  <- this file is created
└── test
    ├── ignore.js
    ├── all.spec.js
    ├── components
    │   └── button.spec.js
    └── tests.spec.js  <- this file is created

src/components/index.js now contains

1// Generated by barrelgun. DO NOT EDIT
2
3export * from './button.component.tsx';
4export * from './dialog.component.ts';

src/components/index.js content is

1// Do not touch of you will be fired!			
2export {components_button_spec_js} from './components/button.spec.js';
3export {all_spec_js} from './all.spec.js';
4// You have been warned!

Features

• Import files recursively with globs
• Create all barrels at once with globs
• Custom templates
• Sort lines
• Ignore empty files

Related projects

Inspired by

• https://github.com/jmeyers91/barro
• https://github.com/imjuni/ctix
• https://github.com/bencoveney/barrelsby