npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

barrelify

v1.2.3

Published

Auto-generate TS barrel files.

Downloads

520

Readme

barrelify

Auto-generate TS barrel files.

npm package License

Contents

Introduction

Auto-generate barrel files for typescript.

Scans your directories for index.ts files with the // AUTO-BARREL comment at the start. Then re-writes the files as a barrel of all other javascript files in the directory.

Respects CommonJS/ESM compatibilities. Always ignores .gitignore-d and node_modules files.

Barrel files should be checked into version control.

Install

npm i barrelify --save-dev

Example

Given file structure

/
├─┬ cjs
│ ├── package.json // { "type": "commonjs" }
│ ├── cts.cts
│ ├── ts.ts
│ ├── esm.mts
│ └── index.ts // AUTO-BARREL
├─┬ esm
│ ├── package.json // { "type": "module" }
│ ├── cts.cts
│ ├── ts.ts
│ ├── esm.mts
│ └── index.ts // AUTO-BARREL
└─┬ ignore
  ├── foo.ts
  └── index.ts // _not_ AUTO-BARREL

npx barrelify will rewrite:

/cjs/index.ts:

// AUTO-BARREL

export * from './cts.cjs';
export * from './ts.js';

/esm/index.ts:

// AUTO-BARREL

export * from './cts.cjs';
export * from './ts.js';
export * from './esm.mjs';

Note that the // AUTO-BARREL comment is preserved, so future npx barrelify will continue to keep files in sync.

Usage

barrelify is an ESM module. That means it must be imported. To load from a CJS module, use dynamic import const { barrelify } = await import('barrelify');.

It is also available as a CLI.

npx barrel --help to get started.

It is generally recommended to only include barrelify as a dev/test dependency.

Make sure your index files are flagged with // AUTO-BARREL as the very first characters in the file. It will not generate index files by itself.

npx barrel --ci will execute a special "dry-run" version, that throws an error if any files are found out of sync. This can ensure barrel files are properly generated before checking into version control, or during CI tests.

API

barrelify(options?)

Programmatic way to access barrelify. Performs same actions as CLI.

options

cwd

string (default = process.cwd())

Directory to start search for index files. Defaults/resolves from process.cwd().

Recursively checks directories starting from this point.

dryRun

boolean (default = false)

If true, will not actually perform file writes.

ignore

string[] (default = [])

Globs for index files that should be explicitly ignored.