Skip to content
bar-chart-2

GitHub Action

Heaviest Objects in the Universe

v1 Latest version

Heaviest Objects in the Universe

bar-chart-2

Heaviest Objects in the Universe

Measure the size of a module and all its dependencies

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Heaviest Objects in the Universe

              
  uses: Qard/heaviest-objects-in-the-universe@v1
Learn more about this action in Qard/heaviest-objects-in-the-universe

Choose a version

heaviest objects in the universe...node_modules

heaviest-objects-in-the-universe

This project is a Node.js module, a CLI tool, and a GitHub Action all rolled into one. It measures the size of a module and all its dependencies.

Node.js Module

npm install heaviest-objects-in-the-universe
const { moduleSizeTree } = require('heaviest-objects-in-the-universe')

const tree = await moduleSizeTree('./', {
  // Include devDependencies of root module
  // Default: false
  withDev: true,
  // Set the root to resolve the base path from
  // Default: process.cwd()
  cwd: process.cwd(),
  // Ignore given filenames in size checks and recursion
  // Default: [ '.git', 'node_modules' ]
  ignore: [ '.git', 'node_modules' ]
})

For a reference describing the tree structure, see the TypeScript types.

CLI Tool

npm install --global heaviest-objects-in-the-universe
hoitu ./path/to/my/module

GitHub Actions

uses: qard/heaviest-objects-in-the-universe@v1
with:
  # Required to provide issue comments
  github-token: ${{ secrets.GITHUB_TOKEN }}