Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fabiospampinato/vscode-banal

A super quick way to inspect the bundle size of npm dependencies, via a code lens.
https://github.com/fabiospampinato/vscode-banal

analyzer banal bundle dependencies esbuild extension vsc vscode

Last synced: 2 months ago
JSON representation

A super quick way to inspect the bundle size of npm dependencies, via a code lens.

Host: GitHub
URL: https://github.com/fabiospampinato/vscode-banal
Owner: fabiospampinato
License: mit
Created: 2024-03-31T00:10:33.000Z (10 months ago)
Default Branch: master
Last Pushed: 2024-03-31T00:37:56.000Z (10 months ago)
Last Synced: 2024-05-01T12:39:24.663Z (9 months ago)
Topics: analyzer, banal, bundle, dependencies, esbuild, extension, vsc, vscode
Language: TypeScript
Homepage:
Size: 266 KB
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license

Awesome Lists containing this project

README

# Banal

A super quick way to inspect the bundle size of npm dependencies, via a code lens.

Clicking the code lens will instantly open up [`esbuild`](https://github.com/evanw/esbuild)'s bundle analyzer for the currently installed version of the target dependency.

This extension requires [`npm-cli`](https://github.com/npm/cli) and [`banal-cli`](https://github.com/fabiospampinato/banal)>=1.6.0 to be installed and it only works for npm dependencies listead in `package.json` files.

## Install

Follow the instructions in the [Marketplace](https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-banal), or run the following in the command palette:

```sh
ext install fabiospampinato.vscode-banal
```

## Usage

It adds 3 commands to the command palette:

```js
'Banal: Toggle' // Enable or disable the code lens
'Banal: Disable' // Disable the code lens
'Banal: Enable' // Enable the code lens
```

## Settings

```js
{
"banal.enabled": true // Whether the code lens is enabled or not
}
```

## Demo

![Demo - Editor](resources/demo-editor.png)

![Demo - Bundle Analyzer](resources/demo-analyzer.png)

## License