Barrelize: Automate Your JavaScript Imports Like a Pro

Nizami — Sun, 11 May 2025 20:59:56 +0000

Are you tired of manually maintaining index files in your JavaScript or TypeScript projects? Meet Barrelize - a powerful, modern tool that automatically generates and maintains barrel (index) files, making your codebase cleaner and more maintainable.

nizami / barrelize

A CLI tool for automatically generating index (barrel) files in TypeScript and JavaScript projects. Simplifies exports and maintains clean code organization.

Barrelize

🚀 A modern, lightweight and efficient tool for automatically generating index (barrel) files in your JavaScript and TypeScript projects.

Barrelize simplifies module exports by creating clean, centralized index.js or index.ts files, reducing boilerplate and improving project organization.

Features

Automatic Barrel Generation: Scans directories and creates index files with exports for all modules.
TypeScript Support: Seamlessly works with TypeScript projects, preserving type safety.
Customizable: Configure file patterns, ignore specific files, or customize export styles (named, default, or both).
Recursive: Optionally generate barrels for nested directories.
CLI & API: Use via command line for quick setups or integrate programmatically in your build scripts.
Smart Export Control: Fine-grained control over what gets exported and how
- Export specific members, namespaces, or use regex patterns
- Support for custom export names and transformations
- Support for asterisk (*) exports
- Flexible export path manipulation
Flexible Path Handling: Replace patterns in…

View on GitHub

What Are Barrel Files and Why Should You Care? 🤔

Barrel files (commonly named index.ts or index.js) serve as central export points for a directory, allowing you to group and re-export multiple modules. Instead of importing from multiple files:

import {UserService} from './services/user-service';
import {AuthService} from './services/auth-service';
import {ConfigService} from './services/config-service';

You can have a clean, single import:

import {UserService, AuthService, ConfigService} from './services';

While barrel files are great for code organization, maintaining them manually can be tedious and error-prone. That's where Barrelize comes in! 🚀

Why Should You Try Barrelize? ⭐️

Automatic Barrel Generation: Scans directories and creates index files with exports for all modules
TypeScript Support: Seamlessly works with TypeScript projects, preserving type safety
Customizable: Configure file patterns, ignore specific files, or customize export styles
Smart Export Control: Fine-grained control over what gets exported and how:
- Export specific members, namespaces, or use regex patterns
- Support for custom export names and transformations
- Support for asterisk (*) exports
- Flexible export path manipulation
Flexible Path Handling: Replace patterns in export paths using string or regular expressions
Customizable Formatting: Control bracket spacing, quotes, semicolons, and newlines

Getting Started in 30 Seconds ⚡️

Install Barrelize:

npm install --save-dev barrelize

Initialize configuration (optional):

npx barrelize init

Generate your barrel files:

npx barrelize

That's it! Barrelize will scan your project and create organized barrel files automatically. 🎉

Advanced Configuration 🛠

Create a .barrelize file in your project root to customize the behavior:

{
  "$schema": "node_modules/barrelize/schema.json",
  // Global formatting settings
  "bracketSpacing": true,
  "singleQuote": true,
  "semi": true,
  "insertFinalNewline": true,

  // Configure multiple barrels
  "barrels": [
    {
      // Root directory to start from
      "root": "src",
      // Name of the index file
      "name": "index.ts",
      // Files to include in the barrel
      "include": ["**/*.ts"],
      // Files to exclude from the barrel
      "exclude": ["**/*.test.ts"],
      // Optional ordering of exports
      "order": ["types", "constants", "utils"],
      // String/regex patterns to find and replace in export paths
      "replace": {
        "/\\.ts$/": "" // Remove .ts extension from paths
      },
      // Export configuration for different file patterns
      "exports": {
        "**/*.ts": [
          "* as lib", // Export all as namespace
          "/(.+)Config$/ as $1LibConfig", // Rename exports matching pattern
          "util" // Export specific member
        ]
      }
    }
  ]
}

Real-World Example 🌟

Before:

src/
  ├── types.ts
  ├── constants.ts
  ├── utils.ts
  └── components/
      ├── Button.tsx
      └── Input.tsx

After running barrelize:

src/
  ├── types.ts
  ├── constants.ts
  ├── utils.ts
  ├── index.ts           # New!
  └── components/
      ├── Button.tsx
      └── Input.tsx

Generated src/index.ts:

export * from './types';
export * from './constants';
export * from './utils';
export * from './components/Button.tsx';
export * from './components/Input.tsx';

Benefits for Your Project 💪

Save Time: Eliminate manual creation and maintenance of barrel files
Cleaner Imports: Simplify import statements with a single entry point for each directory
Scalable: Ideal for large projects with complex folder structures
Type Safety: Full TypeScript support ensures your types are preserved
Consistency: Automated generation ensures uniform export patterns
Flexibility: Customize everything from file patterns to export styles

Join the Community! 🤝

Barrelize is lightweight, open-source, and ready to improve your development workflow. Star us on GitHub and contribute to make it even better!

Discussion 💭

How do you currently manage your exports in large TypeScript/JavaScript projects?
What features would you like to see in Barrelize?
Have you tried other barrel file generators? How does Barrelize compare?

Let's discuss in the comments below! 👇

nizami / barrelize

A CLI tool for automatically generating index (barrel) files in TypeScript and JavaScript projects. Simplifies exports and maintains clean code organization.

Barrelize

🚀 A modern, lightweight and efficient tool for automatically generating index (barrel) files in your JavaScript and TypeScript projects.

Barrelize simplifies module exports by creating clean, centralized index.js or index.ts files, reducing boilerplate and improving project organization.

Features

Automatic Barrel Generation: Scans directories and creates index files with exports for all modules.
TypeScript Support: Seamlessly works with TypeScript projects, preserving type safety.
Customizable: Configure file patterns, ignore specific files, or customize export styles (named, default, or both).
Recursive: Optionally generate barrels for nested directories.
CLI & API: Use via command line for quick setups or integrate programmatically in your build scripts.
Smart Export Control: Fine-grained control over what gets exported and how
- Export specific members, namespaces, or use regex patterns
- Support for custom export names and transformations
- Support for asterisk (*) exports
- Flexible export path manipulation
Flexible Path Handling: Replace patterns in…

View on GitHub

DEV Community: Nizami

Barrelize: Automate Your JavaScript Imports Like a Pro

nizami / barrelize

A CLI tool for automatically generating index (barrel) files in TypeScript and JavaScript projects. Simplifies exports and maintains clean code organization.

Barrelize

Features

What Are Barrel Files and Why Should You Care? 🤔

Why Should You Try Barrelize? ⭐️

Getting Started in 30 Seconds ⚡️

Advanced Configuration 🛠

Real-World Example 🌟

Benefits for Your Project 💪

Join the Community! 🤝

Discussion 💭

nizami / barrelize

A CLI tool for automatically generating index (barrel) files in TypeScript and JavaScript projects. Simplifies exports and maintains clean code organization.

Barrelize

Features