@ysjdemo/umi-create-cli 0.0.1 → 0.0.2
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
CHANGED
|
@@ -1,117 +1,61 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @ysjdemo/umi-create-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
一个用于创建Umi4项目的脚手架工具
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 安装
|
|
6
6
|
|
|
7
|
-
- 🚀 快速创建 Umi 4 项目
|
|
8
|
-
- 🎨 提供多种项目模板
|
|
9
|
-
- 📦 自动配置常用依赖和配置
|
|
10
|
-
- 💻 支持 TypeScript
|
|
11
|
-
- 🔧 预配置 ESLint 和 Prettier
|
|
12
|
-
|
|
13
|
-
## 📦 安装
|
|
14
|
-
|
|
15
|
-
### 全局安装
|
|
16
7
|
```bash
|
|
17
|
-
|
|
18
|
-
|
|
8
|
+
# 全局安装
|
|
9
|
+
npm install -g @ysjdemo/umi-create-cli
|
|
19
10
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
npx @cfmm/umi-create-cli create my-project
|
|
11
|
+
# 或使用 yarn
|
|
12
|
+
yarn global add @ysjdemo/umi-create-cli
|
|
23
13
|
```
|
|
24
14
|
|
|
25
|
-
##
|
|
15
|
+
## 使用
|
|
26
16
|
|
|
27
|
-
### 创建新项目
|
|
28
17
|
```bash
|
|
29
|
-
#
|
|
18
|
+
# 创建新项目
|
|
30
19
|
ysj-umi create my-project
|
|
31
20
|
|
|
32
|
-
#
|
|
33
|
-
ysj-umi create my-project -t antd
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### 在当前目录初始化
|
|
37
|
-
```bash
|
|
38
|
-
# 在当前目录初始化项目
|
|
39
|
-
ysj-umi init
|
|
40
|
-
|
|
41
|
-
# 指定模板类型
|
|
42
|
-
ysj-umi init -t antd
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### 查看帮助
|
|
46
|
-
```bash
|
|
21
|
+
# 查看帮助
|
|
47
22
|
ysj-umi --help
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## 📋 可用模板
|
|
51
|
-
|
|
52
|
-
### 1. basic - 基础模板
|
|
53
|
-
- ✅ Umi 4 基础配置
|
|
54
|
-
- ✅ React 18 + TypeScript
|
|
55
|
-
- ✅ 基础路由配置
|
|
56
|
-
- ✅ 简单的页面示例
|
|
57
23
|
|
|
58
|
-
|
|
59
|
-
-
|
|
60
|
-
|
|
61
|
-
- ✅ 完整的后台管理界面
|
|
62
|
-
- ✅ 仪表盘、用户管理、设置页面
|
|
63
|
-
- ✅ 表格、表单等常用功能
|
|
24
|
+
# 查看版本
|
|
25
|
+
ysj-umi --version
|
|
26
|
+
```
|
|
64
27
|
|
|
65
|
-
##
|
|
28
|
+
## 特性
|
|
66
29
|
|
|
67
|
-
|
|
30
|
+
- 🚀 快速创建Umi4项目
|
|
31
|
+
- 📦 内置常用配置模板
|
|
32
|
+
- 🎨 支持TypeScript
|
|
33
|
+
- 📱 支持多种UI库选择
|
|
68
34
|
|
|
69
|
-
|
|
70
|
-
my-project/
|
|
71
|
-
├── src/
|
|
72
|
-
│ ├── components/ # 通用组件
|
|
73
|
-
│ ├── pages/ # 页面组件
|
|
74
|
-
│ ├── services/ # API 服务
|
|
75
|
-
│ └── utils/ # 工具函数
|
|
76
|
-
├── .umirc.ts # Umi 配置文件
|
|
77
|
-
├── .gitignore # Git 忽略文件
|
|
78
|
-
├── .prettierrc # Prettier 配置
|
|
79
|
-
├── tsconfig.json # TypeScript 配置
|
|
80
|
-
├── package.json # 项目依赖
|
|
81
|
-
└── README.md # 项目说明
|
|
82
|
-
```
|
|
35
|
+
## 模板选项
|
|
83
36
|
|
|
84
|
-
|
|
37
|
+
- 基础模板:包含基本的Umi4配置
|
|
38
|
+
- TypeScript模板:包含TypeScript配置
|
|
39
|
+
- Ant Design模板:集成Ant Design组件库
|
|
40
|
+
- 移动端模板:适配移动端开发
|
|
85
41
|
|
|
86
|
-
|
|
42
|
+
## 开发
|
|
87
43
|
|
|
88
44
|
```bash
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
```
|
|
45
|
+
# 克隆项目
|
|
46
|
+
git clone https://github.com/yourusername/ysj-cli.git
|
|
92
47
|
|
|
93
|
-
|
|
48
|
+
# 安装依赖
|
|
49
|
+
npm install
|
|
94
50
|
|
|
95
|
-
|
|
51
|
+
# 本地开发测试
|
|
96
52
|
npm start
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
构建生产版本:
|
|
100
53
|
|
|
101
|
-
|
|
102
|
-
npm
|
|
54
|
+
# 发布新版本
|
|
55
|
+
npm version patch
|
|
56
|
+
git push origin --tags
|
|
103
57
|
```
|
|
104
58
|
|
|
105
|
-
##
|
|
106
|
-
|
|
107
|
-
- [Umi 4 官方文档](https://umijs.org/)
|
|
108
|
-
- [Ant Design 文档](https://ant.design/)
|
|
109
|
-
- [Pro Components 文档](https://procomponents.ant.design/)
|
|
110
|
-
|
|
111
|
-
## 🤝 贡献
|
|
112
|
-
|
|
113
|
-
欢迎提交 Issue 和 Pull Request!
|
|
114
|
-
|
|
115
|
-
## 📄 许可证
|
|
59
|
+
## License
|
|
116
60
|
|
|
117
|
-
|
|
61
|
+
MIT
|
|
@@ -1,65 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Umi 4 + Ant Design Pro 项目
|
|
2
2
|
|
|
3
|
-
这是一个使用
|
|
4
|
-
|
|
5
|
-
## 特性
|
|
6
|
-
|
|
7
|
-
- 🚀 基于 Umi 4 和 Ant Design 5
|
|
8
|
-
- 📦 开箱即用的 Pro Components
|
|
9
|
-
- 🎨 美观的管理后台界面
|
|
10
|
-
- 📱 响应式设计
|
|
11
|
-
- 🔐 内置权限管理
|
|
12
|
-
- 📈 丰富的图表组件
|
|
3
|
+
这是一个使用 @ysjdemo/umi-create-cli 脚手架创建的 Umi 4 + Ant Design Pro 项目。
|
|
13
4
|
|
|
14
5
|
## 开始使用
|
|
15
6
|
|
|
16
|
-
### 安装依赖
|
|
17
|
-
|
|
18
7
|
```bash
|
|
8
|
+
# 安装依赖
|
|
19
9
|
npm install
|
|
20
|
-
# 或
|
|
21
|
-
yarn
|
|
22
|
-
```
|
|
23
10
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
```bash
|
|
11
|
+
# 启动开发服务器
|
|
27
12
|
npm start
|
|
28
|
-
# 或
|
|
29
|
-
yarn start
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### 构建生产版本
|
|
33
13
|
|
|
34
|
-
|
|
14
|
+
# 构建生产版本
|
|
35
15
|
npm run build
|
|
36
|
-
# 或
|
|
37
|
-
yarn build
|
|
38
16
|
```
|
|
39
17
|
|
|
40
|
-
##
|
|
18
|
+
## 功能特性
|
|
41
19
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
│ ├── services/ # API 服务
|
|
50
|
-
│ └── utils/ # 工具函数
|
|
51
|
-
├── .umirc.ts # Umi 配置文件
|
|
52
|
-
└── package.json
|
|
53
|
-
```
|
|
20
|
+
- ⚡️ Umi 4 - 现代化的前端框架
|
|
21
|
+
- 🎨 Ant Design 5.0 - 企业级 UI 设计语言
|
|
22
|
+
- 📦 Pro Components - 丰富的业务组件
|
|
23
|
+
- 🛡️ TypeScript - 静态类型检查
|
|
24
|
+
- 📱 响应式设计 - 适配不同终端
|
|
25
|
+
|
|
26
|
+
## 已集成功能
|
|
54
27
|
|
|
55
|
-
|
|
28
|
+
- 📊 仪表盘页面
|
|
29
|
+
- 👥 用户管理
|
|
30
|
+
- 📋 表格列表
|
|
31
|
+
- 📝 表单页面
|
|
32
|
+
- ⚙️ 设置页面
|
|
56
33
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
34
|
+
## 目录结构
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
src/
|
|
38
|
+
├── components/ # 业务组件
|
|
39
|
+
├── pages/ # 页面组件
|
|
40
|
+
├── services/ # API 服务
|
|
41
|
+
├── utils/ # 工具函数
|
|
42
|
+
└── models/ # 数据模型
|
|
43
|
+
```
|
|
60
44
|
|
|
61
|
-
##
|
|
45
|
+
## 了解更多
|
|
62
46
|
|
|
63
|
-
- [Umi
|
|
47
|
+
- [Umi 官方文档](https://umijs.org/)
|
|
64
48
|
- [Ant Design 文档](https://ant.design/)
|
|
65
49
|
- [Pro Components 文档](https://procomponents.ant.design/)
|
|
@@ -1,46 +1,38 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Umi 4 项目
|
|
2
2
|
|
|
3
|
-
这是一个使用
|
|
3
|
+
这是一个使用 @ysjdemo/umi-create-cli 脚手架创建的 Umi 4 项目。
|
|
4
4
|
|
|
5
5
|
## 开始使用
|
|
6
6
|
|
|
7
|
-
### 安装依赖
|
|
8
|
-
|
|
9
7
|
```bash
|
|
8
|
+
# 安装依赖
|
|
10
9
|
npm install
|
|
11
|
-
# 或
|
|
12
|
-
yarn
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### 启动开发服务器
|
|
16
10
|
|
|
17
|
-
|
|
11
|
+
# 启动开发服务器
|
|
18
12
|
npm start
|
|
19
|
-
# 或
|
|
20
|
-
yarn start
|
|
21
|
-
```
|
|
22
13
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```bash
|
|
14
|
+
# 构建生产版本
|
|
26
15
|
npm run build
|
|
27
|
-
# 或
|
|
28
|
-
yarn build
|
|
29
16
|
```
|
|
30
17
|
|
|
31
|
-
##
|
|
18
|
+
## 功能特性
|
|
19
|
+
|
|
20
|
+
- ⚡️ Umi 4 - 现代化的前端框架
|
|
21
|
+
- 📦 开箱即用的配置
|
|
22
|
+
- 🎨 TypeScript 支持
|
|
23
|
+
- 📱 响应式设计
|
|
24
|
+
|
|
25
|
+
## 目录结构
|
|
32
26
|
|
|
33
27
|
```
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
├── .umirc.ts # Umi 配置文件
|
|
40
|
-
└── package.json
|
|
28
|
+
src/
|
|
29
|
+
├── components/ # 组件目录
|
|
30
|
+
├── pages/ # 页面目录
|
|
31
|
+
├── services/ # 服务层
|
|
32
|
+
└── utils/ # 工具函数
|
|
41
33
|
```
|
|
42
34
|
|
|
43
|
-
##
|
|
35
|
+
## 了解更多
|
|
44
36
|
|
|
45
|
-
- [Umi
|
|
46
|
-
- [
|
|
37
|
+
- [Umi 官方文档](https://umijs.org/)
|
|
38
|
+
- [React 官方文档](https://reactjs.org/)
|
|
@@ -1,22 +1,38 @@
|
|
|
1
|
-
import { PageContainer } from '@ant-design/pro-components';
|
|
2
|
-
import { Card, Typography } from 'antd';
|
|
3
1
|
import React from 'react';
|
|
4
|
-
|
|
5
|
-
const { Title, Paragraph } = Typography;
|
|
2
|
+
import styles from './index.less';
|
|
6
3
|
|
|
7
4
|
const HomePage: React.FC = () => {
|
|
8
5
|
return (
|
|
9
|
-
<
|
|
10
|
-
<
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
6
|
+
<div className={styles.container}>
|
|
7
|
+
<h1 className={styles.title}>
|
|
8
|
+
欢迎使用 Umi 4 项目
|
|
9
|
+
</h1>
|
|
10
|
+
<p className={styles.description}>
|
|
11
|
+
这是一个使用 @ysjdemo/umi-create-cli 脚手架创建的基础 Umi 4 项目。
|
|
12
|
+
</p>
|
|
13
|
+
<div className={styles.features}>
|
|
14
|
+
<div className={styles.feature}>
|
|
15
|
+
<h3>🚀 现代化</h3>
|
|
16
|
+
<p>基于最新的 Umi 4 框架构建</p>
|
|
17
|
+
</div>
|
|
18
|
+
<div className={styles.feature}>
|
|
19
|
+
<h3>📦 开箱即用</h3>
|
|
20
|
+
<p>预配置了常用的开发工具</p>
|
|
21
|
+
</div>
|
|
22
|
+
<div className={styles.feature}>
|
|
23
|
+
<h3>🎨 TypeScript</h3>
|
|
24
|
+
<p>完整的 TypeScript 支持</p>
|
|
25
|
+
</div>
|
|
26
|
+
</div>
|
|
27
|
+
<div className={styles.actions}>
|
|
28
|
+
<a href="https://umijs.org/" target="_blank" rel="noopener noreferrer">
|
|
29
|
+
查看 Umi 文档
|
|
30
|
+
</a>
|
|
31
|
+
<a href="https://github.com/yourusername/ysj-cli" target="_blank" rel="noopener noreferrer">
|
|
32
|
+
GitHub 仓库
|
|
33
|
+
</a>
|
|
34
|
+
</div>
|
|
35
|
+
</div>
|
|
20
36
|
);
|
|
21
37
|
};
|
|
22
38
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ysjdemo/umi-create-cli",
|
|
3
3
|
"author": "ysj <411367308@qq.com>",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.2",
|
|
5
5
|
"description": "一个用于创建Umi4项目的脚手架工具",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|
|
@@ -29,12 +29,12 @@
|
|
|
29
29
|
"license": "MIT",
|
|
30
30
|
"repository": {
|
|
31
31
|
"type": "git",
|
|
32
|
-
"url": "https://github.com/
|
|
32
|
+
"url": "https://github.com/Ivan-YangSj/umi-cli.git"
|
|
33
33
|
},
|
|
34
34
|
"bugs": {
|
|
35
|
-
"url": "https://github.com/
|
|
35
|
+
"url": "https://github.com/Ivan-YangSj/umi-cli/issues"
|
|
36
36
|
},
|
|
37
|
-
"homepage": "https://github.com/
|
|
37
|
+
"homepage": "https://github.com/Ivan-YangSj/umi-cli#readme",
|
|
38
38
|
"publishConfig": {
|
|
39
39
|
"access": "public"
|
|
40
40
|
},
|