petrzjunior / barrelgun

Node.js barrel generator

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

/** @type {Array<import("barrelgun").BarrelgunConfigBarrel>} */
const barrels = [
		{
			path: "src/components/index.ts",
			files: "*.component.{ts,tsx}",
		},
		{
			path: "test/tests.spec.js",
			files: "**/*.spec.js",
			lineTemplate: (file) => `export {${file.replace(/[/.]/, '_')} from '${file}';`,
			fileTemplate: (files, lineTemplate: LineTemplate) =>
				`// Do not touch of you will be fired!			
${files.reverse().map(file => lineTemplate(file))}
// You have been warned!`,
		},
	];

module.exports = {barrels};

and run barrelgun

npx 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

// Generated by barrelgun. DO NOT EDIT

export * from './button.component.tsx';
export * from './dialog.component.ts';

src/components/index.js content is

// Do not touch of you will be fired!			
export {components_button_spec_js} from './components/button.spec.js';
export {all_spec_js} from './all.spec.js';
// 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

barrelgun's Issues

Invalid config `-c` command option

Running shoot -c config.file.js passes { c: true } in options

.option('-c', '--config <path>') 

barrelgun/src/main.ts

Line 15 in cc1f55d

.option('-c', '--config <path>')

should be:

.option('-c, --config <path>') 

Absolute path import is not valid file URL path on Windows

Running barrelgun shoot on Windows throws the following error:

pnpm barrelgun shoot -c barrelgun.config.js

Reading config from D:\Web_Design\Work\nfctron-account\barrelgun.config.js
node:internal/errors:464
    ErrorCaptureStackTrace(err);
    ^

Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only file and data URLs are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'd:'
    at new NodeError (node:internal/errors:371:5)
    at defaultResolve (node:internal/modules/esm/resolve:1016:11)
    at ESMLoader.resolve (node:internal/modules/esm/loader:422:30)
    at ESMLoader.getModuleJob (node:internal/modules/esm/loader:222:40)
    at ESMLoader.import (node:internal/modules/esm/loader:276:22)
    at importModuleDynamically (node:internal/modules/esm/translators:111:35)
    at importModuleDynamicallyCallback (node:internal/process/esm_loader:35:14)
    at loadConfig (file:///D:/Web_Design/Work/nfctron-account/node_modules/.pnpm/[email protected]/node_modules/barrelgun/dist/main.mjs:79:19)
    at shoot (file:///D:/Web_Design/Work/nfctron-account/node_modules/.pnpm/[email protected]/node_modules/barrelgun/dist/main.mjs:84:24)
    at Command.<anonymous> (file:///D:/Web_Design/Work/nfctron-account/node_modules/.pnpm/[email protected]/node_modules/barrelgun/dist/main.mjs:90:122) {
  code: 'ERR_UNSUPPORTED_ESM_URL_SCHEME'
}
 ELIFECYCLE  Command failed with exit code 1.

The problematic code:

barrelgun/src/shoot.ts

Line 11 in d3a13e7

const promise = await import(absolutePath);

Probable solution:

 const promise = await import(pathToFileURL(absolutePath).toString());