Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sw-yx committed Feb 17, 2019
1 parent cab9c99 commit 5a67c22
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

Recursively watches a folder and generates barrel files (https://github.com/basarat/typescript-book/blob/master/docs/tips/barrel.md)

- Install globally, run anywhere
- .ts extensions for now but can extend to .js, .mjs, etc...
- Install globally, run anywhere you want
- generates index.tsx files by default, use a flag for `.ts`, `.js`, `.jsx`

## How to use

Expand Down Expand Up @@ -35,6 +35,12 @@ Before running barrelbot, I advise committing your project to git first.

This way, if you run the bot and find barrel files that aren't generated to your liking, you can run `git clean -f` to remove them.

## Plan

- interactive fix mode

currently the bot bails out whenever a noncompliant index.ts file is found. we can add ignore and skip semantics as well as an interactive fix method for easier onboarding.

## inspiration

https://github.com/bencoveney/barrelsby

0 comments on commit 5a67c22

Please sign in to comment.