@quiteer/scripts 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Soybean
+
+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.mts

@@ -0,0 +1,4 @@
+//#region src/index.d.ts
+declare function setupCli(): Promise<void>;
+//#endregion
+export { setupCli };

package/dist/index.mjs

@@ -0,0 +1,327 @@
+import cac from "cac";
+import { bgRed, blue, gray, green, lightGreen, red, yellow } from "kolorist";
+import { rimraf } from "rimraf";
+import { access, writeFile } from "node:fs/promises";
+import path from "node:path";
+import process from "node:process";
+import { prompt } from "enquirer";
+import { loadConfig } from "c12";
+import { readFileSync } from "node:fs";
+import { versionBump } from "bumpp";
+
+//#region package.json
+var version = "0.0.1";
+
+//#endregion
+//#region src/commands/cleanup.ts
+async function cleanup(paths) {
+	await rimraf(paths, { glob: true });
+}
+
+//#endregion
+//#region src/config/index.ts
+const defaultOptions = {
+	cwd: process.cwd(),
+	cleanupDirs: [
+		"**/dist",
+		"**/node_modules",
+		"!node_modules/**"
+	],
+	lang: "zh-cn",
+	ncuCommandArgs: ["--deep", "-u"],
+	gitCommitVerifyIgnores: [
+		/^((Merge pull request)|(Merge (.*?) into (.*)|(Merge branch (.*)))(?:\r?\n)*$)/m,
+		/^(Merge tag (.*))(?:\r?\n)*$/m,
+		/^(R|r)evert (.*)/,
+		/^(amend|fixup|squash)!/,
+		/^(Merged (.*?)(in|into) (.*)|Merged PR (.*): (.*))/,
+		/^Merge remote-tracking branch(\s*)(.*)/,
+		/^Automatic merge(.*)/,
+		/^Auto-merged (.*?) into (.*)/
+	]
+};
+async function loadCliOptions(overrides, cwd = process.cwd()) {
+	const { config } = await loadConfig({
+		name: "quiteer",
+		defaults: defaultOptions,
+		overrides,
+		cwd,
+		packageJson: true
+	});
+	return config;
+}
+
+//#endregion
+//#region src/commands/generate-cfg.ts
+/**
+* 函数：在项目根目录生成 quiteer 配置文件
+* 作用：若已有配置则询问是否覆盖；按默认配置生成 `quiteer.config.ts`
+*/
+async function generateConfig() {
+	const cwd = process.cwd();
+	const configPath = path.join(cwd, "quiteer.config.ts");
+	let exists = true;
+	try {
+		await access(configPath);
+	} catch {
+		exists = false;
+	}
+	if (exists) {
+		const { overwrite } = await prompt([{
+			name: "overwrite",
+			type: "confirm",
+			message: `检测到已存在配置文件 ${path.basename(configPath)}，是否覆盖？`
+		}]);
+		if (!overwrite) return;
+	}
+	const regexList = defaultOptions.gitCommitVerifyIgnores.map((r) => r.toString());
+	const indentJson = (val) => {
+		return JSON.stringify(val, null, 2).split("\n").map((line, i) => i === 0 ? line : `  ${line}`).join("\n");
+	};
+	await writeFile(configPath, [
+		"// 自动生成的 quiteer 配置文件",
+		"",
+		"export default {",
+		`  cleanupDirs: ${indentJson(defaultOptions.cleanupDirs)},`,
+		`  lang: ${JSON.stringify(defaultOptions.lang)},`,
+		`  ncuCommandArgs: ${indentJson(defaultOptions.ncuCommandArgs)},`,
+		"  gitCommitVerifyIgnores: [",
+		...regexList.map((r, idx, arr) => `    ${r}${idx < arr.length - 1 ? "," : ""}`),
+		"  ]",
+		"}",
+		""
+	].join("\n"), "utf8");
+}
+
+//#endregion
+//#region src/locales/index.ts
+const locales = {
+	"zh-cn": {
+		gitCommitMessages: {
+			types: "请选择提交类型",
+			scopes: "请选择提交范围",
+			description: `请输入描述信息（${yellow("!")}开头表示破坏性改动`
+		},
+		gitCommitTypes: [
+			["feat", "新功能"],
+			["feat-wip", "开发中的功能，比如某功能的部分代码"],
+			["fix", "修复Bug"],
+			["docs", "只涉及文档更新"],
+			["typo", "代码或文档勘误，比如错误拼写"],
+			["style", "修改代码风格，不影响代码含义的变更"],
+			["refactor", "代码重构，既不修复 bug 也不添加功能的代码变更"],
+			["perf", "可提高性能的代码更改"],
+			["optimize", "优化代码质量的代码更改"],
+			["test", "添加缺失的测试或更正现有测试"],
+			["build", "影响构建系统或外部依赖项的更改"],
+			["ci", "对 CI 配置文件和脚本的更改"],
+			["chore", "没有修改src或测试文件的其他变更"],
+			["revert", "还原先前的提交"]
+		],
+		gitCommitScopes: [
+			["projects", "项目"],
+			["packages", "包"],
+			["components", "组件"],
+			["hooks", "钩子函数"],
+			["utils", "工具函数"],
+			["types", "TS类型声明"],
+			["styles", "代码风格"],
+			["deps", "项目依赖"],
+			["release", "发布项目新版本"],
+			["other", "其他的变更"]
+		],
+		gitCommitVerify: `${bgRed(" 错误 ")} ${red("git 提交信息必须符合 Conventional Commits 标准!")}\n\n${green("推荐使用命令 `pnpm commit` 生成符合 Conventional Commits 标准的提交信息。\n获取有关 Conventional Commits 的更多信息，请访问此链接: https://conventionalcommits.org")}`
+	},
+	"en-us": {
+		gitCommitMessages: {
+			types: "Please select a type",
+			scopes: "Please select a scope",
+			description: `Please enter a description (add prefix ${yellow("!")} to indicate breaking change)`
+		},
+		gitCommitTypes: [
+			["feat", "A new feature"],
+			["feat-wip", "Features in development, such as partial code for a certain feature"],
+			["fix", "A bug fix"],
+			["docs", "Documentation only changes"],
+			["typo", "Code or document corrections, such as spelling errors"],
+			["style", "Changes that do not affect the meaning of the code"],
+			["refactor", "A code change that neither fixes a bug nor adds a feature"],
+			["perf", "A code change that improves performance"],
+			["optimize", "A code change that optimizes code quality"],
+			["test", "Adding missing tests or correcting existing tests"],
+			["build", "Changes that affect the build system or external dependencies"],
+			["ci", "Changes to our CI configuration files and scripts"],
+			["chore", "Other changes that don't modify src or test files"],
+			["revert", "Reverts a previous commit"]
+		],
+		gitCommitScopes: [
+			["projects", "project"],
+			["packages", "packages"],
+			["components", "components"],
+			["hooks", "hook functions"],
+			["utils", "utils functions"],
+			["types", "TS declaration"],
+			["styles", "style"],
+			["deps", "project dependencies"],
+			["release", "release project"],
+			["other", "other changes"]
+		],
+		gitCommitVerify: `${bgRed(" ERROR ")} ${red("git commit message must match the Conventional Commits standard!")}\n\n${green("Recommended to use the command `pnpm commit` to generate Conventional Commits compliant commit information.\nGet more info about Conventional Commits, follow this link: https://conventionalcommits.org")}`
+	}
+};
+
+//#endregion
+//#region src/shared/index.ts
+async function execCommand(cmd, args, options) {
+	const { execa } = await import("execa");
+	return ((await execa(cmd, args, options))?.stdout)?.trim() || "";
+}
+
+//#endregion
+//#region src/commands/git-commit.ts
+/**
+* 函数：交互式添加变更文件到暂存区
+* 作用：先询问是否添加全部；若否，列出变更文件供多选后执行 git add
+*/
+async function gitCommitAdd() {
+	const { confirm } = await prompt([{
+		name: "confirm",
+		type: "confirm",
+		message: "是否添加所有变更文件到暂存区？"
+	}]);
+	if (!confirm) {
+		const files = (await execCommand("git", ["diff", "--name-only"])).split("\n").filter(Boolean);
+		if (files.length === 0) return;
+		const { selected } = await prompt([{
+			name: "selected",
+			type: "multiselect",
+			message: "选择需要添加到暂存区的文件（空格选择，回车确认）",
+			choices: files.map((f) => ({
+				name: f,
+				value: f
+			}))
+		}]);
+		if (!selected?.length) return;
+		await execCommand("git", ["add", ...selected], { stdio: "inherit" });
+		return;
+	}
+	await execCommand("git", ["add", "."], { stdio: "inherit" });
+}
+/**
+* Git commit with Conventional Commits standard
+*
+* @param lang
+*/
+async function gitCommit(lang = "en-us") {
+	const { gitCommitMessages, gitCommitTypes, gitCommitScopes } = locales[lang];
+	const typesChoices = gitCommitTypes.map(([value, msg]) => {
+		return {
+			name: value,
+			message: `${`${value}:`.padEnd(12)}${msg}`
+		};
+	});
+	const scopesChoices = gitCommitScopes.map(([value, msg]) => ({
+		name: value,
+		message: `${value.padEnd(30)} (${msg})`
+	}));
+	const result = await prompt([
+		{
+			name: "types",
+			type: "select",
+			message: gitCommitMessages.types,
+			choices: typesChoices
+		},
+		{
+			name: "scopes",
+			type: "select",
+			message: gitCommitMessages.scopes,
+			choices: scopesChoices
+		},
+		{
+			name: "description",
+			type: "text",
+			message: gitCommitMessages.description
+		}
+	]);
+	const breaking = result.description.startsWith("!") ? "!" : "";
+	const description = result.description.replace(/^!/, "").trim();
+	await execCommand("git", [
+		"commit",
+		"-m",
+		`${result.types}(${result.scopes})${breaking}: ${description}`
+	], { stdio: "inherit" });
+}
+/** Git commit message verify */
+async function gitCommitVerify(lang = "zh-cn", ignores = []) {
+	const gitPath = await execCommand("git", ["rev-parse", "--show-toplevel"]);
+	const commitMsg = readFileSync(path.join(gitPath, ".git", "COMMIT_EDITMSG"), "utf8").trim();
+	if (ignores.some((regExp) => regExp.test(commitMsg))) return;
+	if (!/(?<type>[a-z]+)(?:\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i.test(commitMsg)) {
+		const errorMsg = locales[lang].gitCommitVerify;
+		throw new Error(errorMsg);
+	}
+}
+
+//#endregion
+//#region src/commands/release.ts
+async function release(execute = "", push = true) {
+	await versionBump({
+		files: ["**/package.json", "!**/node_modules"],
+		execute,
+		all: true,
+		tag: true,
+		commit: "chore(projects): release v%s",
+		push
+	});
+}
+
+//#endregion
+//#region src/commands/update-pkg.ts
+async function updatePkg(args = ["--deep", "-u"]) {
+	execCommand("npx", ["npm-check-updates", ...args], { stdio: "inherit" });
+}
+
+//#endregion
+//#region src/index.ts
+async function setupCli() {
+	/**
+	* 初始化并注册 CLI
+	* - 加载配置，注册命令与选项
+	* - 设置中文提示与帮助文案
+	* @returns Promise<void>
+	*/
+	const cliOptions = await loadCliOptions();
+	const cli = cac(blue("quiteer-scripts"));
+	cli.version(lightGreen(version)).help();
+	cli.command("generate-config", "在项目根目录下生成配置文件").alias("g").action(async () => {
+		await generateConfig();
+	});
+	cli.command("remove [path]", "删除单个或者多个文件，多个值用逗号分隔，递归删除").alias("rm").action(async (paths) => {
+		if (paths && paths.includes(",")) await cleanup(paths.split(","));
+		else if (paths) await cleanup([paths]);
+		else console.info("quiteer-script :>> ", gray("无事发生"));
+	});
+	cli.command("cleanup [path]", "清除目录 node_modules、dist 等").alias("c").action(async (paths) => {
+		if (paths && paths.includes(",")) await cleanup(paths.split(","));
+		else if (paths) await cleanup([paths]);
+		else await cleanup(cliOptions.cleanupDirs);
+	});
+	cli.command("update-pkg", "更新 package.json 依赖版本").alias("u").action(async () => {
+		await updatePkg(cliOptions.ncuCommandArgs);
+	});
+	cli.command("git-commit", "git 提交前后的操作和规范等").alias("git-c").option("--add", "添加所有变更文件到暂存区", { default: true }).option("-l ,--lang", "校验提交信息的语言", { default: cliOptions.lang }).action(async (args) => {
+		if (args?.add) await gitCommitAdd();
+		await gitCommit(args?.lang);
+	});
+	cli.command("git-commit-verify", "校验提交信息是否符合 Conventional Commits 标准").alias("git-v").option("-l --lang", "校验提交信息的语言", { default: cliOptions.lang }).action(async (args) => {
+		await gitCommitVerify(args?.lang, cliOptions.gitCommitVerifyIgnores);
+	});
+	cli.command("release", "发布：更新版本、生成变更日志、提交代码").alias("r").option("--execute", "执行发布的命令").option("--push", "是否推送代码", { default: true }).action(async (args) => {
+		await release(args?.execute, args?.push);
+	});
+	cli.parse();
+}
+setupCli();
+
+//#endregion
+export { setupCli };

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@quiteer/scripts",
+  "type": "module",
+  "version": "0.0.1",
+  "homepage": "https://github.com/TaiAiAc/web",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./src/*"
+      ]
+    }
+  },
+  "bin": {
+    "quiteer": "./dist/index.mjs",
+    "qui": "./dist/index.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "bumpp": "10.3.1",
+    "c12": "3.3.2",
+    "cac": "6.7.14",
+    "consola": "3.4.2",
+    "enquirer": "2.4.1",
+    "execa": "9.6.0",
+    "kolorist": "1.8.0",
+    "npm-check-updates": "19.1.2",
+    "rimraf": "6.1.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.16.1",
+    "tsx": "^4.20.6"
+  },
+  "scripts": {
+    "dev": "tsdown -w",
+    "build": "tsdown",
+    "release": "pnpm publish"
+  }
+}