@doyuli/kits-core 0.0.1-beta.3 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 doyuli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,9 +1,24 @@
-//#region src/utils/command.d.ts
-declare function getPackageManager(): "pnpm" | "yarn" | "bun" | "npm";
-declare function getPackageCommand(packageManager: string, scriptName: string, args?: string): string;
-declare function getOutroMessage(root: string, cwd: string): string;
+import { Option } from "@clack/prompts";
+
+//#region src/helper/setupPrompts.d.ts
+interface PromptResult<T = string> {
+  projectName?: string;
+  packageName?: string;
+  shouldOverwrite?: boolean;
+  features?: T[];
+}
+declare function setupPrompts<T = string>(targetDir: string, featureOptions: ReadonlyArray<Option<T>>): Promise<{
+  result: PromptResult<T>;
+  targetDir: string;
+}>;
+//#endregion
+//#region src/helper/setupProject.d.ts
+declare function setupProject(cwd: string, result: PromptResult, targetDir: string): Promise<string>;
 //#endregion
 //#region src/utils/directoryTraverse.d.ts
+/**
+ * @see https://github.com/vuejs/create-vue/blob/main/utils/directoryTraverse.ts
+ */
 declare function preOrderDirectoryTraverse(dir: string, dirCallback: (dir: string) => void, fileCallback: (file: string) => void): void;
 declare const dotGitDirectoryState: {
   hasDotGitDirectory: boolean;
@@ -12,11 +27,17 @@ declare function postOrderDirectoryTraverse(dir: string, dirCallback: (dir: stri
 declare function canSkipEmptying(dir: string): boolean;
 declare function emptyDir(dir: string): void;
 //#endregion
+//#region src/utils/package.d.ts
+declare function getPackageManager(): "pnpm" | "yarn" | "bun" | "npm";
+declare function getCommand(manager: string, name: string, args?: string): string;
+//#endregion
 //#region src/utils/prompts.d.ts
 declare function unwrapPrompt<T>(maybeCancelPromise: Promise<T | symbol>): Promise<T>;
 //#endregion
 //#region src/utils/renderTemplate.d.ts
 /**
+ * @see https://github.com/vuejs/create-vue/blob/main/utils/renderTemplate.ts
+ *
  * Renders a template folder/file to the file system,
  * by recursively copying all files under the `src` directory,
  * with the following exception:
@@ -25,9 +46,7 @@ declare function unwrapPrompt<T>(maybeCancelPromise: Promise<T | symbol>): Promi
  * @param {string} src source filename to copy
  * @param {string} dest destination filename of the copy operation
  */
-declare function renderTemplate(src: string, dest: string, callbacks: any[]): void;
-//#endregion
-//#region src/utils/render.d.ts
+declare function renderTemplate(src: string, dest: string): void;
 declare function renderFile(root: string, fileName: string, content: string): void;
 //#endregion
-export { canSkipEmptying, dotGitDirectoryState, emptyDir, getOutroMessage, getPackageCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, unwrapPrompt };
+export { PromptResult, canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupProject, setupPrompts, unwrapPrompt };

package/dist/index.js

@@ -1,38 +1,13 @@
+import * as fs from "node:fs";
 import * as path from "node:path";
-import { relative, resolve } from "node:path";
 import process from "node:process";
+import { cancel, confirm, isCancel, multiselect, text } from "@clack/prompts";
 import pico from "picocolors";
-import * as fs from "node:fs";
-import { writeFileSync } from "node:fs";
-import { cancel, isCancel } from "@clack/prompts";
-import { pathToFileURL } from "node:url";
-
-//#region src/utils/command.ts
-function getPackageManager() {
-	const userAgent = process.env.npm_config_user_agent ?? "";
-	return /pnpm/.test(userAgent) ? "pnpm" : /yarn/.test(userAgent) ? "yarn" : /bun/.test(userAgent) ? "bun" : "npm";
-}
-function getPackageCommand(packageManager, scriptName, args) {
-	if (scriptName === "install") return packageManager === "yarn" ? "yarn" : `${packageManager} install`;
-	if (scriptName === "build") return packageManager === "npm" || packageManager === "bun" ? `${packageManager} run build` : `${packageManager} build`;
-	if (args) return packageManager === "npm" ? `npm run ${scriptName} -- ${args}` : `${packageManager} ${scriptName} ${args}`;
-	else return packageManager === "npm" ? `npm run ${scriptName}` : `${packageManager} ${scriptName}`;
-}
-function getOutroMessage(root, cwd) {
-	const packageManager = getPackageManager();
-	let message = `项目初始化完成，可执行以下命令：\n\n`;
-	if (root !== cwd) {
-		const cdProjectName = relative(cwd, root);
-		message += `   ${pico.bold(pico.green(`cd ${cdProjectName.includes(" ") ? `"${cdProjectName}"` : cdProjectName}`))}\n`;
-	}
-	message += `   ${pico.bold(pico.green(getPackageCommand(packageManager, "install")))}\n`;
-	message += `   ${pico.bold(pico.green(getPackageCommand(packageManager, "lint:fix")))}\n`;
-	message += `   ${pico.bold(pico.green(getPackageCommand(packageManager, "dev")))}\n`;
-	return message;
-}
 
-//#endregion
 //#region src/utils/directoryTraverse.ts
+/**
+* @see https://github.com/vuejs/create-vue/blob/main/utils/directoryTraverse.ts
+*/
 function preOrderDirectoryTraverse(dir, dirCallback, fileCallback) {
 	for (const filename of fs.readdirSync(dir)) {
 		if (filename === ".git") continue;
@@ -76,6 +51,19 @@ function emptyDir(dir) {
 	postOrderDirectoryTraverse(dir, (dir$1) => fs.rmdirSync(dir$1), (file) => fs.unlinkSync(file));
 }
 
+//#endregion
+//#region src/utils/package.ts
+function getPackageManager() {
+	const userAgent = process.env.npm_config_user_agent ?? "";
+	return /pnpm/.test(userAgent) ? "pnpm" : /yarn/.test(userAgent) ? "yarn" : /bun/.test(userAgent) ? "bun" : "npm";
+}
+function getCommand(manager, name, args) {
+	if (name === "install") return manager === "yarn" ? "yarn" : `${manager} install`;
+	if (name === "build") return manager === "npm" || manager === "bun" ? `${manager} run build` : `${manager} build`;
+	if (args) return manager === "npm" ? `npm run ${name} -- ${args}` : `${manager} ${name} ${args}`;
+	else return manager === "npm" ? `npm run ${name}` : `${manager} ${name}`;
+}
+
 //#endregion
 //#region src/utils/prompts.ts
 async function unwrapPrompt(maybeCancelPromise) {
@@ -88,28 +76,19 @@ async function unwrapPrompt(maybeCancelPromise) {
 }
 
 //#endregion
-//#region src/utils/deepMerge.ts
-const isObject = (val) => val && typeof val === "object";
-const mergeArrayWithDedupe = (a, b) => Array.from(new Set([...a, ...b]));
-/**
-* Recursively merge the content of the new object to the existing one
-* @param {object} target the existing object
-* @param {object} obj the new object
-*/
-function deepMerge(target, obj) {
-	for (const key of Object.keys(obj)) {
+//#region src/utils/util.ts
+const isObject = (val) => typeof val === "object" && val !== null;
+const mergeArrayWithDedupe = (a, b) => [...new Set([...a, ...b])];
+function deepMerge(target, source) {
+	for (const key of Object.keys(source)) {
 		const oldVal = target[key];
-		const newVal = obj[key];
+		const newVal = source[key];
 		if (Array.isArray(oldVal) && Array.isArray(newVal)) target[key] = mergeArrayWithDedupe(oldVal, newVal);
 		else if (isObject(oldVal) && isObject(newVal)) target[key] = deepMerge(oldVal, newVal);
 		else target[key] = newVal;
 	}
 	return target;
 }
-var deepMerge_default = deepMerge;
-
-//#endregion
-//#region src/utils/sortDependencies.ts
 function sortDependencies(packageJson) {
 	const sorted = {};
 	const depTypes = [
@@ -133,6 +112,8 @@ function sortDependencies(packageJson) {
 //#endregion
 //#region src/utils/renderTemplate.ts
 /**
+* @see https://github.com/vuejs/create-vue/blob/main/utils/renderTemplate.ts
+*
 * Renders a template folder/file to the file system,
 * by recursively copying all files under the `src` directory,
 * with the following exception:
@@ -141,32 +122,32 @@ function sortDependencies(packageJson) {
 * @param {string} src source filename to copy
 * @param {string} dest destination filename of the copy operation
 */
-function renderTemplate(src, dest, callbacks) {
+function renderTemplate(src, dest) {
 	if (fs.statSync(src).isDirectory()) {
 		if (path.basename(src) === "node_modules") return;
 		fs.mkdirSync(dest, { recursive: true });
-		for (const file of fs.readdirSync(src)) renderTemplate(path.resolve(src, file), path.resolve(dest, file), callbacks);
+		for (const file of fs.readdirSync(src)) renderTemplate(path.resolve(src, file), path.resolve(dest, file));
 		return;
 	}
 	const filename = path.basename(src);
 	if (filename === "package.json" && fs.existsSync(dest)) {
 		const existing = JSON.parse(fs.readFileSync(dest, "utf8"));
 		const newPackage = JSON.parse(fs.readFileSync(src, "utf8"));
-		const pkg = sortDependencies(deepMerge_default(existing, newPackage));
+		const pkg = sortDependencies(deepMerge(existing, newPackage));
 		fs.writeFileSync(dest, `${JSON.stringify(pkg, null, 2)}\n`);
 		return;
 	}
 	if (filename === "extensions.json" && fs.existsSync(dest)) {
 		const existing = JSON.parse(fs.readFileSync(dest, "utf8"));
 		const newExtensions = JSON.parse(fs.readFileSync(src, "utf8"));
-		const extensions = deepMerge_default(existing, newExtensions);
+		const extensions = deepMerge(existing, newExtensions);
 		fs.writeFileSync(dest, `${JSON.stringify(extensions, null, 2)}\n`);
 		return;
 	}
 	if (filename === "settings.json" && fs.existsSync(dest)) {
 		const existing = JSON.parse(fs.readFileSync(dest, "utf8"));
 		const newSettings = JSON.parse(fs.readFileSync(src, "utf8"));
-		const settings = deepMerge_default(existing, newSettings);
+		const settings = deepMerge(existing, newSettings);
 		fs.writeFileSync(dest, `${JSON.stringify(settings, null, 2)}\n`);
 		return;
 	}
@@ -177,22 +158,63 @@ function renderTemplate(src, dest, callbacks) {
 		fs.writeFileSync(dest, `${existing}\n${newGitignore}`);
 		return;
 	}
-	if (filename.endsWith(".data.mjs")) {
-		dest = dest.replace(/\.data\.mjs$/, "");
-		callbacks.push(async (dataStore) => {
-			const getData = (await import(pathToFileURL(src).toString())).default;
-			dataStore[dest] = await getData({ oldData: dataStore[dest] || {} });
-		});
-		return;
-	}
 	fs.copyFileSync(src, dest);
 }
+function renderFile(root, fileName, content) {
+	fs.writeFileSync(path.resolve(root, fileName), content, "utf-8");
+}
 
 //#endregion
-//#region src/utils/render.ts
-function renderFile(root, fileName, content) {
-	writeFileSync(resolve(root, fileName), content, "utf-8");
+//#region src/helper/setupProject.ts
+async function setupProject(cwd, result, targetDir) {
+	const root = path.join(cwd, targetDir);
+	if (fs.existsSync(root) && result.shouldOverwrite) emptyDir(root);
+	else if (!fs.existsSync(root)) fs.mkdirSync(root);
+	console.log(`\n正在初始化项目 ${root}...`);
+	const pkg = {
+		name: result.packageName,
+		version: "0.0.0"
+	};
+	renderFile(root, "package.json", JSON.stringify(pkg, null, 2));
+	return root;
+}
+
+//#endregion
+//#region src/helper/setupPrompts.ts
+async function setupPrompts(targetDir, featureOptions) {
+	const defaultProjectName = targetDir || "Template-Kits";
+	const result = {
+		projectName: defaultProjectName,
+		packageName: defaultProjectName,
+		shouldOverwrite: false,
+		features: []
+	};
+	if (!targetDir) targetDir = result.projectName = result.packageName = (await unwrapPrompt(text({
+		message: "请输入项目名称：",
+		placeholder: defaultProjectName,
+		defaultValue: "",
+		validate: (value) => value.trim().length === 0 ? "不能为空" : ""
+	}))).trim();
+	if (!canSkipEmptying(targetDir)) {
+		result.shouldOverwrite = await unwrapPrompt(confirm({
+			message: `${targetDir === "." ? "当前目录" : `目标文件夹 "${targetDir}"`} 非空，是否覆盖？`,
+			initialValue: false
+		}));
+		if (!result.shouldOverwrite) {
+			cancel(`${pico.red("✖")} 操作取消`);
+			process.exit(0);
+		}
+	}
+	result.features = await unwrapPrompt(multiselect({
+		message: `请选择要包含的功能： ${pico.dim("(↑/↓ 切换，空格选择，a 全选，回车确认)")}`,
+		options: featureOptions,
+		required: false
+	}));
+	return {
+		result,
+		targetDir
+	};
 }
 
 //#endregion
-export { canSkipEmptying, dotGitDirectoryState, emptyDir, getOutroMessage, getPackageCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, unwrapPrompt };
+export { canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupProject, setupPrompts, unwrapPrompt };

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@doyuli/kits-core",
   "type": "module",
-  "version": "0.0.1-beta.3",
+  "version": "0.1.0",
   "description": "@doyuli/kits-core",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/doyuli/template-kits.git",
     "directory": "packages/kits-core"
   },
+  "keywords": [
+    "templates",
+    "kits"
+  ],
   "sideEffects": false,
   "exports": {
     ".": "./dist/index.js",