@doyuli/kits-core 0.1.1 → 0.2.1

package/LICENSE

@@ -1,21 +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
+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/README.md

@@ -1,3 +1,3 @@
-### Kits-Core
-
-Provides basic capabilities for creating templates
+### Kits-Core
+
+Provides basic capabilities for creating templates

package/dist/{index.d.ts → index.d.mts}

@@ -1,20 +1,39 @@
 import { Option } from "@clack/prompts";
 
 //#region src/helper/setupPrompts.d.ts
-interface PromptResult<T = string> {
+type PromptStep<T extends Record<string, any> = Record<string, any>> = (result: PromptResult) => Promise<T>;
+interface PromptResult {
   projectName?: string;
   packageName?: string;
   shouldOverwrite?: boolean;
-  features?: T[];
 }
-declare function setupPrompts<T = string>(targetDir: string, featureOptions: ReadonlyArray<Option<T>>): Promise<{
-  result: PromptResult<T>;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+declare function setupPrompts<const Steps extends PromptStep<any>[]>(targetDir: string, steps: [...Steps]): Promise<{
+  result: PromptResult & UnionToIntersection<Steps[number] extends PromptStep<infer R extends Record<string, any>> ? R : never>;
   targetDir: string;
 }>;
 //#endregion
 //#region src/helper/setupProject.d.ts
 declare function setupProject(cwd: string, result: PromptResult, targetDir: string): Promise<string>;
 //#endregion
+//#region src/helper/steps.d.ts
+interface SelectOptions<T> {
+  message: string;
+  options: Option<T>[];
+}
+interface FeaturesOptions<T> {
+  message?: string;
+  options: Option<T>[];
+  required?: boolean;
+}
+interface ConfirmOptions {
+  message: string;
+  initialValue?: boolean;
+}
+declare function setupSelect<Key extends string, T extends string>(key: Key, options: SelectOptions<T>): PromptStep<Record<Key, T>>;
+declare function setupFeatures<Key extends string, T extends string>(key: Key, options: FeaturesOptions<T>): PromptStep<Record<Key, T[]>>;
+declare function setupConfirm<Key extends string>(key: Key, options: ConfirmOptions): PromptStep<Record<Key, boolean>>;
+//#endregion
 //#region src/utils/directoryTraverse.d.ts
 /**
  * @see https://github.com/vuejs/create-vue/blob/main/utils/directoryTraverse.ts
@@ -49,4 +68,4 @@ declare function unwrapPrompt<T>(maybeCancelPromise: Promise<T | symbol>): Promi
 declare function renderTemplate(src: string, dest: string): void;
 declare function renderFile(root: string, fileName: string, content: string): void;
 //#endregion
-export { PromptResult, canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupProject, setupPrompts, unwrapPrompt };
+export { type PromptResult, type PromptStep, canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupConfirm, setupFeatures, setupProject, setupPrompts, setupSelect, unwrapPrompt };

package/dist/{index.js → index.mjs}

@@ -1,7 +1,7 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 import process from "node:process";
-import { cancel, confirm, isCancel, multiselect, text } from "@clack/prompts";
+import { cancel, confirm, isCancel, multiselect, select, text } from "@clack/prompts";
 import pico from "picocolors";
 
 //#region src/utils/directoryTraverse.ts
@@ -48,7 +48,7 @@ function canSkipEmptying(dir) {
 }
 function emptyDir(dir) {
 	if (!fs.existsSync(dir)) return;
-	postOrderDirectoryTraverse(dir, (dir$1) => fs.rmdirSync(dir$1), (file) => fs.unlinkSync(file));
+	postOrderDirectoryTraverse(dir, (dir) => fs.rmdirSync(dir), (file) => fs.unlinkSync(file));
 }
 
 //#endregion
@@ -91,13 +91,12 @@ function deepMerge(target, source) {
 }
 function sortDependencies(packageJson) {
 	const sorted = {};
-	const depTypes = [
+	for (const depType of [
 		"dependencies",
 		"devDependencies",
 		"peerDependencies",
 		"optionalDependencies"
-	];
-	for (const depType of depTypes) if (packageJson[depType]) {
+	]) if (packageJson[depType]) {
 		sorted[depType] = {};
 		Object.keys(packageJson[depType]).sort().forEach((name) => {
 			sorted[depType][name] = packageJson[depType][name];
@@ -131,23 +130,17 @@ function renderTemplate(src, dest) {
 	}
 	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(existing, newPackage));
+		const pkg = sortDependencies(deepMerge(JSON.parse(fs.readFileSync(dest, "utf8")), JSON.parse(fs.readFileSync(src, "utf8"))));
 		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(existing, newExtensions);
+		const extensions = deepMerge(JSON.parse(fs.readFileSync(dest, "utf8")), JSON.parse(fs.readFileSync(src, "utf8")));
 		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(existing, newSettings);
+		const settings = deepMerge(JSON.parse(fs.readFileSync(dest, "utf8")), JSON.parse(fs.readFileSync(src, "utf8")));
 		fs.writeFileSync(dest, `${JSON.stringify(settings, null, 2)}\n`);
 		return;
 	}
@@ -181,13 +174,12 @@ async function setupProject(cwd, result, targetDir) {
 
 //#endregion
 //#region src/helper/setupPrompts.ts
-async function setupPrompts(targetDir, featureOptions) {
+async function setupPrompts(targetDir, steps) {
 	const defaultProjectName = targetDir || "Template-Kits";
 	const result = {
 		projectName: defaultProjectName,
 		packageName: defaultProjectName,
-		shouldOverwrite: false,
-		features: []
+		shouldOverwrite: false
 	};
 	if (!targetDir) targetDir = result.projectName = result.packageName = (await unwrapPrompt(text({
 		message: "请输入项目名称：",
@@ -205,11 +197,10 @@ async function setupPrompts(targetDir, featureOptions) {
 			process.exit(0);
 		}
 	}
-	result.features = await unwrapPrompt(multiselect({
-		message: `请选择要包含的功能： ${pico.dim("(↑/↓ 切换，空格选择，a 全选，回车确认)")}`,
-		options: featureOptions,
-		required: false
-	}));
+	for (const step of steps) {
+		const extra = await step(result);
+		Object.assign(result, extra);
+	}
 	return {
 		result,
 		targetDir
@@ -217,4 +208,35 @@ async function setupPrompts(targetDir, featureOptions) {
 }
 
 //#endregion
-export { canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupProject, setupPrompts, unwrapPrompt };
+//#region src/helper/steps.ts
+function setupSelect(key, options) {
+	return async () => {
+		const value = await unwrapPrompt(select({
+			message: options.message,
+			options: options.options
+		}));
+		return { [key]: value };
+	};
+}
+function setupFeatures(key, options) {
+	return async () => {
+		const selected = await unwrapPrompt(multiselect({
+			message: options.message ?? `请选择要包含的功能： ${pico.dim("(↑/↓ 切换，空格选择，a 全选，回车确认)")}`,
+			options: options.options,
+			required: options.required ?? false
+		}));
+		return { [key]: selected };
+	};
+}
+function setupConfirm(key, options) {
+	return async () => {
+		const value = await unwrapPrompt(confirm({
+			message: options.message,
+			initialValue: options.initialValue ?? false
+		}));
+		return { [key]: value };
+	};
+}
+
+//#endregion
+export { canSkipEmptying, dotGitDirectoryState, emptyDir, getCommand, getPackageManager, postOrderDirectoryTraverse, preOrderDirectoryTraverse, renderFile, renderTemplate, setupConfirm, setupFeatures, setupProject, setupPrompts, setupSelect, unwrapPrompt };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@doyuli/kits-core",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "@doyuli/kits-core",
   "repository": {
     "type": "git",
@@ -14,11 +14,9 @@
   ],
   "sideEffects": false,
   "exports": {
-    ".": "./dist/index.js",
+    ".": "./dist/index.mjs",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"