# geneTracker

**Repository Path**: browniu/geneTracker

## Basic Information

- **Project Name**: geneTracker
- **Description**: to gene tracker file simpliable
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-31
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# @xfe/tracker-cli

> 一个用于生成 埋点函数集 的工具

通过现有的数据上报工具[@xfe/st-report-sdk](http://npm-registry.seasungame.com/#/detail/@xfe/st-report-sdk)能够直接方便的进行数据埋点, 并最终上报的工作. 
但考虑到该方案需要根据需求方提供的埋点信息表单手写一份对应的埋点函数集, 虽然已经不需要做太多的工作. 
但为了防止这个过程出现错误或减少遗漏，已经进一步提高工作效率，所以现在可以使用这个流程进行自动化处理.

## 安装

```bash
  npm i @xfe/tracker-cli -g
```

## 使用

### 生成埋点文件

```bash
  tracker create <path/filename.js> <label> <createPathAble>
```

| 参数             | 解释                                                         |
| ---------------- | ------------------------------------------------------------ |
| create           | 一级指令：创建                                               |
| path/filename.js | 指定保存路径和文件名                                         |
| label            | [项目标示](http://test-xsjdata.xoyo.com/data/event/cpanel/task/list) |
| createPathAble   | 是否允许自动创建不存在的路径                                 |

在指定目录创建指定文件名的 tracker 文件 并根据指定 项目label 生成埋点代码片段

#### 使用示例
```bash
tracker create src/tracker/index.js jx3_syld_mo_20190528 false
```

#### 生成示例

```JavaScript
export const config = {
  eventGroup: "maidian_test_20190806",
  name: "埋点测试",
  identify: "xoyo",
  eventTags: ["测试", "移动端"]
};

export default function createTracker(report, getDiffRouteTime) {
  return {
    // getDiffRouteTime()(秒)
    loadPage: function() {
      report({
        eventName: "load_page",
        eventDescription: "全局埋点",
        eventDataValue: {
          td_pl: getDiffRouteTime()
        }
      });
    },
    // getDiffRouteTime()(秒)
    loadPageIndex: function() {
      report({
        eventName: "load_page_index",
        eventDescription: "首页加载",
        eventDataValue: {
          td_pl: getDiffRouteTime()
        }
      });
    },
        //...
   }
}
```

### 查询埋点状态

```bash
tracker check <label> <simpleAble>
```
| 参数       | 解释                                                         |
| ---------- | ------------------------------------------------------------ |
| check      | 一级指令：查询                                               |
| label      | [项目标示](http://test-xsjdata.xoyo.com/data/event/cpanel/task/list) |
| simpleAble | 是否简化输出数据结构                                         |


返回对应项目标示的所有异常状态的埋点，便于减少遗漏

#### 使用示例

```bash
tracker check jx3_syld_mo_20190528
```

提供第三个参数可配置是否简化输出信息，默认为`false`

## 注意

**1. 请确认指定的文件目录是否存在已经文件命名的覆盖情况**

**2. 专题标示`label`可在	[数据管理后台](http://test-xsjdata.xoyo.com/data/event/cpanel/task/list) 获取**

**3. 路径中含有特殊符号时请使用单引号包裹，如`tracker create '$$tracker/index.js'`**

## Update

### 0.2.3

* 补充项目标示错误提示信息
* 更新生成文件模版

```javascript
export const config = {
  eventGroup: "maidian_test_20190806",
  name: "埋点测试",
  identify: "xoyo",
  eventTags: ["测试", "移动端"]
};

export default function createTracker(report, getDiffRouteTime) {
    //...
}
```

### 0.2.2

* 生成ES5语法文件

### 0.2.1

* 生成文件新增项目信息
* 查询命令新增校验参数`projectIdentifier`
* 生成路径含有特殊符号时返回警告
* 新增`warn`警告样式

### 0.1.9

* 修复`ev_d`为空无法生成文件的错误
* 增加参数描述


### 0.1.8

* 修复因为彩色打印函数导致的无故报错的bug
* 新增自动创建不存在的指定路径
* 提供可选的自动允许创建目录的参数

### 0.1.7

* 查询方法新增 项目信息`task`等参数

### 0.1.6

* 重构大部分执行逻辑，提高稳定性
* 新增查询埋点状态功能

### 0.1.2

* 优化部分函数结构，增加稳定性
* 使用prettier格式化最终代码，提高可阅读性和可维护性


### 0.1.0

* 完成基础功能开发

## 作者

browniu