create-aliuq 0.0.0
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 +73 -0
- package/dist/index.mjs +9901 -0
- package/locales/en.json +57 -0
- package/locales/zh.json +57 -0
- package/package.json +44 -0
- package/templates/devcontainer/.devcontainer/devcontainer.json.hbs +6 -0
- package/templates/devcontainer/README.md.hbs +3 -0
- package/templates/web-shadcn/.oxlintrc.json.hbs +12 -0
- package/templates/web-shadcn/README.md.hbs +33 -0
- package/templates/web-shadcn/biome.json.hbs +64 -0
- package/templates/web-shadcn/components.json.hbs +21 -0
- package/templates/web-shadcn/env.d.ts.hbs +7 -0
- package/templates/web-shadcn/eslint.config.mjs.hbs +26 -0
- package/templates/web-shadcn/index.html.hbs +14 -0
- package/templates/web-shadcn/package.json.hbs +55 -0
- package/templates/web-shadcn/public/vite.svg +1 -0
- package/templates/web-shadcn/src/App.vue.hbs +50 -0
- package/templates/web-shadcn/src/assets/vue.svg +1 -0
- package/templates/web-shadcn/src/components/HelloWorld.vue.hbs +80 -0
- package/templates/web-shadcn/src/lib/utils.ts.hbs +7 -0
- package/templates/web-shadcn/src/main.ts.hbs +6 -0
- package/templates/web-shadcn/src/style.css +120 -0
- package/templates/web-shadcn/tsconfig.app.json.hbs +28 -0
- package/templates/web-shadcn/tsconfig.json.hbs +17 -0
- package/templates/web-shadcn/tsconfig.node.json.hbs +26 -0
- package/templates/web-shadcn/vite.config.ts.hbs +25 -0
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# create-aliuq
|
|
2
|
+
|
|
3
|
+
基于 [@clack/prompts](https://github.com/bombshell-dev/clack) 的项目脚手架工具。
|
|
4
|
+
|
|
5
|
+
## 使用
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm create aliuq@latest
|
|
9
|
+
# or
|
|
10
|
+
npx create-aliuq
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 模板
|
|
14
|
+
|
|
15
|
+
### Web
|
|
16
|
+
|
|
17
|
+
Vue 3 + Vite (rolldown-vite) + Tailwind CSS v4 + shadcn-vue 前端项目模板。
|
|
18
|
+
|
|
19
|
+
**可选项：**
|
|
20
|
+
|
|
21
|
+
| 选项 | 说明 |
|
|
22
|
+
|------|------|
|
|
23
|
+
| Lint 工具 | Biome / ESLint / oxlint + oxfmt |
|
|
24
|
+
| Vue Router | 路由管理 |
|
|
25
|
+
| Pinia | 状态管理 |
|
|
26
|
+
|
|
27
|
+
### Dev Container
|
|
28
|
+
|
|
29
|
+
生成 `.devcontainer/devcontainer.json` 配置。
|
|
30
|
+
|
|
31
|
+
**可选项：**
|
|
32
|
+
|
|
33
|
+
| 选项 | 说明 |
|
|
34
|
+
|------|------|
|
|
35
|
+
| 基础镜像 | Ubuntu / Node.js / Python / Universal / 自定义 |
|
|
36
|
+
| Features | Node.js / Python / Docker-in-Docker / GitHub CLI / Git / Common Utils |
|
|
37
|
+
| 转发端口 | 需要转发的端口列表 |
|
|
38
|
+
| postCreateCommand | 容器创建后执行的命令 |
|
|
39
|
+
|
|
40
|
+
## 开发
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install
|
|
44
|
+
npm run dev # 直接运行 CLI（tsx）
|
|
45
|
+
npm run build # 构建（tsdown）
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## 架构
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
src/
|
|
52
|
+
├── index.ts # CLI 入口
|
|
53
|
+
├── types.ts # 核心类型定义
|
|
54
|
+
├── scaffold.ts # 文件脚手架逻辑（复制 + Handlebars 处理）
|
|
55
|
+
└── templates/
|
|
56
|
+
├── index.ts # 模板注册表
|
|
57
|
+
├── web.ts # Web 模板定义
|
|
58
|
+
└── devcontainer.ts # Dev Container 模板定义
|
|
59
|
+
templates/ # 模板文件
|
|
60
|
+
├── web/ # Web 基础模板
|
|
61
|
+
├── web+biome/ # Biome 配置覆盖层
|
|
62
|
+
├── web+eslint/ # ESLint 配置覆盖层
|
|
63
|
+
├── web+oxlint/ # oxlint 配置覆盖层
|
|
64
|
+
├── web+router/ # Vue Router 文件覆盖层
|
|
65
|
+
├── web+pinia/ # Pinia 文件覆盖层
|
|
66
|
+
└── devcontainer/ # Dev Container 模板
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 扩展新模板
|
|
70
|
+
|
|
71
|
+
1. 在 `src/templates/` 中创建模板定义文件，实现 `TemplateDefinition` 接口
|
|
72
|
+
2. 在 `templates/` 中创建对应的模板文件目录
|
|
73
|
+
3. 在 `src/templates/index.ts` 中注册模板
|