@ddd-tool/domain-designer-cli 0.0.0-alpha.11 → 0.0.0-alpha.12

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,6 +1,8 @@
1
- # 使用方法
1
+ # domain-designer-cli
2
2
 
3
- ## 1. 安装依赖
3
+ 目标是作为 ddd 建模生产力工具
4
+
5
+ ## 前置依赖
4
6
 
5
7
  [nodejs](https://nodejs.org/en/download/) >= 18
6
8
 
@@ -8,13 +10,17 @@
8
10
 
9
11
  - 确保有全局的`pnpm`指令
10
12
 
11
- ## 2. 安装本软件
13
+ ## 安装
12
14
 
13
15
  ```bash
14
16
  pnpm i @ddd-tool/domain-designer-cli -g
15
17
  ```
16
18
 
17
- ## 3. 在一个空文件夹中初始化
19
+ ## 使用
20
+
21
+ ### 初始化一个工作空间
22
+
23
+ 在一个空文件夹中执行命令
18
24
 
19
25
  ```bash
20
26
  domain-designer-cli init
@@ -22,23 +28,39 @@ domain-designer-cli init
22
28
 
23
29
  - 初始化后的目录包含如下内容:
24
30
 
25
- - node_modules。为ide提供代码补全的最小.d.ts包,不包含任何实现
31
+ - node_modules。为 ide 提供代码补全的最小.d.ts 包,不包含任何实现
26
32
 
27
33
  - 一个示例 ts 文件。可以快速了解如何使用 ts 代码进行建模
28
34
 
29
- - RunWeb脚本。用于实时查看建模效果
35
+ - RunWeb 脚本。用于实时查看建模效果
30
36
 
31
- ## 4. 编写 ts 文件
37
+ ### 编写 ts 文件
32
38
 
33
39
  - 可以自行创建多个任意名称的 ts 文件
34
40
 
35
- - 多个 ts 文件会被 web 服务识别为多个数据源,可在web页面的设置中切换数据源
41
+ - 多个 ts 文件会被 web 服务识别为多个数据源,可在 web 页面的设置中切换数据源
36
42
 
37
- ## 5. Web 端运行
43
+ ### Web 端运行
38
44
 
39
45
  - 运行自动生成的`RunWeb`脚本文件,即可启动 web 服务
40
46
 
41
- ## 6. 其他说明
47
+ ### 更新版本
48
+
49
+ #### 1、更新软件
50
+
51
+ ```bash
52
+ pnpm i @ddd-tool/domain-designer-cli@latest -g
53
+ ```
54
+
55
+ #### 2、更新工作空间
56
+
57
+ 在已有的工作空间中执行命令
58
+
59
+ ```bash
60
+ domain-designer-cli init
61
+ ```
62
+
63
+ ## 其他说明
42
64
 
43
65
  - 对于每个 ts 文件内的修改,刷新页面即可看到效果
44
66