@varlet/release 1.0.0 → 1.0.2

package/dist/cli.js

@@ -3,7 +3,7 @@ import { changelog, commitLint, publish, release } from "./index.js";
 import { Command } from "commander";
 
 //#region package.json
-var version = "1.0.0";
+var version = "1.0.2";
 
 //#endregion
 //#region src/cli.ts

package/dist/index.d.ts

@@ -40,6 +40,7 @@ declare function changelog({
 }?: ChangelogCommandOptions): Promise<void>;
 //#endregion
 //#region src/commitLint.d.ts
+declare const COMMIT_HEADER_RE: RegExp;
 declare const COMMIT_MESSAGE_RE: RegExp;
 declare function isVersionCommitMessage(message: string): boolean;
 declare function getCommitMessage(commitMessagePath: string): string;
@@ -51,4 +52,4 @@ interface CommitLintCommandOptions {
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
 //#endregion
-export { COMMIT_MESSAGE_RE, ChangelogCommandOptions, CommitLintCommandOptions, PublishCommandOptions, ReleaseCommandOptions, changelog, commitLint, getAllPackageJsons, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };
+export { COMMIT_HEADER_RE, COMMIT_MESSAGE_RE, ChangelogCommandOptions, CommitLintCommandOptions, PublishCommandOptions, ReleaseCommandOptions, changelog, commitLint, getAllPackageJsons, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };

package/dist/index.js

@@ -7,48 +7,194 @@ import semver from "semver";
 import { x } from "tinyexec";
 import conventionalChangelog from "conventional-changelog";
 
+//#region src/commitLint.ts
+const { readFileSync } = fse;
+const COMMIT_HEADER_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor|merge|wip)(?:\(([^)]+)\))?(!)?:\s(.+)$/;
+const COMMIT_MESSAGE_RE = new RegExp(COMMIT_HEADER_RE.source.replace(/\$$/, "") + "(?:\\n[\\s\\S]+)?$");
+const ERROR_MESSAGE = "Commit message invalid.";
+const WARNING_MESSAGE = `\
+The rules for commit messages are as follows
+
+Example:
+
+feat: add a new feature
+feat(ui/button): add a new feature in the ui/button scope
+
+fix: fix a bug
+fix(ui/button): fix a bug in the ui/button scope
+
+docs: fix an error in the documentation
+docs(ui/button): fix a documentation error in the ui/button scope
+
+Allowed types:
+- fix
+- feat
+- docs
+- perf
+- test
+- types
+- style
+- build
+- chore
+- release
+- refactor
+- revert
+- merge
+- wip
+
+Commit message reference: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y
+参考阮一峰Commit message编写指南: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`;
+function isVersionCommitMessage(message) {
+	return Boolean(message.startsWith("v") && semver.valid(message.slice(1)));
+}
+function getCommitMessage(commitMessagePath) {
+	return readFileSync(commitMessagePath, "utf-8").trim();
+}
+function commitLint(options) {
+	const { commitMessagePath, commitMessageRe = COMMIT_MESSAGE_RE, errorMessage = ERROR_MESSAGE, warningMessage = WARNING_MESSAGE } = options;
+	if (!commitMessagePath) {
+		logger.error("commitMessagePath is required");
+		process.exit(1);
+	}
+	const commitMessage = getCommitMessage(commitMessagePath);
+	const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
+	if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
+		logger.error(errorMessage);
+		logger.warn(warningMessage);
+		process.exit(1);
+	}
+}
+
+//#endregion
 //#region src/changelog.ts
 const { createWriteStream } = fse;
