wanzhuang-cli 1.0.2 → 1.0.4
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 +113 -113
- package/dist/index.js +2 -1
- package/package.json +1 -1
- package/src/index.ts +2 -1
package/README.md
CHANGED
|
@@ -1,113 +1,113 @@
|
|
|
1
|
-
# wanzhuang-cli
|
|
2
|
-
|
|
3
|
-
万桩项目脚手架工具,支持 React、Vue、UniApp 项目模板。
|
|
4
|
-
|
|
5
|
-
## 特性
|
|
6
|
-
|
|
7
|
-
- 快速创建 React/Vue/UniApp 项目
|
|
8
|
-
- 基于 Vite 构建,开发体验极佳
|
|
9
|
-
- TypeScript 支持
|
|
10
|
-
- ESLint 代码规范
|
|
11
|
-
- API 生成器(基于 Swagger/OpenAPI)
|
|
12
|
-
- 一键更新项目依赖
|
|
13
|
-
|
|
14
|
-
## 安装
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
# 使用 pnpm 安装(推荐)
|
|
18
|
-
pnpm add -g wanzhuang-cli
|
|
19
|
-
|
|
20
|
-
# 或使用 npm 安装
|
|
21
|
-
npm install -g wanzhuang-cli
|
|
22
|
-
|
|
23
|
-
# 或使用 yarn 安装
|
|
24
|
-
yarn global add wanzhuang-cli
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## 使用指南
|
|
28
|
-
|
|
29
|
-
### 创建项目
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
# 创建项目
|
|
33
|
-
wz create my-project
|
|
34
|
-
|
|
35
|
-
# 指定模板类型
|
|
36
|
-
wz create my-project -t vue
|
|
37
|
-
wz create my-project -t react
|
|
38
|
-
wz create my-project -t uniapp
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### 生成 API
|
|
42
|
-
|
|
43
|
-
基于 Swagger/OpenAPI 规范自动生成 TypeScript API 代码(使用 @hey-api/openapi-ts):
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
# 默认生成到 src/api 目录
|
|
47
|
-
wz api http://221.195.14.250:8011/swagger/v1/swagger.json
|
|
48
|
-
|
|
49
|
-
# 指定输出目录
|
|
50
|
-
wz api http://221.195.14.250:8011/swagger/v1/swagger.json -o ./src/services
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
生成的 API 包含:
|
|
54
|
-
|
|
55
|
-
- TypeScript 类型定义
|
|
56
|
-
- SDK 函数
|
|
57
|
-
- JSON Schema 验证
|
|
58
|
-
|
|
59
|
-
### 更新依赖
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
wz update
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## 项目模板
|
|
66
|
-
|
|
67
|
-
### React 模板
|
|
68
|
-
|
|
69
|
-
| 技术栈 | 版本 |
|
|
70
|
-
| ------ | ------- |
|
|
71
|
-
| React | ^19.1.0 |
|
|
72
|
-
| Vite | ^6.3.5 |
|
|
73
|
-
|
|
74
|
-
### Vue 模板
|
|
75
|
-
|
|
76
|
-
| 技术栈 | 版本 |
|
|
77
|
-
| ------ | ------- |
|
|
78
|
-
| Vue | ^3.5.13 |
|
|
79
|
-
| Vite | ^6.3.5 |
|
|
80
|
-
|
|
81
|
-
### UniApp 模板
|
|
82
|
-
|
|
83
|
-
跨平台开发框架,支持编译到多端:
|
|
84
|
-
|
|
85
|
-
| 技术栈 | 版本 |
|
|
86
|
-
| ------ | ------- |
|
|
87
|
-
| Vue | ^3.4.21 |
|
|
88
|
-
| Vite | 5.2.8 |
|
|
89
|
-
|
|
90
|
-
支持平台:
|
|
91
|
-
|
|
92
|
-
| 平台 | 命令 |
|
|
93
|
-
| ------------ | -------------------- |
|
|
94
|
-
| H5 | `pnpm dev:h5` |
|
|
95
|
-
| 微信小程序 | `pnpm dev:mp-weixin` |
|
|
96
|
-
| 支付宝小程序 | `pnpm dev:mp-alipay` |
|
|
97
|
-
|
|
98
|
-
## 命令一览
|
|
99
|
-
|
|
100
|
-
| 命令 | 说明 | 选项 |
|
|
101
|
-
| ------------------ | ---------- | --------------------------------------------------- |
|
|
102
|
-
| `wz create <name>` | 创建新项目 | `-t, --template` 模板类型<br>`-f, --force` 强制覆盖 |
|
|
103
|
-
| `wz api <url>` | 生成 API | `-o, --output` 输出目录 |
|
|
104
|
-
| `wz update` | 更新依赖 | - |
|
|
105
|
-
|
|
106
|
-
## 环境要求
|
|
107
|
-
|
|
108
|
-
| 项目 | Node.js 版本 |
|
|
109
|
-
| ----------- | ------------ |
|
|
110
|
-
| CLI 工具 | >= 14.0.0 |
|
|
111
|
-
| React 模板 | >= 18.0.0 |
|
|
112
|
-
| Vue 模板 | >= 18.0.0 |
|
|
113
|
-
| UniApp 模板 | >= 18.0.0 |
|
|
1
|
+
# wanzhuang-cli
|
|
2
|
+
|
|
3
|
+
万桩项目脚手架工具,支持 React、Vue、UniApp 项目模板。
|
|
4
|
+
|
|
5
|
+
## 特性
|
|
6
|
+
|
|
7
|
+
- 快速创建 React/Vue/UniApp 项目
|
|
8
|
+
- 基于 Vite 构建,开发体验极佳
|
|
9
|
+
- TypeScript 支持
|
|
10
|
+
- ESLint 代码规范
|
|
11
|
+
- API 生成器(基于 Swagger/OpenAPI)
|
|
12
|
+
- 一键更新项目依赖
|
|
13
|
+
|
|
14
|
+
## 安装
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# 使用 pnpm 安装(推荐)
|
|
18
|
+
pnpm add -g wanzhuang-cli
|
|
19
|
+
|
|
20
|
+
# 或使用 npm 安装
|
|
21
|
+
npm install -g wanzhuang-cli
|
|
22
|
+
|
|
23
|
+
# 或使用 yarn 安装
|
|
24
|
+
yarn global add wanzhuang-cli
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 使用指南
|
|
28
|
+
|
|
29
|
+
### 创建项目
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 创建项目
|
|
33
|
+
wz create my-project
|
|
34
|
+
|
|
35
|
+
# 指定模板类型
|
|
36
|
+
wz create my-project -t vue
|
|
37
|
+
wz create my-project -t react
|
|
38
|
+
wz create my-project -t uniapp
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 生成 API
|
|
42
|
+
|
|
43
|
+
基于 Swagger/OpenAPI 规范自动生成 TypeScript API 代码(使用 @hey-api/openapi-ts):
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# 默认生成到 src/api 目录
|
|
47
|
+
wz api http://221.195.14.250:8011/swagger/v1/swagger.json
|
|
48
|
+
|
|
49
|
+
# 指定输出目录
|
|
50
|
+
wz api http://221.195.14.250:8011/swagger/v1/swagger.json -o ./src/services
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
生成的 API 包含:
|
|
54
|
+
|
|
55
|
+
- TypeScript 类型定义
|
|
56
|
+
- SDK 函数
|
|
57
|
+
- JSON Schema 验证
|
|
58
|
+
|
|
59
|
+
### 更新依赖
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
wz update
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## 项目模板
|
|
66
|
+
|
|
67
|
+
### React 模板
|
|
68
|
+
|
|
69
|
+
| 技术栈 | 版本 |
|
|
70
|
+
| ------ | ------- |
|
|
71
|
+
| React | ^19.1.0 |
|
|
72
|
+
| Vite | ^6.3.5 |
|
|
73
|
+
|
|
74
|
+
### Vue 模板
|
|
75
|
+
|
|
76
|
+
| 技术栈 | 版本 |
|
|
77
|
+
| ------ | ------- |
|
|
78
|
+
| Vue | ^3.5.13 |
|
|
79
|
+
| Vite | ^6.3.5 |
|
|
80
|
+
|
|
81
|
+
### UniApp 模板
|
|
82
|
+
|
|
83
|
+
跨平台开发框架,支持编译到多端:
|
|
84
|
+
|
|
85
|
+
| 技术栈 | 版本 |
|
|
86
|
+
| ------ | ------- |
|
|
87
|
+
| Vue | ^3.4.21 |
|
|
88
|
+
| Vite | 5.2.8 |
|
|
89
|
+
|
|
90
|
+
支持平台:
|
|
91
|
+
|
|
92
|
+
| 平台 | 命令 |
|
|
93
|
+
| ------------ | -------------------- |
|
|
94
|
+
| H5 | `pnpm dev:h5` |
|
|
95
|
+
| 微信小程序 | `pnpm dev:mp-weixin` |
|
|
96
|
+
| 支付宝小程序 | `pnpm dev:mp-alipay` |
|
|
97
|
+
|
|
98
|
+
## 命令一览
|
|
99
|
+
|
|
100
|
+
| 命令 | 说明 | 选项 |
|
|
101
|
+
| ------------------ | ---------- | --------------------------------------------------- |
|
|
102
|
+
| `wz create <name>` | 创建新项目 | `-t, --template` 模板类型<br>`-f, --force` 强制覆盖 |
|
|
103
|
+
| `wz api <url>` | 生成 API | `-o, --output` 输出目录 |
|
|
104
|
+
| `wz update` | 更新依赖 | - |
|
|
105
|
+
|
|
106
|
+
## 环境要求
|
|
107
|
+
|
|
108
|
+
| 项目 | Node.js 版本 |
|
|
109
|
+
| ----------- | ------------ |
|
|
110
|
+
| CLI 工具 | >= 14.0.0 |
|
|
111
|
+
| React 模板 | >= 18.0.0 |
|
|
112
|
+
| Vue 模板 | >= 18.0.0 |
|
|
113
|
+
| UniApp 模板 | >= 18.0.0 |
|
package/dist/index.js
CHANGED
|
@@ -13,10 +13,11 @@ commander_1.program.name('wz').description('万桩项目脚手架工具').versio
|
|
|
13
13
|
commander_1.program
|
|
14
14
|
.command('create <name>')
|
|
15
15
|
.description('创建新项目')
|
|
16
|
-
.option('-t, --template <template>', '项目模板 (react、vue 或 uniapp)'
|
|
16
|
+
.option('-t, --template <template>', '项目模板 (react、vue 或 uniapp)')
|
|
17
17
|
.option('-f, --force', '强制覆盖已存在的目录')
|
|
18
18
|
.action(async (name, options) => {
|
|
19
19
|
try {
|
|
20
|
+
console.log('接收到的参数:', { name, options });
|
|
20
21
|
await (0, create_1.createProject)(name, options);
|
|
21
22
|
}
|
|
22
23
|
catch (error) {
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -15,10 +15,11 @@ program.name('wz').description('万桩项目脚手架工具').version(packageJso
|
|
|
15
15
|
program
|
|
16
16
|
.command('create <name>')
|
|
17
17
|
.description('创建新项目')
|
|
18
|
-
.option('-t, --template <template>', '项目模板 (react、vue 或 uniapp)'
|
|
18
|
+
.option('-t, --template <template>', '项目模板 (react、vue 或 uniapp)')
|
|
19
19
|
.option('-f, --force', '强制覆盖已存在的目录')
|
|
20
20
|
.action(async (name, options) => {
|
|
21
21
|
try {
|
|
22
|
+
console.log('接收到的参数:', { name, options });
|
|
22
23
|
await createProject(name, options);
|
|
23
24
|
} catch (error) {
|
|
24
25
|
console.error('创建项目失败:', error);
|