Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fabiospampinato/banal

On-demand bundle analyzer, powered by esbuild.
https://github.com/fabiospampinato/banal

analyzer bundle esbuild

Last synced: 9 days ago
JSON representation

On-demand bundle analyzer, powered by esbuild.

Host: GitHub
URL: https://github.com/fabiospampinato/banal
Owner: fabiospampinato
License: mit
Created: 2023-07-16T23:59:51.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-06-16T18:24:37.000Z (6 months ago)
Last Synced: 2024-12-02T00:11:31.716Z (10 days ago)
Topics: analyzer, bundle, esbuild
Language: HTML
Homepage:
Size: 2.32 MB
Stars: 96
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

my-awesome-list - banal - demand bundle analyzer, powered by esbuild. | fabiospampinato | 96 | (HTML)

README

# Banal

On-demand bundle analyzer, powered by esbuild.

## Features

This little terminal app exists because [Bundlephobia](https://bundlephobia.com) and [bundlejs](https://bundlejs.com) are pretty cool and useful, but bundling locally and with offline support can easily work more reliably.

- **Simple**: the way this app works is super simple, it just generates the metadata file for the [bundler analyzer](https://esbuild.github.io/analyze) in a temporary directory, embeds it inside the bundle analyzer itself, and opens it.
- **Secure**: postinstall scripts are disabled for security reasons, and only dependencies I personally maintain and [`esbuild`](https://github.com/evanw/esbuild) are used.
- **Available**: unless NPM itself is unreachable, or esbuild can't bundle your modules, this bundle analyzer will always be available.
- **Customizable**: some important options, like the target platform or the target format, can be configured. Unlike in [Bundlephobia](https://bundlephobia.com) where for many modules bundling will just fail.
- **Offline support**: esbuild's amazing [bundle analyzer](https://esbuild.github.io/analyze) is embedded within the app, so the analysis can potentially even work if you are offline, if NPM has the modules you want to analyze cached already.
- **Sharing support**: a single HTML file is generated, specific to the analyzed modules, so it can be shared trivially.

## Install

```sh
npm install -g banal
```

## Usage

https://github.com/fabiospampinato/banal/assets/1812093/554327fa-c070-44af-89fb-52eff57a70ce

Some example usages:

```sh
# Analyze a single module
banal crypto-sha

# Analyze a single module, at a specific version
banal [email protected]

# Analyze a single module, with the module flag set explicitly (optional)
banal -m crypto-sha

# Analyze a single local module
banal ./src/index.ts

# Analyze a single namespaced module
banal @fabiospampinato/is

# Analyze multiple modules together
banal crypto-sha crypto-puzzle

# Analyze a Node module
banal -p node -m banal

# Analyze a single module with a custom input file
banal -m @fabiospampinato/is -i 'export {isWeakRef} from "@fabiospampinato/is";'
```

## Related

- **[Banal for VSCode](https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-banal)**: The official companion extension for Banal, for quickly inspecting the bundle size of npm dependencies.

## License