create-pubinfo 2.0.0-rc.4 → 2.0.0-rc.5

package/dist/index.js

@@ -1,30 +1,32 @@
 #!/usr/bin/env node
+import { checkbox, confirm, input, select } from "@inquirer/prompts";
 import { Command } from "commander";
 import consola from "consola";
 import fs, { existsSync, readFileSync, readdirSync, renameSync, writeFileSync } from "node:fs";
 import { dirname, resolve } from "node:path";
 import process, { cwd } from "node:process";
 import { fileURLToPath } from "node:url";
-import { readFile, writeFile } from "node:fs/promises";
-import { parseJSON, parseJSONC, stringifyJSON } from "confbox";
-import { checkbox, confirm, input, select } from "@inquirer/prompts";
 import colors from "ansi-colors";
-import { ofetch } from "ofetch";
-import ora from "ora";
-import { coerce, compare } from "semver";
+import nodePlop from "node-plop";
 import fonts from "cfonts";
 import { downloadTemplate } from "giget";
+import ora from "ora";
+import { coerce, compare } from "semver";
+import { ofetch } from "ofetch";
 import { rimrafSync } from "rimraf";
+import { readFile, writeFile } from "node:fs/promises";
+import { parseJSON, parseJSONC, stringifyJSON } from "confbox";
 
 //#region package.json
 var name = "create-pubinfo";
 var type = "module";
-var version = "2.0.0-rc.4";
+var version = "2.0.0-rc.5";
 var description = "初始化项目框架";
 var author = "Werheng <werheng.zhang@gmail.com>";
 var license = "MIT";
 var bin = { "pubinfo": "./dist/index.js" };
 var files = ["dist", "templates"];
