README.md
1# JSDoc format
2
3## 简介
4
5此工具可以将 d.ts 声明文件进行格式化处理并输出新的 d.ts 声明文件。
6
7## 使用方法
8
9* 调试阶段
10
11 ```shell
12 npm install
13 ts-node ./src/main.ts -i input.d.ts -o output.d.ts
14 ```
15
16 命令行参数：
17
18 -i：指定需要格式化的 d.ts 文件或者包含 d.ts 文件的目录
19
20 -o：指定新文件的名字或者输出目录
21
22 注意：-i 指定的是文件，则 -o 参数需要指向文件。-i 指定的是目录，-o 参数需要指向目录。
23
24* 打包成 bundle(bundle.js 是可以独立运行的完整工具)
25
26 ```shell
27 npm run build
28 node build/bundle.js -i input.d.ts -o output.d.ts
29 ```
30
31 bundle.js 在 build 目录下，命令行参数与调试阶段一样。
32
33完整的命令行参数可通过 -h 参数获得：
34
35```shell
36Usage: jsdoc-tool [options]
37
38CLI to format d.ts
39
40Options:
41 -V, --version output the version number
42 -i, --input <path> d.ts文件或包含d.ts的文件夹
43 -o, --output <path> 新的d.ts输出文件或目录
44 -l, --logLevel <INFO,WARN,DEBUG,ERR> 日志输出级别[INFO,WARN,DEBUG,ERR] (default: "INFO")
45 -s, --split 是否拆分接口 (default: false)
46 -h, --help display help for command
47```
48
49## 报告
50
51在上述命令成功执行完后，会同时生成一个 .xlsx 报告。可根据报告提示，修改错误。
52
53报告出现在 -i 输入的文件/文件夹的同级目录，命名方式为 文件(夹)名_时间戳.xlsx
54