Generator for barrel files (export from index files) for JavaScript and TypeScript.
Features
- Creates index files with all named exports from a file.
- Recursively creates index files for folder contents.
Install globally for command line usage:
npm install -g barreler
or locally:
npm install --save-dev barreler
Run barreler with one or more files or directoreies:
barreler ./file.js ./file.js ./folderOptions:
--mode, -m Select mode values = ['all-level-index', 'multifile-index']
--include, -i Sets pattern for file inclusion. Comma separated list. default: *.[jt]s(x)?
--exclude, -e Sets pattern for file exclusion. Comma separated list. default: *(spec|test).[jt]s(x)?,*__tests__/*.[jt]s(x)?Import barrel method and provide array of files or directories to barrel.
import { barrel } from "barreler";
await barrel(files, options?);Options:
BarrelerOptions {
mode: BarrelerMode; // default: BarrelerMode.MultiFileIndex
include: string[]; // default: ["*.[jt]s(x)?"],
exclude: string[]; // default: ["*(spec|test).[jt]s(x)?", "*__tests__/*.[jt]s(x)?"]
}Generates index file on file level and exports file exports into this index.
Example:
|-- index.ts <-- generated (export from: company.ts, /farm and /store)
|-- company.ts
|-- /services
| |-- farm.service.ts
| |-- index.ts <-- generated
|-- /store
| |-- chicken.store.ts
| |-- pig.store.ts
| |-- index.ts <-- generated
Generates index file on lever where there is more than 1 file to export from.
This is default mode.
Example:
|-- index.ts <-- generated (export from: company.ts, farm.service.ts and /store)
|-- company.ts
|-- /services
| |-- farm.service.ts
|-- /store
| |-- chicken.store.ts
| |-- pig.store.ts
| |-- index.ts <-- generated
Structure:
|-- /services
| |-- farm.service.ts
// farm.service.ts
export function feedAnimals() {}
export function cleanFarm() {}Running barreler ./services/farm.service.ts would generate:
|-- /services
| |-- farm.service.ts
| |-- index.ts
// index.ts
export { feedAnimals, cleanFarm } from "./farm.service";This would enable us to import any farm.service function directly from /services.
Structure:
|-- /services
| |-- farm.service.ts
// farm.service.ts
export function feedAnimals() {}
export function cleanFarm() {}Running barreler ./services would generate:
|-- /services
| |-- farm.service.ts
| |-- index.ts
|-- index.ts
// ./services/index.ts
export { feedAnimals, cleanFarm } from "./farm.service";// ./index.ts
export * from "./services";Does not work on multiline or barrel exports.
const a;
const b;
const c;
export { a, b };
export c;Would only export c.