-function changelog({ releaseCount = 0, file = "CHANGELOG.md", preset = "angular", writerOpts = { transform(commit, context) {
+const COMMIT_TYPE_MAP = {
+	feat: "Features",
+	fix: "Bug Fixes",
+	perf: "Performance Improvements",
+	revert: "Reverts",
+	refactor: "Code Refactoring",
+	docs: "Documentation",
+	style: "Styles",
+	test: "Tests",
+	build: "Build System",
+	ci: "Continuous Integration"
+};
+const ALWAYS_SHOW_TYPES = new Set([
+	"feat",
+	"fix",
+	"perf",
+	"revert",
+	"refactor"
+]);
+const BREAKING_CHANGE_RE = /BREAKING CHANGES?:\s*([\s\S]+)/;
+const MAIN_TEMPLATE = `{{> header}}
+
+{{> footer}}
+{{#each commitGroups}}
+
+{{#if title}}
+### {{title}}
+
+{{/if}}
+{{#each commits}}
+{{> commit root=@root}}
+{{/each}}
+
+{{/each}}
+`;
+function linkify(text, context, issues) {
+	let result = text;
+	const repoUrl = context.repository ? `${context.host}/${context.owner}/${context.repository}` : context.repoUrl;
+	if (repoUrl) {
+		const issueBaseUrl = `${repoUrl}/issues/`;
+		result = result.replace(/#([0-9]+)/g, (_, issue) => {
+			issues.push(issue);
+			return `[#${issue}](${issueBaseUrl}${issue})`;
+		});
+	}
+	if (context.host) result = result.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => username.includes("/") ? `@${username}` : `[@${username}](${context.host}/${username})`);
+	return result;
+}
+function extractBreakingText(commit) {
+	const body = typeof commit.body === "string" ? commit.body : "";
+	const footer = typeof commit.footer === "string" ? commit.footer : "";
+	const match = BREAKING_CHANGE_RE.exec(`${footer}\n${body}`);
+	if (match?.[1]) return match[1].trim();
+	if (typeof commit.subject === "string" && commit.subject) return commit.subject;
+	if (typeof commit.header === "string" && commit.header) return commit.header;
+	return "";
+}
+function tryParseHeader(commit) {
+	if (typeof commit.header !== "string") return null;
+	const match = COMMIT_HEADER_RE.exec(commit.header.trim());
+	if (!match) return null;
+	return {
+		type: match[1],
+		scope: match[2] || void 0,
+		subject: match[4] || void 0,
+		isBreaking: Boolean(match[3])
+	};
+}
+function processBreakingChanges(commit, context, issues) {
 	let discard = true;
-	const issues = [];
 	commit.notes.forEach((note) => {
 		note.title = "BREAKING CHANGES";
 		discard = false;
 	});
-	if (commit.type === "feat") commit.type = "Features";
-	else if (commit.type === "fix") commit.type = "Bug Fixes";
-	else if (commit.type === "perf") commit.type = "Performance Improvements";
-	else if (commit.type === "revert" || commit.revert) commit.type = "Reverts";
-	else if (commit.type === "refactor") commit.type = "Code Refactoring";
-	else if (discard) return false;
-	else if (commit.type === "docs") commit.type = "Documentation";
-	else if (commit.type === "style") commit.type = "Styles";
-	else if (commit.type === "test") commit.type = "Tests";
-	else if (commit.type === "build") commit.type = "Build System";
-	else if (commit.type === "ci") commit.type = "Continuous Integration";
-	if (commit.scope === "*") commit.scope = "";
-	if (typeof commit.hash === "string") commit.shortHash = commit.hash.substring(0, 7);
-	if (typeof commit.subject === "string") {
-		let url = context.repository ? `${context.host}/${context.owner}/${context.repository}` : context.repoUrl;
-		if (url) {
-			url = `${url}/issues/`;
-			commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-				issues.push(issue);
-				return `[#${issue}](${url}${issue})`;
+	const hadBreakingNotes = commit.notes.length > 0;
+	const addBreakingNote = () => {
+		if (!hadBreakingNotes) {
+			const text = linkify(extractBreakingText(commit), context, issues);
+			commit.notes.push({
+				title: "BREAKING CHANGES",
+				text
 			});
 		}
-		if (context.host) commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
-			if (username.includes("/")) return `@${username}`;
-			return `[@${username}](${context.host}/${username})`;
-		});
+		discard = false;
+	};
+	const parsed = tryParseHeader(commit);
+	if (parsed) {
+		if (!commit.type) commit.type = parsed.type;
+		if (!commit.scope && parsed.scope) commit.scope = parsed.scope;
+		if (!commit.subject && parsed.subject) commit.subject = parsed.subject;
+		if (parsed.isBreaking) addBreakingNote();
 	}
-	commit.references = commit.references.filter((reference) => {
-		if (issues.indexOf(reference.issue) === -1) return true;
-		return false;
-	});
-	return commit;
-} } } = {}) {
+	if (typeof commit.type === "string" && commit.type.endsWith("!")) {
+		commit.type = commit.type.slice(0, -1);
+		addBreakingNote();
+	}
+	return discard;
+}
+function mapCommitType(commit, discard) {
+	if (commit.revert) {
+		commit.type = "Reverts";
+		return true;
+	}
+	const mapped = COMMIT_TYPE_MAP[commit.type];
+	if (mapped) {
+		if (ALWAYS_SHOW_TYPES.has(commit.type) || !discard) {
+			commit.type = mapped;
+			return true;
+		}
+	}
+	return !discard;
+}
+function createDefaultWriterOpts() {
+	return {
+		mainTemplate: MAIN_TEMPLATE,
+		transform(commit, context) {
+			const issues = [];
+			if (!mapCommitType(commit, processBreakingChanges(commit, context, issues))) return false;
+			if (commit.scope === "*") commit.scope = "";
+			if (typeof commit.hash === "string") commit.shortHash = commit.hash.substring(0, 7);
+			if (typeof commit.subject === "string") commit.subject = linkify(commit.subject, context, issues);
+			commit.references = commit.references.filter((ref) => !issues.includes(ref.issue));
+			return commit;
+		}
+	};
+}
+function changelog({ releaseCount = 0, file = "CHANGELOG.md", preset = "angular", writerOpts = createDefaultWriterOpts() } = {}) {
 	const s = spinner();
 	s.start("Generating changelog");
 	return new Promise((resolve$1) => {
@@ -282,62 +428,4 @@ async function release(options) {
 }
 
 //#endregion
-//#region src/commitLint.ts
-const { readFileSync } = fse;
-const COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor|merge|wip)(\(.+\))?!?: (.|\n)+/;
-const ERROR_MESSAGE = "Commit message invalid.";
-const WARNING_MESSAGE = `\
-The rules for commit messages are as follows
-
-Example:
-
-feat: add a new feature
-feat(ui/button): add a new feature in the ui/button scope
-
-fix: fix a bug
-fix(ui/button): fix a bug in the ui/button scope
-
-docs: fix an error in the documentation
-docs(ui/button): fix a documentation error in the ui/button scope
-
-Allowed types:
-- fix
-- feat
-- docs
-- perf
-- test
-- types
-- style
-- build
-- chore
-- release
-- refactor
-- revert
-- merge
-- wip
-
-Commit message reference: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y
-参考阮一峰Commit message编写指南: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`;
-function isVersionCommitMessage(message) {
-	return Boolean(message.startsWith("v") && semver.valid(message.slice(1)));
-}
-function getCommitMessage(commitMessagePath) {
-	return readFileSync(commitMessagePath, "utf-8").trim();
-}
-function commitLint(options) {
-	const { commitMessagePath, commitMessageRe = COMMIT_MESSAGE_RE, errorMessage = ERROR_MESSAGE, warningMessage = WARNING_MESSAGE } = options;
-	if (!commitMessagePath) {
-		logger.error("commitMessagePath is required");
-		process.exit(1);
-	}
-	const commitMessage = getCommitMessage(commitMessagePath);
-	const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
-	if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
-		logger.error(errorMessage);
-		logger.warn(warningMessage);
-		process.exit(1);
-	}
-}
-
-//#endregion
-export { COMMIT_MESSAGE_RE, changelog, commitLint, getAllPackageJsons, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };
+export { COMMIT_HEADER_RE, COMMIT_MESSAGE_RE, changelog, commitLint, getAllPackageJsons, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/release",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "publish all packages, generate changelogs and check commit messages",
   "keywords": [
     "changelog",
@@ -35,10 +35,11 @@
   },
   "lint-staged": {
     "*.{md}": "prettier --write",
-    "*.{ts}": [
+    "*.{ts,js}": [
       "prettier --write",
       "eslint --fix"
-    ]
+    ],
+    "package.json": "prettier --write"
   },
   "dependencies": {
     "@clack/prompts": "^1.0.0",