{"repo":"bencoveney/barrelsby","free":true,"listed":false,"github":"https://github.com/bencoveney/barrelsby","clone":"git clone https://github.com/bencoveney/barrelsby.git","description":"Automatic TypeScript barrels (index.ts files) for your entire code base","language":"TypeScript","stars":600,"topics":["typescript","barrel","index","cli","node","npm"],"license":"MIT","category":"cli-tools","readme_excerpt":"Automatically create TypeScript barrels for your entire code base. About Barrels Barrels are files that rollup exports from several modules into a single convenient module typically named index.ts . They tend to help simplify large blocks of import statements at the top of files and help to group up related functionality. A barrel file looks like this: It can help you go from messy imports like this: ...to something tidier like this: ...or even this: More Reading TattooCoder Blog Barrelsby Articles Rupesh Tiwari Blog Medium Article Alternatives Barrelbot creeate-index Usage To install Barrelsby: To run barrelsby first add a script to the package.json file: You can now generate barrels: Configuration Options Barrelsby accepts a number of options to help refine how your barrels are created. These options can be configured from the command line or using a configuration file. -c [path] or --config [path] Specifies the location of the barrelsby configuration file. This file must be a .json file. You can include any of the configuration options using their long name. -d [path...] or --directory [path...] Specifies a list of root directories where barrels will be created from. Uses the current directory by default. Note : This is backwards compatible with previous versions. Existing configuration files will be parsed correctly. The following two json files will behave identically. -D or --delete Deletes any existing barrels encountered by barrelsby. Disabled by default. -e [regex...","default_branch":null,"files":null,"tree":[],"storefront":"/r/bencoveney","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/bencoveney/barrelsby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}