This package has been deprecated

Author message:

deprecate

trello-report-kit

0.0.2 • Public • Published

Trello Report

1. 概述

该脚本是为了从Trello上抓取卡片和项目,并最终根据过期时间进行排序生成报表

2. 使用

2.1 安装

在迁出的脚本根目录执行 npm install . ,等待执行完成。

2.2 配置准备

编辑配置文件 config/config.json

    {
      "DR": {                        // 项目简写,用于运行脚本时确定使用那一套项目配置
        "type": "WR",                // 项目类型,enum('WR', 'DR'), WR:周报,DR:日报
        "name": "niklaus",           // 项目名称,用于生成Excel文件名拼接
        "trello": {
          "key" : "XXX",             // Trello授权Key,可以从`https://trello.com/app-key`获取
          "token" : "XXX",           // Trello授权token,可以从`https://trello.com/app-key`中通过点击`Token`连接,进行授权,然后获得Token,而非app-key页面上的样例
          "username": "XXX"          // Trello拥有者账户名,可以从`https://trello.com/`右上角获取 **昵称(账户名)**,通常是一串英文+数字
        },
        "filter" : {
          "boardName" : ["BoardName"],     // 看板过滤,工具只读取在这里存在的看板数据
          "listNames" : ["checklist1"],    // 列表过滤,工具只读取在这里存在的列表数据
          "labels" : ["labels1"]           // 标签过滤,即执行人,工具只读取在这里存在的标签数据
        },
        "mail": {
          "send": false,              // 是否发送,enum(true, false), true:默认发送,false:默认不发送
          "from": "mail1@163.com",    // 寄件邮箱
          "to": ["mail2@163.com"],    // 收件邮箱
          "setting": "username:password@smtp.exmail.qq.com" //smtp配置,$username:填写帐号(同邮箱),$password:填写邮箱密码
        }
      }
    }

2.2 脚本运行

运行:node index.js 项目简写 指定日期(YYYY-MM-DD) 可以读取指定日期的Trello的Comment 如果未指定日期node index.js 项目简写,则默认按当日时间为指定日期

2.3 输出结果

脚本会在csv文件夹里输出:

  • 报表excel {$项目简写)_{$项目名称}_{YYYYMMDD}.xlsx
  • 范例:
    • 项目简写:WR
    • 项目名称:COMMON_冯洁
    • 报告时间: 20160920
    • 生成Excel名:WR_COMMON_冯洁_2016-09-20.xlsx

2.4 特殊格式

  • 周报-汇报时间:在Checklist的条目中书写如下格式

    • 格式:

      • 清单条目内容 *汇报日期*
    • 范例:

      内网API开发 **2016/09/26**
      
  • 日报-时间调整:在Comment中输入如下格式

    • 格式:

      • 第一行固定为“时间调整”
      • 第二行固定为“修改前时间 => 修改后时间”
      • 第三行固定为“理由”
    • 范例:

      时间调整
      2016/09/21 => 2016/09/26
      Mars完成后端API开发,另外Mars已经将后续计划进行重新分配,并开发前端页面。
      
    • 备注:普通汇报,还是按照正常书写,不需要换行

Readme

Keywords

none

Package Sidebar

Install

npm i trello-report-kit

Weekly Downloads

2

Version

0.0.2

License

MIT

Last publish

Collaborators

  • niklaus0823