https://github.com/tanmen/export-indexer

Automatically generates an index file library
https://github.com/tanmen/export-indexer

Last synced: about 2 months ago
JSON representation

Automatically generates an index file library

• Host: GitHub
• URL: https://github.com/tanmen/export-indexer
• Owner: tanmen
• Created: 2021-02-11T04:02:50.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-17T00:04:41.000Z (5 months ago)
• Last Synced: 2024-08-17T00:37:22.799Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 217 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# export-indexer

This library is a library that automatically generates an index file.

## How to run

```

npx export-indexer

```

### Install

`npm`

```shell

npm install -D export-indexer

```

`yarn`

```shell

yarn add -D export-indexer

```

## Usage

Create a `.index` file where you want the index file to be generated.

### Example

If the directory structure is as follows

```

└ components

  ├ .index

  └　test.tsx

```

Do the following in terminal:

```

npx export-indexer

```

If you want to detect changes:

```shell

npx export-indexer --watch

```

Then, the following contents will be output.

`index.ts`

```

export * from './text';

```

`file`

```

└ components

  ├ .index

  ├ index.ts

  └　test.tsx

```