last-release-git-info-plugin

Table of Contents

• last-release-git-info-plugin
  • Table of Contents
  • Features
  • Install
  • Usage
    • 在webpack项目中使用
    • 在vue-cli中使用
    • 在nuxt.js中使用
  • Options
    • options.buildLog
    • options.log
    • options.generateFile
    • options.releaseFileName
    • options.showBuildTime
    • options.showBuildBranch
    • options.showBuildCommitId
    • options.showDeveloperName
    • options.showDeveloperEmail
    • options.showBuildCommitDate
    • options.showBuildCommitInfo
    • options.externalTxt
  • Notice
  • License

Features

在构建的时候可以根据配置在浏览器控制台，以及构建终端的时候输出最新一次的构建信息（包括构建时间、构建分支、构建commitID、最近开发者名称、最近开发者邮箱、最新commit日期、最新commit信息）。注意：由于这些信息属于敏感信息，在生产环境不能在控制台输出这些构建信息！！生成的txt文件可以通过反爬虫防止爬虫爬取。

生成的信息如下：

*********************************************************************
构建日期: 2021-7-6 15:14
构建分支: main
构建commit:6539e75f3cf5686eda6892bce5986ae4674cf227
commit时间:2021-7-3 16:03
说明:feat: 🎸 添加access
*********************************************************************

⬆ Back to Top

Install

yarn add @barretter/last-release-git-info-plugin -D

⬆ Back to Top

Usage

该插件依赖git项目，需要结合git项目使用

在webpack项目中使用

const LastReleaseGitInfoPlugin = require('@barretter/last-release-git-info-plugin')

const config = {
  plugins: [
    new lastReleaseGitInfoPlugin(options)
  ]
}

在vue-cli中使用

vue.config.js

const LastReleaseGitInfoPlugin = require('@barretter/last-release-git-info-plugin')
const config = {
  chainWebpack: config => {
    config.plugin('last-release-git-info-plugin').use(LastReleaseGitInfoPlugin, [options])
  }
}

在nuxt.js中使用

nuxt.config.js

const config = {
  modules: ['@barretter/last-release-git-info-plugin/nuxt', options]
}

就这么简单！

⬆ Back to Top

Options

options.buildLog

• Type: boolean
• Default: false

是否在构建的时候输出最新一次的构建信息。

options.log

• Type: boolean
• Default: false

是否在浏览器控制台输出最新一次的构建信息。

options.generateFile

• Type: boolean
• Default: false

是否生成构建信息文件。

options.releaseFileName

• Type: string
• Default: release_git_info.txt

最新构建信息的保存文件名。

options.showBuildTime

• Type: boolean
• Default: true

是否显示构建时间

options.showBuildBranch

• Type: boolean
• Default: true

是否显示构建分支

options.showBuildCommitId

• Type: boolean
• Default: true

是否显示构建commitID

options.showDeveloperName

• Type: boolean
• Default: false

是否显示开发者名称

options.showDeveloperEmail

• Type: boolean
• Default: false

是否显示开发者邮箱

options.showBuildCommitDate

• Type: boolean
• Default: true

是否显示commit日期

options.showBuildCommitInfo

• Type: boolean
• Default: true

是否显示commit信息

options.externalTxt

• Type: string
• Default: ''

额外显示的字段

Notice

目前该插件暂时不支持webpack5

License

MIT

⬆ Back to Top