create-pubinfo 2.2.0-beta.5 → 2.2.1
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,20 +1,61 @@
|
|
|
1
1
|
# create-pubinfo
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[![Monorepo][monorepo-src]][monorepo-href]
|
|
5
|
-
![License][License-src]
|
|
3
|
+
Pubinfo 的项目脚手架，用来生成应用模板、模块模板和 monorepo 模板。
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
## 它在做什么
|
|
6
|
+
|
|
7
|
+
- 提供交互式初始化流程
|
|
8
|
+
- 支持三套本地模板：`pubinfo-app`、`pubinfo-module`、`pubinfo-monorepo`
|
|
9
|
+
- 根据勾选结果裁剪可选模块，目前内置 `rbac`
|
|
10
|
+
- 支持按模板变量渲染 `.hbs` 文件，并复制原始资源文件
|
|
11
|
+
- 初始化完成后自动尝试执行 `git init`
|
|
12
|
+
- 保留一套 `v1` 兼容流程，用远端模板包下载旧版脚手架
|
|
8
13
|
|
|
9
14
|
## 基本用法
|
|
10
15
|
|
|
11
16
|
```bash
|
|
12
|
-
|
|
17
|
+
pnpm create pubinfo
|
|
18
|
+
pnpx create-pubinfo
|
|
19
|
+
npx create-pubinfo
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
运行后会询问：
|
|
23
|
+
|
|
24
|
+
- 目录名称 `dir`
|
|
25
|
+
- 项目标识 `key`
|
|
26
|
+
- 模板类型
|
|
27
|
+
- 是否启用 `rbac`
|
|
28
|
+
- 是否启用 `openapi`
|
|
29
|
+
- 使用 `v1` 还是 `v2`
|
|
30
|
+
|
|
31
|
+
## 模板类型
|
|
32
|
+
|
|
33
|
+
- `pubinfo-app`: 单应用模板
|
|
34
|
+
- `pubinfo-module`: 模块开发模板，带 playground
|
|
35
|
+
- `pubinfo-monorepo`: monorepo 模板
|
|
36
|
+
|
|
37
|
+
## 代码用法
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { generate } from 'create-pubinfo';
|
|
41
|
+
|
|
42
|
+
await generate({
|
|
43
|
+
templateName: 'pubinfo-app',
|
|
44
|
+
key: 'demo',
|
|
45
|
+
version: '2.2.0',
|
|
46
|
+
modules: ['rbac'],
|
|
47
|
+
openapi: false,
|
|
48
|
+
});
|
|
13
49
|
```
|
|
14
50
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
51
|
+
## 主要导出
|
|
52
|
+
|
|
53
|
+
- `generate`: 基于模板生成项目
|
|
54
|
+
- `copyTemplate`: 直接复制模板目录
|
|
55
|
+
- `interaction`: 获取交互式选项
|
|
56
|
+
- `readPackageJSON`: 读取脚手架自身包信息
|
|
57
|
+
|
|
58
|
+
## 仓库关系
|
|
59
|
+
|
|
60
|
+
- 被 `@pubinfo/cli` 的 `generate` 和 `monorepo` 子命令直接复用。
|
|
61
|
+
- `templates/` 目录就是这个包真正的核心资产。
|
package/dist/helper.mjs
CHANGED
|
@@ -196,7 +196,7 @@ async function run(version) {
|
|
|
196
196
|
var package_default = {
|
|
197
197
|
name: "create-pubinfo",
|
|
198
198
|
type: "module",
|
|
199
|
-
version: "2.2.
|
|
199
|
+
version: "2.2.1",
|
|
200
200
|
description: "初始化项目框架",
|
|
201
201
|
author: "Werheng <werheng.zhang@gmail.com>",
|
|
202
202
|
license: "MIT",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-pubinfo",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.2.
|
|
4
|
+
"version": "2.2.1",
|
|
5
5
|
"description": "初始化项目框架",
|
|
6
6
|
"author": "Werheng <werheng.zhang@gmail.com>",
|
|
7
7
|
"license": "MIT",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"ora": "^9.3.0",
|
|
39
39
|
"rimraf": "^6.1.2",
|
|
40
40
|
"semver": "^7.7.4",
|
|
41
|
-
"@pubinfo/shared": "2.2.
|
|
41
|
+
"@pubinfo/shared": "2.2.1"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"@types/node": "^25.2.2"
|