Skip to content

smg-automotive/next-page-bundlesize-pkg

Repository files navigation

next-page-bundlesize-pkg

Page-level bundle size check for next.js

CircleCI semantic-release

Usage

npm install @smg-automotive/next-page-bundlesize -D
next build
npx next-page-bundlesize --maxSize="150 kB" --buildDir=.next

Arguments

Argument Description Default value
--maxSize Max size of the pages that you aim for. If no previous config is specified, it is applied for all pages. If you have specified a config, the value of the previous config is taken and maxSize is only applied to new pages. "200 kB"
--buildDir Directory where your project is built. ".next"
--delta Delta for pages below maxSize so that they don't get bigger and bigger. "5 kB"
--previousConfigFileName If you want to compare the bundlesize against a previous configuration and not the maxSize. The file must be located under the buildDir buildDir/previousConfigFileName. The package will create an updated configuration for further usage in the same directory buildDir/bundlesize.json

Development

npm run build

You can link your local npm package to integrate it with any local project:

cd next-page-bundlesize-pkg
npm run build

cd <project directory>
npm link ../next-page-bundlesize-pkg

Release a new version

New versions are released on the ci using semantic-release as soon as you merge into master. Please make sure your merge commit message adheres to the corresponding conventions and your branch name does not contain forward slashes /.