gen-buildinfo-webpack-plugin

Generate a buildinfo.json file to public directory.

Installation

1# Webpack (CRA)
2yarn add -D gen-buildinfo-webpack-plugin
3 
4# Next.js
5yarn add gen-buildinfo-webpack-plugin 

Usage

Webpack (CRA)

1// webpack.config.js
2const GenBuildinfoWebpackPlugin = require('gen-buildinfo-webpack-plugin');
3
4new GenBuildinfoWebpackPlugin({
5  package: require('./package.json'),
6  //
7  // [Options]
8  // fileDir: PROJECT_PUBLIC_DIR,
9  // fileName: 'buildinfo.json',
10  // commitHashLength: 4, 
11})

Next.js

1// next.config.js
2// use `process.env.NEXT_PUBLIC_BUILD_INFO`
3const { getBuildInfo } = require('gen-buildinfo-webpack-plugin');
4
5module.exports = {
6  env: {
7    NEXT_PUBLIC_BUILD_INFO: JSON.stringify(
8      getBuildInfo({ package: require('./package.json') }),
9    ),
10  },
11  webpack(webpackConfig) {
12    return webpackConfig;
13  },
14  // ....
15}

Output

1const { getBuildInfo } = require('gen-buildinfo-webpack-plugin');
2
3// {
4//   "PKG_NAME": "demo",
5//   "AUTHOR": "Jason Feng <solidzoro[#]live.com>",
6//   "VERSION": "2.66.1",
7//   "BUILD_NUMBER": 2066001,
8//   "BUILD_TIME": "20230406-142929",
9//   "COMMIT_HASH": "c6ed"
10// };
11const buildInfo = getBuildInfo({ package: require('../../package.json') });

License

MIT © Jason Feng