td-web-cli 0.1.11 → 0.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +132 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# 项目名称
|
|
2
|
+
|
|
3
|
+
一个基于 node.js 和 typeScript 的高效 cli 工具，用于提升工作效率。
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 目录
|
|
8
|
+
|
|
9
|
+
- [环境要求](#环境要求)
|
|
10
|
+
- [安装](#安装)
|
|
11
|
+
- [开发](#开发)
|
|
12
|
+
- [使用](#使用)
|
|
13
|
+
- [构建](#构建)
|
|
14
|
+
- [发布](#发布)
|
|
15
|
+
- [项目结构](#项目结构)
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 环境要求
|
|
20
|
+
|
|
21
|
+
- node.js >= 20.x（推荐使用 22.x 或更高版本）
|
|
22
|
+
- npm >= 10.x
|
|
23
|
+
- typeScript >= 5.x
|
|
24
|
+
|
|
25
|
+
> **注意**：部分依赖可能要求 node.js 20 及以上版本，请根据实际情况调整。
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 安装
|
|
30
|
+
|
|
31
|
+
1. 克隆仓库
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
git clone <仓库地址>
|
|
35
|
+
cd your-project
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
2. 安装依赖
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm install
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 开发
|
|
47
|
+
|
|
48
|
+
### 代码结构
|
|
49
|
+
|
|
50
|
+
- `src/` - typeScript 源代码目录
|
|
51
|
+
- `dist/` - 编译后的 javaScript 输出目录
|
|
52
|
+
- `release.js` - 发布脚本（可直接运行或编译后运行）
|
|
53
|
+
|
|
54
|
+
### 运行开发环境
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npm run build
|
|
58
|
+
npm link
|
|
59
|
+
td-web-cli # 确保本机未全局安装该工具
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
通过 `npm link`，本地调试 cli 命令 `td-web-cli`。
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 使用
|
|
67
|
+
|
|
68
|
+
### 命令行执行
|
|
69
|
+
|
|
70
|
+
执行 cli 工具：
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
td-web-cli
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 功能说明
|
|
77
|
+
|
|
78
|
+
- 将 excel 表格转换为对应的 json 文件，简化数据处理流程。
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 构建
|
|
83
|
+
|
|
84
|
+
使用 typeScript 编译项目：
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm run build
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
编译后的代码默认输出到 `dist/` 目录。
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 发布
|
|
95
|
+
|
|
96
|
+
通过自动化脚本完成发布流程：
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
npm run release
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
该命令将依次执行：
|
|
103
|
+
|
|
104
|
+
- 版本号更新
|
|
105
|
+
- 依赖安装
|
|
106
|
+
- 项目构建
|
|
107
|
+
- 发布到 npm
|
|
108
|
+
- 提交并推送 git 代码
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 项目结构
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
.
|
|
116
|
+
├── src/ # typeScript 源代码
|
|
117
|
+
│ └── index.ts # 入口文件
|
|
118
|
+
├── dist/ # 编译输出目录
|
|
119
|
+
├── release.js # 发布脚本
|
|
120
|
+
├── setting.json # 配置文件
|
|
121
|
+
├── package.json # 项目配置
|
|
122
|
+
├── tsconfig.json # typeScript 配置
|
|
123
|
+
├── README.md # 项目说明文件
|
|
124
|
+
├── .gitignore # git 忽略文件
|
|
125
|
+
├── .prettierignore # prettier 忽略文件
|
|
126
|
+
├── .prettierrc # prettier 配置文件
|
|
127
|
+
└── package-lock.json # 依赖锁定文件
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
感谢您使用本项目！如有任何问题或建议，欢迎反馈与贡献。
|