generate-module-index

A simple CLI tool to auto-generate or update an index.js file that re-exports default exports from all modules in a specified directory.

✨ Features

• Automatically scans a target directory for .js or .ts files.
• Generates an index.js file that exports default modules using the filename as the alias.
• Skips index.js or files starting with index.
• Works well in any component or module folder for easy imports.

📦 Installation

You can run it directly using npx (no need to install globally):

npx generate-module-index <target-directory>

Or install locally:

npm install generate-module-index -D

and add package script:

"scripts": {
  "generate-index": "generate-module-index ./src/components"
}

Usage

Command

npx generate-module-index <target-directory>

example

src/components/
├── Button.js
├── Card.js
├── PageTitle.js

Running command:

npx generate-module-index ./src/components

Will generate:

// src/components/index.js
export { default as Button } from "./Button";
export { default as Card } from "./Card";
export { default as PageTitle } from "./PageTitle";