front-end's bpm plan for Jarvis

介绍

jarvis-bpm基于jarvis观星台的埋点方案，提供了一套集用户路径获取和埋点值替换于一体的解决方案，需要搭配@bizfe/bpmid-replace-loader包一起使用

Install

$ npm i -S @bizfe/jarvis-bpm

Usage

1. 安装@bizfe/jarvis-bpm包，后在package.json文件scripts中加入如下内容：

"scripts": {
    "bpm": "node node_modules/@bizfe/jarvis-bpm/dist/logConfigResolver.js",
    ...
    "qa": "npm run bpm && npm run build:qa",
    "pub": "npm run bpm && npm run build:production"
  },

此处需要注意，只有qa和线上的构建脚本需要先执行下npm run bpm操作。

2. 在package.json中加入jarvisBpm相关配置信息：

"jarvisBpm": {
    "systemName": "atlas"//此处填写系统名称
}

此处的系统名称是根据PMS系统中，代码模块的名称一一对应的

3. 将以下内容加入到webpack.config.js文件当中：

const bpmConfig = require('jarvisBpmConfigs.js');
    common.loaders.push(
        {
            test: /\.(jsx|tpl)$/i,
            loader: '@bizfe/bpmid-replace-loader',
            exclude: resolve('node_modules/'),
            query: {
                config: bpmConfig
            }
        }
    )

jarvis-bpm会将通过starfish库拿到的埋点key值和hash的映射表写入到系统根目录下的jarvisBpmConfigs.js文件，在webpack.config.js中，jarvisBpmConfigs.js中的内容导出给@bizfe/bpmid-replace-loader作为配置使用。

4. 将以下内容加入系统的入口文件中:

import '@bizfe/jarvis-bpm';

License

MIT