# hikit

**Repository Path**: codfisher/hikit

## Basic Information

- **Project Name**: hikit
- **Description**: 将日常用功能制作成node命令行工，当前主要提供以下功能
hkit redmine 从redmine工具中，自动汇总问题分类到execel中
hkit pdf 将当前目录下所有pdf文件合并为一个文档
- **Primary Language**: JavaScript
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-27
- **Last Updated**: 2023-02-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 相关命令说明

1. npm 全局安装
   npm i -g xxx

2. yarn 全局安装
   yarn global add xxx

3. 将当前开发环境链接到，命令行
   npm link 或 yarn link

## 工具介绍

将日常用功能集成到命令行工具中，当前主要提供以下功能

1. hkit redmine 从 redmine 工具中，自动汇总问题分类到 execel 中
2. hkit pdf 将当前目录下所有 pdf 文件合并为一个文档
3. hkit redmine -u <fileName> 将制定目录的 Excel 中问题列表上传至 redmine

## 工具使用步奏

1.  安装 node 步奏省略
2.  配置 node 国内镜像 步奏省略
3.  安装 yarn 步奏省略
4.  全局安装 hkit 工具

```
yarn global add hikit
yarn global remove hikit// 卸载的时候用
```

5. 找到安装包的位置，拿到 hkit.config.json 和 count.xlsx 文件,复制到自己想要的文件夹
   默认文件夹位置 C:\Users\zhang_hao\AppData\Local\Yarn\Data\global\node_modules\hikit

6. 修改 hkit.config.json 中 feedURL 值为实际对应的 URL

7. 在自己 hkit.config.json 和 count.xlsx 文件 所在命令执行如下命令，即可自动汇总数据

```
hkit redmine
```

## hkit redmine -u <fileName> 使用说明
1. 参考/template 中“参数”sheet也进行配置
![配置说明](/doc/redmineConfig1.png)
2. project_id 需要导入项目的ID，可在redmine系统中通过一下方式获取
![](doc/redmineConfig2.png)
![](doc/redmineConfig3.png)
2. apiKey 密钥可以在redmine系统中通过以下方式获取
![](doc/redmineConfig4.png)
3. hostname redmine服务器地址，根据实际情况填写
4. 列号填写需要导入字段所在列，从1开始。
5. “redmine字段”可在redmine系统中问题录入界面通过F12开发控制台获取对应的值。
6. 配置完成后，将问题录入“issues.xlsx”中，在控制台输入hkit redmine -u issues.xlsx 命令即可实现问题导入。