+var engines = { "node": "^20.19.0 || >=22.12.0" };
 var scripts = {
 	"dev": "tsdown --watch src",
 	"build": "tsdown",
@@ -40,6 +42,7 @@ var dependencies = {
 	"confbox": "catalog:node",
 	"consola": "catalog:browser",
 	"giget": "catalog:node",
+	"node-plop": "catalog:node",
 	"ofetch": "catalog:http",
 	"ora": "catalog:node",
 	"rimraf": "catalog:node",
@@ -55,6 +58,7 @@ var package_default = {
 	license,
 	bin,
 	files,
+	engines,
 	scripts,
 	dependencies,
 	devDependencies
@@ -62,126 +66,11 @@ var package_default = {
 
 //#endregion
 //#region src/utils.ts
-/**
-* 重写文件内容
-*/
-function rewriteFile(path, fn) {
-	if (!existsSync(path)) {
-		consola.error(`RewriteFile fail: ${path} does not exist`);
-		return;
-	}
-	try {
-		const content = readFileSync(path, { encoding: "utf-8" });
-		writeFileSync(path, fn(content));
-	} catch (error) {
-		consola.error(`RewriteFile fail: ${error}`);
-	}
-}
-function copyDir(srcDir, destDir) {
-	fs.mkdirSync(destDir, { recursive: true });
-	for (const file of fs.readdirSync(srcDir)) {
-		const srcFile = resolve(srcDir, file);
-		const destFile = resolve(destDir, file);
-		copy(srcFile, destFile);
-	}
-}
-function copy(src, dest) {
-	if (fs.statSync(src).isDirectory()) copyDir(src, dest);
-	else fs.copyFileSync(src, dest);
-}
-async function readJSON(path) {
-	const blob = await readFile(path, "utf-8");
-	let parsed;
-	try {
-		parsed = parseJSON(blob);
-	} catch {
-		parsed = parseJSONC(blob);
-	}
-	return parsed;
-}
-async function writeJSON(path, json) {
-	await writeFile(path, stringifyJSON(json));
-}
-function assignValues(target, source) {
-	for (const [key, value] of Object.entries(source)) target[key] = value;
-}
 function validateInput(input$1) {
 	if (/[<>:"/\\|?*\s]/.test(input$1)) return "错误提示: 该值不能包含空格或者非法字符 (例如, <>:\"/\\|?*).";
 	return true;
 }
 
-//#endregion
-//#region src/core/generate.ts
-const __dirname = dirname(fileURLToPath(import.meta.url));
-function generate(options, version$1) {
-	const root = cwd();
-	const templateDir = resolve(__dirname, "../templates", `pubinfo-template`);
-	const targetPath = resolve(root, options.dir);
-	copy(templateDir, targetPath);
-	rewriteFile(resolve(targetPath, "src/settings.ts"), (content) => {
-		return content.replace(/storagePrefix:\s*'([^']*)'/g, `storagePrefix: '${options.key}'`);
-	});
-	rewriteFile(resolve(targetPath, "openapi.config.ts"), (content) => {
-		return content.replace(/enabled:[^,]+,/g, `enabled: ${options.openapi},`);
-	});
-	rewriteFile(resolve(targetPath, "package.json"), (content) => {
-		return content.replace(/"(@?pubinfo(?:\/module-(?:auth|rbac))?)":\s*"[^"]+"/g, (_match, pkgName) => {
-			return `"${pkgName}": "${version$1}"`;
-		});
-	});
-	const renameFiles = {
-		_gitignore: ".gitignore",
-		_npmrc: ".npmrc"
-	};
-	for (const [oldName, newName] of Object.entries(renameFiles)) {
-		const oldPath = resolve(targetPath, oldName);
-		const newPath = resolve(targetPath, newName || oldName);
-		renameSync(oldPath, newPath);
-	}
-}
-
-//#endregion
-//#region src/v1/constant.ts
-const REMOTE_URL = "http://106.53.74.49:20000/templates";
-const PKG_NAME = "monorepo-project-template";
-const VERSION_FILE = "version.json";
-const SETTING_FILE_PATH = "src/settings.default.ts";
-const OPENAPI_FILE_PATH = "openapi.config.ts";
-const APPS_DIR = "apps";
-const APPS = [{
-	name: "用户权限系统（rbac）",
-	value: "rbac"
-}];
-const METADATA_DIR = "configs/metadata";
-const META_FILENAME = "pubinfo.json";
-
-//#endregion
-//#region src/v1/fetch.ts
-async function fetchVersion() {
-	const versions = await ofetch(`${REMOTE_URL}/${VERSION_FILE}`);
-	versions.sort((v1, v2) => -compare(v1, v2));
-	return {
-		latest: versions[0],
-		list: versions
-	};
-}
-async function fetchData() {
-	const spinner = ora({
-		text: "检测网络连接...",
-		color: "blue"
-	});
-	spinner.start();
-	try {
-		return { version: await fetchVersion() };
-	} catch (error) {
-		if (error.message.includes(REMOTE_URL)) error.message = error.message.replace(REMOTE_URL, "[REMOTE_URL]");
-		consola.error(`网络连接异常: ${error.message}`);
-		process.exit(1);
-	} finally {
-		spinner.stop();
-	}
-}
-
 //#endregion
 //#region src/core/init.ts
 async function init() {
@@ -200,31 +89,21 @@ async function init() {
 		if (existsSync(answer.dir)) {
 			if (!await confirm({ message: `目录 ${colors.cyan(answer.dir)} 已存在，是否覆盖？` })) throw Error;
 		}
+		answer.templateName = await select({
+			message: "选择模板类型",
+			default: "pubinfo-app",
+			choices: [{
+				name: "Web应用（app）",
+				value: "pubinfo-app"
+			}, {
+				name: "模块插件（module）",
+				value: "pubinfo-module"
+			}]
+		});
 		answer.openapi = await confirm({
 			message: "运行时自动生成接口对接文件，若关闭可通过指令生成（openapi）",
 			default: false
 		});
-		if (await select({
-			message: "使用 v1 or v2 版本？",
-			default: "v2",
-			choices: ["v1", "v2"]
-		}) === "v1") {
-			const { version: version$1 } = await fetchData();
-			answer.optionsV1 = JSON.parse(JSON.stringify(answer));
-			answer.optionsV1.version = await select({
-				message: "框架版本号（version）",
-				default: version$1.latest,
-				choices: version$1.list
-			});
-			answer.optionsV1.apps = await checkbox({
-				message: "选择应用模块（apps）",
-				choices: APPS,
-				validate: (input$1) => {
-					if (input$1.length === 0) return "请至少选择一个应用";
-					return true;
-				}
-			});
-		}
 		return answer;
 	} catch {
 		consola.fail("操作终止");
@@ -232,6 +111,60 @@ async function init() {
 	}
 }
 
+//#endregion
+//#region src/core/index.ts
+const __dirname = dirname(fileURLToPath(import.meta.url));
+async function generate(version$1) {
+	const options = await init();
+	const root = cwd();
+	const plop = await nodePlop();
+	const templateDir = resolve(__dirname, "../templates");
+	const destDir = resolve(root, options.dir);
+	plop.setGenerator("generate", { actions: () => {
+		return [{
+			type: "addMany",
+			destination: destDir,
+			base: resolve(templateDir, options.templateName),
+			templateFiles: resolve(templateDir, options.templateName, "**/*.hbs"),
+			globOptions: { dot: true }
+		}, async function copyRawFiles() {
+			const baseDir = resolve(templateDir, options.templateName);
+			async function walk(dir) {
+				const entries = await fs.promises.readdir(dir, { withFileTypes: true });
+				for (const e of entries) {
+					const srcPath = resolve(dir, e.name);
+					const rel = srcPath.replace(`${baseDir}/`, "");
+					if (e.isDirectory()) {
+						await walk(srcPath);
+						continue;
+					}
+					if (e.name.endsWith(".hbs")) continue;
+					const targetPath$1 = resolve(destDir, rel);
+					await fs.promises.mkdir(resolve(targetPath$1, ".."), { recursive: true });
+					await fs.promises.copyFile(srcPath, targetPath$1);
+				}
+			}
+			await walk(baseDir);
+			return `Copied raw files from ${options.templateName}`;
+		}];
+	} });
+	await plop.getGenerator("generate").runActions({
+		...options,
+		version: version$1
+	});
+	const renameFiles = {
+		_gitignore: ".gitignore",
+		_npmrc: ".npmrc"
+	};
+	const targetPath = resolve(root, options.dir);
+	for (const [oldName, newName] of Object.entries(renameFiles)) {
+		const oldPath = resolve(targetPath, oldName);
+		const newPath = resolve(targetPath, newName || oldName);
+		if (existsSync(oldPath)) renameSync(oldPath, newPath);
+	}
+	consola.success(`${colors.green("项目模板初始化完成.")}`);
+}
+
 //#endregion
 //#region src/log.ts
 function bootstrop() {
@@ -254,6 +187,21 @@ function bootstrop() {
 	}
 }
 
+//#endregion
+//#region src/v1/constant.ts
+const REMOTE_URL = "http://106.53.74.49:20000/templates";
+const PKG_NAME = "monorepo-project-template";
+const VERSION_FILE = "version.json";
+const SETTING_FILE_PATH = "src/settings.default.ts";
+const OPENAPI_FILE_PATH = "openapi.config.ts";
+const APPS_DIR = "apps";
+const APPS = [{
+	name: "用户权限系统（rbac）",
+	value: "rbac"
+}];
+const METADATA_DIR = "configs/metadata";
+const META_FILENAME = "pubinfo.json";
+
 //#endregion
 //#region src/v1/download.ts
 const pubinfo = async (input$1, { auth }) => {
@@ -296,6 +244,67 @@ function loading() {
 	};
 }
 
+//#endregion
+//#region src/v1/fetch.ts
+async function fetchVersion() {
+	const versions = await ofetch(`${REMOTE_URL}/${VERSION_FILE}`);
+	versions.sort((v1, v2) => -compare(v1, v2));
+	return {
+		latest: versions[0],
+		list: versions
+	};
+}
+async function fetchData() {
+	const spinner = ora({
+		text: "检测网络连接...",
+		color: "blue"
+	});
+	spinner.start();
+	try {
+		return { version: await fetchVersion() };
+	} catch (error) {
+		if (error.message.includes(REMOTE_URL)) error.message = error.message.replace(REMOTE_URL, "[REMOTE_URL]");
+		consola.error(`网络连接异常: ${error.message}`);
+		process.exit(1);
+	} finally {
+		spinner.stop();
+	}
+}
+
+//#endregion
+//#region src/v1/utils.ts
+function assignValues(target, source) {
+	for (const [key, value] of Object.entries(source)) target[key] = value;
+}
+async function readJSON(path) {
+	const blob = await readFile(path, "utf-8");
+	let parsed;
+	try {
+		parsed = parseJSON(blob);
+	} catch {
+		parsed = parseJSONC(blob);
+	}
+	return parsed;
+}
+async function writeJSON(path, json) {
+	await writeFile(path, stringifyJSON(json));
+}
+/**
+* 重写文件内容
+*/
+function rewriteFile(path, fn) {
+	if (!existsSync(path)) {
+		consola.error(`RewriteFile fail: ${path} does not exist`);
+		return;
+	}
+	try {
+		const content = readFileSync(path, { encoding: "utf-8" });
+		writeFileSync(path, fn(content));
+	} catch (error) {
+		consola.error(`RewriteFile fail: ${error}`);
+	}
+}
+
 //#endregion
 //#region src/v1/rewrite.ts
 async function rewrite(options) {
@@ -354,6 +363,46 @@ function writeApps(appsDir, options) {
 	}
 }
 
+//#endregion
+//#region src/v1/index.ts
+async function generateV1() {
+	const { version: version$1 } = await fetchData();
+	const answer = {};
+	answer.dir = await input({
+		message: "目录名称（dir）",
+		default: "my-app",
+		validate: validateInput
+	});
+	answer.key = await input({
+		message: "项目标识（key）",
+		default: answer.dir,
+		validate: validateInput
+	});
+	if (existsSync(answer.dir)) {
+		if (!await confirm({ message: `目录 ${colors.cyan(answer.dir)} 已存在，是否覆盖？` })) throw Error;
+	}
+	answer.openapi = await confirm({
+		message: "运行时自动生成接口对接文件，若关闭可通过指令生成（openapi）",
+		default: false
+	});
+	const optionsV1 = JSON.parse(JSON.stringify(answer));
+	optionsV1.version = await select({
+		message: "框架版本号（version）",
+		default: version$1.latest,
+		choices: version$1.list
+	});
+	optionsV1.apps = await checkbox({
+		message: "选择应用模块（apps）",
+		choices: APPS,
+		validate: (input$1) => {
+			if (input$1.length === 0) return "请至少选择一个应用";
+			return true;
+		}
+	});
+	await download(optionsV1);
+	await rewrite(optionsV1);
+}
+
 //#endregion
 //#region src/index.ts
 async function main() {
@@ -362,13 +411,15 @@ async function main() {
 	program.description("初始化框架").action(async () => {
 		bootstrop();
 		try {
-			const answer = await init();
-			if (answer.optionsV1) {
-				await download(answer.optionsV1);
-				await rewrite(answer.optionsV1);
+			if (await select({
+				message: "使用 v1/v2 版本？",
+				default: "v2",
+				choices: ["v1", "v2"]
+			}) === "v1") {
+				await generateV1();
 				return;
 			}
-			generate(answer, package_default.version);
+			await generate(package_default.version);
 		} catch (error) {
 			consola.error(error);
 		}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-pubinfo",
   "type": "module",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0-rc.5",
   "description": "初始化项目框架",
   "author": "Werheng <werheng.zhang@gmail.com>",
   "license": "MIT",
@@ -12,6 +12,9 @@
     "dist",
     "templates"
   ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "dependencies": {
     "@inquirer/prompts": "^7.6.0",
     "ansi-colors": "^4.1.3",
@@ -20,6 +23,7 @@
     "confbox": "^0.2.2",
     "consola": "^3.4.2",
     "giget": "^2.0.0",
+    "node-plop": "0.32.1",
     "ofetch": "^1.4.1",
     "ora": "^8.2.0",
     "rimraf": "^6.0.1",

package/templates/{pubinfo-template → pubinfo-app}/.env

@@ -1,5 +1,2 @@
 # 页面标题
 VITE_APP_TITLE = 产数开发底座
-
-# 开启多租户
-VITE_TENANT_ENABLED = false

package/templates/{pubinfo-template/openapi.config.ts → pubinfo-app/openapi.config.ts.hbs}

@@ -2,7 +2,7 @@ import { defineConfig } from '@pubinfo/openapi';
 import { presetName } from '@pubinfo/preset-openapi';
 
 export default defineConfig({
-  enabled: false,
+  enabled: {{openapi}},
 
   presets: [
     // 小驼峰式命名

package/templates/{pubinfo-template/package.json → pubinfo-app/package.json.hbs}

@@ -1,13 +1,17 @@
 {
-  "name": "pubinfo-template",
+  "name": "{{dir}}",
   "type": "module",
   "private": true,
   "packageManager": "pnpm@10.12.4",
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "scripts": {
     "dev": "pubinfo dev",
     "build": "pubinfo build",
     "preview": "pubinfo preview",
     "commit": "pubinfo commit",
+    "upgrade": "pubinfo upgrade",
     "prepare": "pubinfo setup && pubinfo commit --init",
     "lint": "pnpm run lint:eslint && pnpm run lint:stylelint",
     "lint:eslint": "eslint . --cache --fix",
@@ -18,14 +22,14 @@
   },
   "dependencies": {
     "@ant-design/icons-vue": "^7.0.1",
-    "@pubinfo/module-auth": "^2.0.0-rc.1",
-    "@pubinfo/module-rbac": "^2.0.0-rc.1",
+    "@pubinfo/module-auth": "{{version}}",
+    "@pubinfo/module-rbac": "{{version}}",
     "@pubinfo/pro-components": "^1.7.1",
     "@vueuse/core": "^13.7.0",
     "alova": "^3.3.4",
     "ant-design-vue": "^4.2.6",
     "dayjs": "^1.11.13",
-    "pubinfo": "^2.0.0-rc.1"
+    "pubinfo": "{{version}}"
   },
   "devDependencies": {
     "@pubinfo/openapi": "^0.9.0",

package/templates/pubinfo-app/src/settings.ts.hbs

@@ -0,0 +1,8 @@
+import { defineSettings } from 'pubinfo';
+
+export default defineSettings({
+  // 请在此处编写或粘贴配置代码
+  app: {
+    storagePrefix: '{{key}}',
+  },
+});

package/templates/pubinfo-module/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+quote_type = single

package/templates/pubinfo-module/README.md.hbs

@@ -0,0 +1,27 @@
+# pubinfo-module-{{kebabCase dir}}
+
+## 安装依赖
+
+```bash
+pnpm install
+```
+
+## 运行
+
+监听模块插件：
+
+```bash
+pnpm dev
+```
+
+运行演练场调试：
+
+```bash
+pnpm play
+```
+
+## 构建
+
+```bash
+pnpm build
+```

package/templates/pubinfo-module/_gitignore

@@ -0,0 +1,38 @@
+.pubinfo
+.eslintcache
+.stylelintcache
+.gitmessage
+
+# auto generated
+auto-imports.d.ts
+components.d.ts
+
+.DS_Store
+node_modules
+dist
+cache
+coverage
+.turbo
+.eslintcache
+.stylelintcache
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Editor directories and files
+.idea
+# .vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+

package/templates/pubinfo-module/_npmrc

@@ -0,0 +1,5 @@
+ignore-workspace-root-check=true
+shamefully-hoist=true
+strict-peer-dependencies=false
+shell-emulator=true
+max-old-space-size=4096

package/templates/pubinfo-module/eslint.config.ts

@@ -0,0 +1,3 @@
+import pubinfo from 'pubinfo/eslint';
+
+export default pubinfo();

package/templates/pubinfo-module/package.json.hbs

@@ -0,0 +1,67 @@
+{
+  "name": "pubinfo-module-{{kebabCase dir}}",
+  "type": "module",
+  "version": "0.0.0",
+  "packageManager": "pnpm@10.12.4",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./style.css": "./dist/index.css"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "scripts": {
+    "play": "pnpm run -C playground dev",
+    "play:build": "pnpm run -C playground build",
+    "play:preview": "pnpm run -C playground preview",
+    "dev": "pubinfo build -w",
+    "build": "pubinfo build",
+    "commit": "pubinfo commit",
+    "upgrade": "pubinfo upgrade",
+    "prepare": "pubinfo setup && pubinfo commit --init",
+    "lint": "pnpm run lint:eslint && pnpm run lint:stylelint",
+    "lint:eslint": "eslint . --cache --fix",
+    "lint:stylelint": "stylelint \"src/**/*.{css,scss,vue}\" --cache --fix",
+    "openapi": "pnpx @pubinfo/openapi generate",
+    "release": "bumpp",
+    "deps": "pnpx taze -r",
+    "deps:up": "pnpx taze -wr"
+  },
+  "peerDependencies": {
+    "pubinfo": ">=2.0.0"
+  },
+  "devDependencies": {
+    "@pubinfo/openapi": "^0.9.0",
+    "@pubinfo/preset-openapi": "^0.9.0",
+    "eslint": "^9.30.1",
+    "lint-staged": "^16.1.2",
+    "pubinfo": "{{version}}",
+    "simple-git-hooks": "^2.13.0",
+    "stylelint": "^16.21.0",
+    "typescript": "^5.8.3"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged",
+    "commit-msg": "pnpm exec pubinfo commit --edit $1"
+  },
+  "lint-staged": {
+    "*.{vue,js,ts,jsx,tsx,md,json}": "eslint --cache --fix",
+    "*.{css,less,scss,vue}": "stylelint --cache --fix"
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-git",
+      "czConfig": ".pubinfo/cz.config.cjs"
+    }
+  }
+}

package/templates/pubinfo-module/playground/.env

@@ -0,0 +1,2 @@
+# 页面标题
+VITE_APP_TITLE = 产数开发底座