@ysfe/sentry-webpack-plugin NPM

@ysfe/sentry-webpack-plugin

sentry cli 的 webpack 插件集成.

前置依赖

node >= 8.0.0
4.x <= webpack < 5.x

开发指引

传送门

使用方式

以下结合 vue 应用场景, 整理使用文档

安装: 执行 yarn add @ysfe/sentry-webpack-plugin --dev 安装插件

使用:

在 vue.config.js 中, 引用插件.

   const { SentryAutocWebpackPlugin } = require('@ysfe/sentry-webpack-plugin')

   // 通过 configureWebpack 配置
   module.exports = {
       configureWebpack: {
           plugins: [
              new SentryAutocWebpackPlugin(),
              // other plugins ...
           ]
       }
   }

   // or 通过 chainWebpack 配置

   module.exports = {
      chainWebpack: (config) => {
         // add plugin
         config
            .plugin('SentryAutocPlugin')
            .use(new SentryAutocWebpackPlugin({ /* options ... */ }))
      }
   }

项目根目录下创建配置文件 .sentryclirc

内容格式: docs
宇石内部参考: yuque
文件参考

 [auth]
 ## sentry用户 auth token.
 token=
 ## project dsn -  可在项目设置或创建项目时查看.
 dsn=
 [defaults]
 ## sentry 服务地址, 如: https://sentry.io
 url=
 ## 注意是用户的org
 org=
 ## project name
 project=
 [log]
 # 日志等级, 一般不管
 level=info

备注:
1. 关于环境判断: 默认情况下, 仅在 process.env.NODE_ENV === 'production' 时, 启用插件. 可通过 options.disable 在任意场景下禁用插件.

命令行参数

(1.2.1 新增) 执行编译命令时, 如果命令行增加参数 --tag=[git tag], 则直接采用 git tag 名称作为 sentry 版本号, 且不再提交备份的 git tag.

杂项

插件构造函数参数

/** sentry-autoc 配置 */
export interface SentryAutocPluginOptions {
    /** 禁用 sentry autoc 插件, 默认情况下会主动判断当前的NODE_ENV ==='production' */
    disable?: boolean
    /** 禁用 git tag 备份 */
    disableGitTagBackup?: boolean

    /** sentry cli 配置 */

    /** sentry 项目dsn内容, 必填 */
    dsn: string
    /** sentry 要提交哪些文件, 默认值: './dist'  */
    include?: string | Array<string>

    /** 手工指定版本号 */
    release?: string
    /** sentry 服务地址 */
    url?: string
    /** sentry user auth token */
    authToken?: string
    /** user Organization slug */
    org?: string
    /** sentry project name */
    project?: string
    /** VCS remote name, 作用位置 */
    vcsRemote?: string

    /**
     * Determines whether processed release should be automatically finalized after artifacts upload.
     * Defaults to `true`.
     */
    finalize?: boolean

    /** 手工指定 @sentry/cli 配置文件.
     *
     * @doc https://docs.sentry.io/learn/cli/configuration/#properties-files.
     */
    configFilePath?: string
}

release 生成规则

当指定命令行参数 --tag=[tag name]时, 直接采用 tag 参数作为 sentry.release 版本号. 且不再提交备份 tag.
当未指定 --tag 参数,
1. 存在 git repo 时, 生成 sentry_[month][day][index], 例: sentry_033001. 并推送同名 tag
2. 不存在 git repo 时, 使用 package.json 中的 version 字段作为版本号. (此时版本号不会自动更新)

其他说明事项