# jarvis-bpm

> a frontend buried point plan for Jarvis log platform

Latest version **0.0.1** (published 2017-11-03) · 0 weekly downloads

## Install

```sh
npm install jarvis-bpm
pnpm add jarvis-bpm
yarn add jarvis-bpm
bun add jarvis-bpm
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-11-03 |
| First published | 2017-11-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kuso_kaiser |
| Maintainers | kuso_kaiser |

## Links

- npm: https://www.npmjs.com/package/jarvis-bpm
- npm.io page: https://npm.io/package/jarvis-bpm

## Dependencies (1)

- [es6-promise](https://npm.io/package/es6-promise.md) 3.1.2

## Recent versions

- 0.0.1 (latest) — 2017-11-03

## README

## front-end's bpm plan for Jarvis

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

### Install

```sh
$ 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系统中，代码模块的名称一一对应的
![image](http://note.youdao.com/yws/public/resource/06e1becd3437df723a326e14ea2a8cc2/xmlnote/E43DE3B997594574AD53D99F584CD60D/27041)

**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

---
_Source: https://npm.io/package/jarvis-bpm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._