Barrelsby

https://www.npmjs.com/package/barrelsby
Admin
Barrelsby is an automated tool that generates TypeScript barrel files to simplify imports and...
Tokens:3,178
Snippets:88
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation and Execution

Source: https://www.npmjs.com/package/barrelsby

Commands to install the package and configure it within a package.json script.

```bash
npm install --save-dev barrelsby
```

```json
{
  "scripts": {
    "generate-barrels": "barrelsby --delete"
  }
}
```

```bash
npm run generate-barrels
```

--------------------------------

### Install barrelsby

Source: https://www.npmjs.com/package/barrelsby?activeTab=dependents

Command to install the package via npm.

```bash
npm i barrelsby
```

--------------------------------

### Directory Configuration Variants

Source: https://www.npmjs.com/package/barrelsby

Configuration examples showing how to define root directories as a string or an array.

```json
{
  "directory": "./src"
}
```

```json
{
  "directory": ["./src"]
}
```

--------------------------------

### Export Default Configuration

Source: https://www.npmjs.com/package/barrelsby

Examples of how default exports are handled in flat mode.

```typescript
export * from "./barrel";
export { default as barrel } from "./barrel";
```

```typescript
export * from "./example/of/the/path";
export { default as exampleOfThePath } from "./example/of/the/path";
```

--------------------------------

### Directory Configuration Example (Array)

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Configure Barrelsby to create barrels in multiple directories by providing an array of paths. This is an alternative to the single directory configuration.

```json
{
  "directory": ["./src"]
}
```

--------------------------------

### Flat Structure Output

Source: https://www.npmjs.com/package/barrelsby

Example of the generated content when using the flat structure mode.

```typescript
export * from "./barrel";
export * from "./index";
export * from "./directory2/script";
export * from "./directory2/directory4/deeplyNested";
export * from "./directory3/program";
```

--------------------------------

### Directory Configuration Example (Single)

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Configure Barrelsby to create barrels in a specific directory. This JSON configuration specifies './src' as the root directory for barrel generation.

```json
{
  "directory": "./src"
}
```

--------------------------------

### Install Barrelsby

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Install Barrelsby as a development dependency in your project using npm.

```bash
npm install --save-dev barrelsby

```

--------------------------------

### Messy Imports Example

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Before using barrels, imports can become verbose and scattered across multiple files.

```typescript
import {DropDown} from "./src/controls/DropDown";
import {TextBox} from "./src/controls/TextBox";
import {CheckBox} from "./src/controls/CheckBox";
import {DateTimePicker} from "./src/controls/DateTimePicker";
import {Slider} from "./src/controls/Slider";
```

--------------------------------

### Example Barrel File Content

Source: https://www.npmjs.com/package/barrelsby

A typical barrel file aggregates exports from multiple modules into a single file.

```typescript
export * from "./DropDown";
export * from "./TextBox";
export * from "./CheckBox";
export * from "./DateTimePicker";
export * from "./Slider";
```

--------------------------------

### Export Default with Full Pathname Example

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

The `--fullPathname` flag, used with `--exportDefault` and `flat` mode, exports default values using the full path to the module as the identifier.

```typescript
export * from "./example/of/the/path";
export { default as exampleOfThePath } from "./example/of/the/path";
```

--------------------------------

### Export Default Example

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

When the `--exportDefault` flag is enabled, Barrelsby also exports the default export of each module. This currently only works with the `flat` structure mode.

```typescript
export * from "./barrel";
export { default as barrel } from "./barrel";
```

--------------------------------

### Run Barrelsby

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Execute the configured npm script to generate barrels in your project.

```bash
npm run generate-barrels

```

--------------------------------

### Import Comparison

Source: https://www.npmjs.com/package/barrelsby

Comparison between verbose individual imports and simplified barrel-based imports.

```typescript
import {DropDown} from "./src/controls/DropDown";
import {TextBox} from "./src/controls/TextBox";
import {CheckBox} from "./src/controls/CheckBox";
import {DateTimePicker} from "./src/controls/DateTimePicker";
import {Slider} from "./src/controls/Slider";
```

```typescript
import {DropDown, TextBox, CheckBox, DateTimePicker, Slider} from "./src/controls";
```

```typescript
import * as Controls from "./src/controls/index";
```

--------------------------------

### Alternative Import Style with Barrel

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

An alternative import style using a namespace import from the barrel file.

```typescript
import * as Controls from "./src/controls/index";
```

--------------------------------

### Add Generate Barrels Script to package.json

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

Configure a script in your `package.json` file to run Barrelsby. The `--delete` flag removes existing barrels before generating new ones.

```json
{
  "scripts": {
    "generate-barrels": "barrelsby --delete"
  }
}
```

--------------------------------

### Exporting Nested Directory Structure

Source: https://www.npmjs.com/package/barrelsby

This code snippet demonstrates how to export modules from a nested directory structure to match the file system. It requires importing modules from various deep paths and re-exporting them in a structured way.

```typescript
import * as barrelts from "./barrel";
import * as directory2directory4deeplyNestedts from "./directory2/directory4/deeplyNested";
import * as directory2scriptts from "./directory2/script";
import * as directory3programts from "./directory3/program";
import * as indexts from "./index";
export {barrelts as barrel};
export const directory2 = {
  directory4: {
    deeplyNested: directory2directory4deeplyNestedts,
  },
  script: directory2scriptts,
};
export const directory3 = {
  program: directory3programts,
};
export {indexts as index};
```

--------------------------------

### Tidied Imports with Barrel

Source: https://www.npmjs.com/package/barrelsby?activeTab=readme

After implementing barrels, imports are significantly simplified, referencing the barrel file instead of individual modules.

```typescript
import {DropDown, TextBox, CheckBox, DateTimePicker, Slider} from "./src/controls";
```
Tokens:
Raw