Packtracker
made with
Vuejs
简介及使用教程
Packtracker是一个Webpack打包的监视工具,提供在每个拉动请求中检查用户的webpack软件包大小的功能,并且能够随着时间的推移跟踪用户的webpack软件包进行分析,从而优化用户的资源包,避免打包过大。
安装
Npm
npm i --save-dev @packtracker/webpack-plugin
Yarn
yarn add --save-dev @packtracker/webpack-plugin
使用
通过Webpack插件
在你的webpack配置中引入这个插件:
const PacktrackerPlugin = require('@packtracker/webpack-plugin')
module.exports = {
plugins: [
new PacktrackerPlugin({
project_token: '<your packtracker project token>',
upload: true
})
]
}
上面的upload
选项告诉插件在运行webpack时是否上传你的构建数据。默认情况下,此选项设置为false,以防止意外从本地计算机上载。如果上传选项为false,则插件将什么也不做。
一旦发现数据正在上载,通常只在CI环境中或部署期间构建的资产时才上传。你还可以完全省略此选项,并在每次运行的基础上设置PT_UPLOAD
环境变量,以控制统计数据的上载。
例子:
const PacktrackerPlugin = require('@packtracker/webpack-plugin')
module.exports = {
plugins: [
new PacktrackerPlugin({
project_token: '<your packtracker project token>',
upload: process.env.CI === 'true'
})
]
}
CLI模式
除了通过webpack插件上传作为构建过程一部分的主要用例外,我们还有一个命令行上传器,它可以很好地与如create-react-app
等工具一起工作,这些工具允许您导出您的统计数据,但不允许完整的插件配置。
注意,使用CLI必须使用环境变量来配置STAT报表(最重要的是PT_PROJECT_TOKEN)。
这是一个使用 create-react-app
的例子:
在package.json
中:
{
"scripts": {
"packtracker": "react-scripts build --stats && packtracker-upload --stats=build/bundle-stats.json"
}
}
选项
选项 | 环境变量 | 描述 |
---|---|---|
project_token |
PT_PROJECT_TOKEN |
必填,packtracker.io 项目的秘钥 |
fail_build |
PT_FAIL_BUILD |
默认为false,如果上传失败,抛出异常 |
branch |
PT_BRANCH |
提交的分支 (默认: git rev-parse --abbrev-ref HEAD ) |
author |
PT_AUTHOR |
提交者的邮箱地址 (默认: git log --format="%aE" -n 1 HEAD ) |
message |
PT_MESSAGE |
提交信息(默认: git log --format="%B" -n 1 HEAD ) |
commit |
PT_COMMIT |
提交的sha 值(default: git rev-parse HEAD ) |
committed_at |
PT_COMMITTED_AT |
提交时的Unix时间戳(ms) (默认: git log --format="%ct" -n 1 HEAD ) |
prior_commit |
PT_PRIOR_COMMIT |
上一个提交的sha值 (默认: git rev-parse HEAD^ ) |
exclude_assets |
PT_EXCLUDE_ASSETS |
webpack状态配置的excludeAssets 选项的镜像(webpack3.5.0+支持) (如果你通过环境变量提供,将作为正则表达式编译) |
更详细的文档见https://docs.packtracker.io/
作者
Jonathan Johnson
@jondavidjohn相关项目