https://github.com/ampproject/filesize

Monitor the size of files in your project specified within package.json.
https://github.com/ampproject/filesize

Last synced: 2 days ago
JSON representation

Monitor the size of files in your project specified within package.json.

• Host: GitHub
• URL: https://github.com/ampproject/filesize
• Owner: ampproject
• License: apache-2.0
• Created: 2020-01-24T22:41:46.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T06:34:23.000Z (about 2 months ago)
• Last Synced: 2024-10-29T03:19:12.153Z (16 days ago)
• Language: TypeScript
• Homepage:
• Size: 832 KB
• Stars: 75
• Watchers: 6
• Forks: 10
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-list - filesize

README

        
# Filesize

**Purpose**: Monitor the size of files in your project specified within `package.json`.

Uses native compression from Node Core, attempts to parallelize compression work across available CPUs, and requires Node >= `12`.

![Interactive UI Processing Large Files](https://raw.githubusercontent.com/ampproject/filesize/main/.github/preview.gif)

## Installation

```bash

yarn add @ampproject/filesize --dev

```

## Usage

Specify an object of files you'd like to check the size for inside the `filesize` key of `package.json`.

```json

{

  "filesize": {

    "./dist/index.js": {

      "brotli": "11.4 kB"

    }

  }

}

```

Each file (key in the filesize object) must include an object with key/value pairs:

1. The key is the `compression` type you would like to use on the file.

2. The value is the string representation of the files maximum allowed size.

**After completing configuration**, invoke `filesize` via: `yarn filesize`. 

Optionally one can target a different project directory via the `p` parameter `yarn filesize -p={PATH}`, or a different configuration file via the `c` parameter `yarn filesize -c=${PATH/filesize.json}`.

### Track Resource Size

This utility now also supports tracking filesizes without enforcing a max limit. To use this feature add a `track` key to the `filesize` entry.

```json

{

  "filesize": {

    "track": ["./dist/**/*.mjs"],

  }

}

```

These values will be added to the output report for all comression types.

## Security disclosures

The AMP Project accepts responsible security disclosures through the [Google Application Security program](https://www.google.com/about/appsecurity/).

## Code of conduct

The AMP Project strives for a positive and growing project community that provides a safe environment for everyone.  All members, committers and volunteers in the community are required to act according to the [code of conduct](.github/CODE_OF_CONDUCT.md).

## License

filesize is licensed under the [Apache License, Version 2.0](LICENSE).