@renzp/unplugin-build-info

一款将打包信息打印在控制台上的插件。

支持框架：

• webpack4/webpack5
• vite
• rollup
• rspack
• rsbuild
• farm

Install

npm i @renzp/unplugin-build-info -D 

Usage

webpack

// webpack.config.ts
import BuildInfoWebpackPlugin from '@renzp/unplugin-build-info/webpack'

export default {
  plugins: [BuildInfoWebpackPlugin()]
}

vite

// vite.config.ts
import { defineConfig } from 'vite'
import BuildInfoVitePlugin from '@renzp/unplugin-build-info/vite'

export default defineConfig({
  plugins: [BuildInfoVitePlugin()],
})

rspack

// rspack.config.js
const BuildInfoRspackPlugin = require('@renzp/unplugin-build-info/rspack')

module.exports = {
  plugins: [BuildInfoRspackPlugin.default()]
}

rsbuild

// rsbuild.config.ts
import { defineConfig } from '@rsbuild/core'
import BuildInfoRspackPlugin from '@renzp/unplugin-build-info/rspack'

export default defineConfig({
  tools: {
    rspack: {
      plugins: [BuildInfoRspackPlugin()],
    },
  },
})

rollup

// rollup.config.mjs
import BuildInfoRollupPlugin from '@renzp/unplugin-build-info/rollup'

export default {
  plugins: [BuildInfoRollupPlugin()],
}

farm

// farm.config.ts
import { defineConfig } from '@farmfe/core'
import BuildInfoVitePlugin from '@renzp/unplugin-build-info/vite'

export default defineConfig({
  vitePlugins: [BuildInfoVitePlugin()],
})

如果使用的html模板名字不是index.html，则可通过html参数指定模板名称(vite插件不需要此参数)。注意是文件名称，不是文件路径。

例如：

• html模板文件路径为：./src/html/index.html，则无需指定。
• html模板文件路径为：./src/html/app.html，则需要指定html: 'app.html'

原因：内部通过匹配资源文件名来进行查找html文件的，默认为index.html，如果不是则需要指定。

import BuildInfoWebpackPlugin from '@renzp/unplugin-build-info/webpack'

export default {
    plugins: [BuildInfoWebpackPlugin({ html: 'app.html'})]
}

Options

interface Options {
  // html模板文件，默认为index.html，如果使用的html模板不是index.html，则可以使用该选项指定模板文件名称
  html?: string
  // 是否显示项目名称(package.name)
  showName?:boolean
  // 是否显示项目版本号(package.version)
  showVersion?:boolean
  // 项目名称样式
  nameBlockColor?: string
  // 是否显示打包时间
  showTime?:boolean
  // 打包时间样式
  timeBlockColor?: string
  // 是否显示git信息
  showGit?:boolean
  // git信息样式
  gitBlockColor?: string
}