alex-c-line 2.0.2 → 2.0.3

package/dist/index.cjs

@@ -826,7 +826,7 @@ function root(program) {
 	});
 }
 //#endregion
-//#region src/utility/markdownTemplates/pullRequest/getPullRequestTemplatesFromMarkdown.ts
+//#region src/utility/markdownTemplates/pullRequest/createPullRequestTemplatesFromTemplates.ts
 const __filename$2 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
 function getTemplateVariables$1(config) {
 	if (config.category === "general") return {
@@ -839,7 +839,7 @@ function getTemplateVariables$1(config) {
 		requireConfirmationFrom: config.requireConfirmationFrom
 	};
 }
-async function getPullRequestTemplatesFromMarkdown(config) {
+async function createPullRequestTemplatesFromTemplates(config) {
 	const templateVariables = getTemplateVariables$1(config);
 	const { category } = config;
 	const templatesPath = node_path.default.join(await findPackageRoot(node_path.default.dirname(__filename$2), "alex-c-line"), "templates", "pullRequest");
@@ -883,7 +883,7 @@ function templatePullRequestCreate(program) {
 		}));
 		const gitHubPath = node_path.default.join(process.cwd(), ".github");
 		const pullRequestTemplatePath = node_path.default.join(gitHubPath, "PULL_REQUEST_TEMPLATE");
-		const allTemplates = await getPullRequestTemplatesFromMarkdown({
+		const allTemplates = await createPullRequestTemplatesFromTemplates({
 			...parsedOptions,
 			projectName
 		});
@@ -924,17 +924,6 @@ function parseReleaseStatus(data) {
 	return ReleaseStatus[normalisedStringifiedData];
 }
 //#endregion
-//#region src/utility/markdownTemplates/createMarkdownComment.ts
-function createMarkdownComment(comment) {
-	if (comment.startsWith("<!--") && comment.endsWith("-->")) return comment;
-	return `<!-- ${comment} -->`;
-}
-//#endregion
-//#region src/utility/markdownTemplates/createMarkdownCommentPair.ts
-function createMarkdownCommentPair(comment) {
-	return [createMarkdownComment(`${comment}-start`), createMarkdownComment(`${comment}-end`)];
-}
-//#endregion
 //#region src/utility/markdownTemplates/getMarkdownBlock.ts
 function getMarkdownBlock(content, startMarker, endMarker) {
 	const startIndex = content.indexOf(startMarker);
@@ -943,6 +932,17 @@ function getMarkdownBlock(content, startMarker, endMarker) {
 	return content.slice(startIndex + startMarker.length, endIndex).trim();
 }
 //#endregion
+//#region src/utility/markdownTemplates/getMarkdownComment.ts
+function createMarkdownComment(comment) {
+	if (comment.startsWith("<!--") && comment.endsWith("-->")) return comment;
+	return `<!-- ${comment} -->`;
+}
+//#endregion
+//#region src/utility/markdownTemplates/getMarkdownCommentPair.ts
+function getMarkdownCommentPair(comment) {
+	return [createMarkdownComment(`${comment}-start`), createMarkdownComment(`${comment}-end`)];
+}
+//#endregion
 //#region src/utility/markdownTemplates/normaliseMarkdown.ts
 function normaliseMarkdown(markdownString) {
 	return markdownString.replace(/\r\n/g, "\n").split("\n").map((line) => {
@@ -952,7 +952,7 @@ function normaliseMarkdown(markdownString) {
 //#endregion
 //#region src/utility/markdownTemplates/releaseNote/getReleaseStatus.ts
 function getReleaseStatus(content) {
-	const releaseStatus = getMarkdownBlock(content, ...createMarkdownCommentPair("alex-c-line-release-status"));
+	const releaseStatus = getMarkdownBlock(content, ...getMarkdownCommentPair("alex-c-line-release-status"));
 	if (releaseStatus === null) throw new _alextheman_utility.DataError({ releaseStatus }, "RELEASE_STATUS_NOT_FOUND", "Could not find release status in document.");
 	return (0, _alextheman_utility.parseZodSchema)(zod.default.enum(ReleaseStatus), normaliseMarkdown(releaseStatus.split(":")[1]));
 }
@@ -975,7 +975,7 @@ async function validateReleaseDocument(projectName, version, content, allowedRel
         Expected: ${allowedReleaseStatuses.length === 1 ? `"${allowedReleaseStatus}"` : `one of: ${allowedReleaseStatuses.map((status) => {
 		return `"${status}"`;
 	}).join(", ")}`}`);
-	const releaseSummaryHeaders = createMarkdownCommentPair("alex-c-line-release-summary");
+	const releaseSummaryHeaders = getMarkdownCommentPair("alex-c-line-release-summary");
 	const summary = getMarkdownBlock(content, ...releaseSummaryHeaders);
 	const templateContent = await (0, node_fs_promises.readFile)(node_path.default.join(await findPackageRoot(node_path.default.dirname(__filename$1), "alex-c-line"), "templates", "releases", `${version.type}.md`), "utf-8");
 	const templateSummary = getMarkdownBlock(templateContent, ...releaseSummaryHeaders)?.replaceAll(`{{projectName}}`, projectName);
@@ -1014,11 +1014,6 @@ function templateReleaseNoteCheck(program) {
 	});
 }
 //#endregion
-//#region src/utility/markdownTemplates/releaseNote/getReleaseNotePath.ts
-function getReleaseNotePath(versionNumber) {
-	return node_path.default.join("docs", "releases", versionNumber.format({ omitMinor: true }), versionNumber.format({ omitPatch: true }), `${versionNumber}.md`);
-}
-//#endregion
 //#region src/utility/markdownTemplates/getReleaseNoteTemplatesPath.ts
 async function getReleaseNoteTemplatesPath() {
 	return node_path.default.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "releases");
@@ -1042,7 +1037,7 @@ function replaceMarkdownPlaceholders(rawContent, templateVariables) {
 	return finalContent;
 }
 //#endregion
-//#region src/utility/markdownTemplates/releaseNote/getReleaseNoteTemplateFromMarkdown.ts
+//#region src/utility/markdownTemplates/releaseNote/createReleaseNoteFromTemplates.ts
 async function getTemplateVariables(projectName, version, templateVariables) {
 	if ("editableSection" in templateVariables && templateVariables.editableSection) {
 		const { status = "In progress", editableSection } = templateVariables;
@@ -1066,12 +1061,17 @@ async function getTemplateVariables(projectName, version, templateVariables) {
 		editableSection
 	};
 }
-async function getReleaseNoteTemplateFromMarkdown(projectName, version, metadata) {
+async function createReleaseNoteFromTemplates(projectName, version, metadata) {
 	const templateVariables = await getTemplateVariables(projectName, version, metadata);
 	const templatesPath = node_path.default.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "releases");
 	return replaceMarkdownPlaceholders(await (0, node_fs_promises.readFile)(node_path.default.join(templatesPath, `${version.type}.md`), "utf-8"), templateVariables);
 }
 //#endregion
+//#region src/utility/markdownTemplates/releaseNote/getReleaseNotePath.ts
+function getReleaseNotePath(versionNumber) {
+	return node_path.default.join("docs", "releases", versionNumber.format({ omitMinor: true }), versionNumber.format({ omitPatch: true }), `${versionNumber}.md`);
+}
+//#endregion
 //#region src/cli/commands/template/releaseNote/create.ts
 function templateReleaseNoteCreate(program) {
 	program.command("create").argument("[createFor]", _alextheman_utility.normaliseIndents`
@@ -1093,7 +1093,7 @@ function templateReleaseNoteCreate(program) {
 		}), packageInfo);
 		const versionNumber = target instanceof _alextheman_utility.VersionNumber ? target : target ? new _alextheman_utility.VersionNumber(packageVersion).increment(target) : new _alextheman_utility.VersionNumber(packageVersion);
 		const releaseNotePath = getReleaseNotePath(versionNumber);
-		const releaseNoteTemplate = await getReleaseNoteTemplateFromMarkdown(name, versionNumber, { status: "In progress" });
+		const releaseNoteTemplate = await createReleaseNoteFromTemplates(name, versionNumber, { status: "In progress" });
 		try {
 			await (0, node_fs_promises.mkdir)(node_path.default.dirname(releaseNotePath), { recursive: true });
 			await (0, node_fs_promises.writeFile)(releaseNotePath, releaseNoteTemplate, { flag: "wx" });
@@ -1189,13 +1189,13 @@ function templateReleaseNoteSetStatus(program) {
 		const fullDocumentPath = node_path.default.join(process.cwd(), documentPath);
 		const initialDocument = await (0, node_fs_promises.readFile)(fullDocumentPath, "utf-8");
 		await validateReleaseDocument(name, versionNumber, initialDocument);
-		const [userEditableSectionStart, userEditableSectionEnd] = createMarkdownCommentPair("user-editable-section");
+		const [userEditableSectionStart, userEditableSectionEnd] = getMarkdownCommentPair("user-editable-section");
 		const editableSection = getMarkdownBlock(initialDocument, userEditableSectionStart, userEditableSectionEnd);
 		if (editableSection === null) throw new _alextheman_utility.DataError({
 			startMarker: userEditableSectionStart,
 			endMarker: userEditableSectionEnd
 		}, "EDITABLE_SECTION_NOT_FOUND", "Could not find editable section in the provided document.");
-		await (0, node_fs_promises.writeFile)(fullDocumentPath, await getReleaseNoteTemplateFromMarkdown(name, versionNumber, {
+		await (0, node_fs_promises.writeFile)(fullDocumentPath, await createReleaseNoteFromTemplates(name, versionNumber, {
 			status,
 			editableSection
 		}));
@@ -1224,7 +1224,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.0.2";
+var version$1 = "2.0.3";
 var description = "Command-line tool with commands to streamline the developer workflow.";
 //#endregion
 //#region src/utility/updates/checkUpdate.ts

package/dist/index.js

@@ -796,7 +796,7 @@ function root(program) {
 	});
 }
 //#endregion
-//#region src/utility/markdownTemplates/pullRequest/getPullRequestTemplatesFromMarkdown.ts
+//#region src/utility/markdownTemplates/pullRequest/createPullRequestTemplatesFromTemplates.ts
 const __filename$1 = fileURLToPath(import.meta.url);
 function getTemplateVariables$1(config) {
 	if (config.category === "general") return {
@@ -809,7 +809,7 @@ function getTemplateVariables$1(config) {
 		requireConfirmationFrom: config.requireConfirmationFrom
 	};
 }
-async function getPullRequestTemplatesFromMarkdown(config) {
+async function createPullRequestTemplatesFromTemplates(config) {
 	const templateVariables = getTemplateVariables$1(config);
 	const { category } = config;
 	const templatesPath = path.join(await findPackageRoot(path.dirname(__filename$1), "alex-c-line"), "templates", "pullRequest");
@@ -853,7 +853,7 @@ function templatePullRequestCreate(program) {
 		}));
 		const gitHubPath = path.join(process.cwd(), ".github");
 		const pullRequestTemplatePath = path.join(gitHubPath, "PULL_REQUEST_TEMPLATE");
-		const allTemplates = await getPullRequestTemplatesFromMarkdown({
+		const allTemplates = await createPullRequestTemplatesFromTemplates({
 			...parsedOptions,
 			projectName
 		});
@@ -894,17 +894,6 @@ function parseReleaseStatus(data) {
 	return ReleaseStatus[normalisedStringifiedData];
 }
 //#endregion
-//#region src/utility/markdownTemplates/createMarkdownComment.ts
-function createMarkdownComment(comment) {
-	if (comment.startsWith("<!--") && comment.endsWith("-->")) return comment;
-	return `<!-- ${comment} -->`;
-}
-//#endregion
-//#region src/utility/markdownTemplates/createMarkdownCommentPair.ts
-function createMarkdownCommentPair(comment) {
-	return [createMarkdownComment(`${comment}-start`), createMarkdownComment(`${comment}-end`)];
-}
-//#endregion
 //#region src/utility/markdownTemplates/getMarkdownBlock.ts
 function getMarkdownBlock(content, startMarker, endMarker) {
 	const startIndex = content.indexOf(startMarker);
@@ -913,6 +902,17 @@ function getMarkdownBlock(content, startMarker, endMarker) {
 	return content.slice(startIndex + startMarker.length, endIndex).trim();
 }
 //#endregion
+//#region src/utility/markdownTemplates/getMarkdownComment.ts
+function createMarkdownComment(comment) {
+	if (comment.startsWith("<!--") && comment.endsWith("-->")) return comment;
+	return `<!-- ${comment} -->`;
+}
+//#endregion
+//#region src/utility/markdownTemplates/getMarkdownCommentPair.ts
+function getMarkdownCommentPair(comment) {
+	return [createMarkdownComment(`${comment}-start`), createMarkdownComment(`${comment}-end`)];
+}
+//#endregion
 //#region src/utility/markdownTemplates/normaliseMarkdown.ts
 function normaliseMarkdown(markdownString) {
 	return markdownString.replace(/\r\n/g, "\n").split("\n").map((line) => {
@@ -922,7 +922,7 @@ function normaliseMarkdown(markdownString) {
 //#endregion
 //#region src/utility/markdownTemplates/releaseNote/getReleaseStatus.ts
 function getReleaseStatus(content) {
-	const releaseStatus = getMarkdownBlock(content, ...createMarkdownCommentPair("alex-c-line-release-status"));
+	const releaseStatus = getMarkdownBlock(content, ...getMarkdownCommentPair("alex-c-line-release-status"));
 	if (releaseStatus === null) throw new DataError({ releaseStatus }, "RELEASE_STATUS_NOT_FOUND", "Could not find release status in document.");
 	return parseZodSchema(z.enum(ReleaseStatus), normaliseMarkdown(releaseStatus.split(":")[1]));
 }
@@ -945,7 +945,7 @@ async function validateReleaseDocument(projectName, version, content, allowedRel
         Expected: ${allowedReleaseStatuses.length === 1 ? `"${allowedReleaseStatus}"` : `one of: ${allowedReleaseStatuses.map((status) => {
 		return `"${status}"`;
 	}).join(", ")}`}`);
-	const releaseSummaryHeaders = createMarkdownCommentPair("alex-c-line-release-summary");
+	const releaseSummaryHeaders = getMarkdownCommentPair("alex-c-line-release-summary");
 	const summary = getMarkdownBlock(content, ...releaseSummaryHeaders);
 	const templateContent = await readFile(path.join(await findPackageRoot(path.dirname(__filename), "alex-c-line"), "templates", "releases", `${version.type}.md`), "utf-8");
 	const templateSummary = getMarkdownBlock(templateContent, ...releaseSummaryHeaders)?.replaceAll(`{{projectName}}`, projectName);
@@ -984,11 +984,6 @@ function templateReleaseNoteCheck(program) {
 	});
 }
 //#endregion
-//#region src/utility/markdownTemplates/releaseNote/getReleaseNotePath.ts
-function getReleaseNotePath(versionNumber) {
-	return path.join("docs", "releases", versionNumber.format({ omitMinor: true }), versionNumber.format({ omitPatch: true }), `${versionNumber}.md`);
-}
-//#endregion
 //#region src/utility/markdownTemplates/getReleaseNoteTemplatesPath.ts
 async function getReleaseNoteTemplatesPath() {
 	return path.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "releases");
@@ -1012,7 +1007,7 @@ function replaceMarkdownPlaceholders(rawContent, templateVariables) {
 	return finalContent;
 }
 //#endregion
-//#region src/utility/markdownTemplates/releaseNote/getReleaseNoteTemplateFromMarkdown.ts
+//#region src/utility/markdownTemplates/releaseNote/createReleaseNoteFromTemplates.ts
 async function getTemplateVariables(projectName, version, templateVariables) {
 	if ("editableSection" in templateVariables && templateVariables.editableSection) {
 		const { status = "In progress", editableSection } = templateVariables;
@@ -1036,12 +1031,17 @@ async function getTemplateVariables(projectName, version, templateVariables) {
 		editableSection
 	};
 }
-async function getReleaseNoteTemplateFromMarkdown(projectName, version, metadata) {
+async function createReleaseNoteFromTemplates(projectName, version, metadata) {
 	const templateVariables = await getTemplateVariables(projectName, version, metadata);
 	const templatesPath = path.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "releases");
 	return replaceMarkdownPlaceholders(await readFile(path.join(templatesPath, `${version.type}.md`), "utf-8"), templateVariables);
 }
 //#endregion
+//#region src/utility/markdownTemplates/releaseNote/getReleaseNotePath.ts
+function getReleaseNotePath(versionNumber) {
+	return path.join("docs", "releases", versionNumber.format({ omitMinor: true }), versionNumber.format({ omitPatch: true }), `${versionNumber}.md`);
+}
+//#endregion
 //#region src/cli/commands/template/releaseNote/create.ts
 function templateReleaseNoteCreate(program) {
 	program.command("create").argument("[createFor]", normaliseIndents`
@@ -1063,7 +1063,7 @@ function templateReleaseNoteCreate(program) {
 		}), packageInfo);
 		const versionNumber = target instanceof VersionNumber ? target : target ? new VersionNumber(packageVersion).increment(target) : new VersionNumber(packageVersion);
 		const releaseNotePath = getReleaseNotePath(versionNumber);
-		const releaseNoteTemplate = await getReleaseNoteTemplateFromMarkdown(name, versionNumber, { status: "In progress" });
+		const releaseNoteTemplate = await createReleaseNoteFromTemplates(name, versionNumber, { status: "In progress" });
 		try {
 			await mkdir(path.dirname(releaseNotePath), { recursive: true });
 			await writeFile(releaseNotePath, releaseNoteTemplate, { flag: "wx" });
@@ -1159,13 +1159,13 @@ function templateReleaseNoteSetStatus(program) {
 		const fullDocumentPath = path.join(process.cwd(), documentPath);
 		const initialDocument = await readFile(fullDocumentPath, "utf-8");
 		await validateReleaseDocument(name, versionNumber, initialDocument);
-		const [userEditableSectionStart, userEditableSectionEnd] = createMarkdownCommentPair("user-editable-section");
+		const [userEditableSectionStart, userEditableSectionEnd] = getMarkdownCommentPair("user-editable-section");
 		const editableSection = getMarkdownBlock(initialDocument, userEditableSectionStart, userEditableSectionEnd);
 		if (editableSection === null) throw new DataError({
 			startMarker: userEditableSectionStart,
 			endMarker: userEditableSectionEnd
 		}, "EDITABLE_SECTION_NOT_FOUND", "Could not find editable section in the provided document.");
-		await writeFile(fullDocumentPath, await getReleaseNoteTemplateFromMarkdown(name, versionNumber, {
+		await writeFile(fullDocumentPath, await createReleaseNoteFromTemplates(name, versionNumber, {
 			status,
 			editableSection
 		}));
@@ -1194,7 +1194,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.0.2";
+var version$1 = "2.0.3";
 var description = "Command-line tool with commands to streamline the developer workflow.";
 //#endregion
 //#region src/utility/updates/checkUpdate.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alex-c-line",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Command-line tool with commands to streamline the developer workflow.",
   "repository": {
     "type": "git",

package/templates/pullRequest/infrastructure/base.md

@@ -5,8 +5,6 @@ placeholders:
 - projectName
 - infrastructureProvider
 ---
-
-
 # Select a Template
 
 Please select the option that best describes your changes to `{{projectName}}`:

package/templates/pullRequest/infrastructure/bug_fix.md

@@ -4,7 +4,6 @@ category: infrastructure
 placeholders:
 - projectName
 ---
-
 # Bug Fix
 
 This is a bug fix for `{{projectName}}`. It fixes an unintended side-effect of the configuration or deployment.

package/templates/pullRequest/infrastructure/documentation_change.md

@@ -4,7 +4,6 @@ category: infrastructure
 placeholders:
 - projectName
 ---
-
 # Documentation Change
 
 This is a change to the documentation of `{{projectName}}`. It changes the way that information about the repository is presented to users.

package/templates/pullRequest/infrastructure/irreversible_destruction.md

@@ -5,7 +5,6 @@ placeholders:
 - projectName
 - infrastructureProvider
 ---
-
 # Irreversible Destruction
 
 This is a change to `{{projectName}}` that irreversibly destroys a managed {{infrastructureProvider}} resource. This change can **NOT** be fixed by simply reverting back the changes as it will try recreating the resource entirely and there is no guarantee that it will be restored back to the same state it was previously in.

package/templates/pullRequest/infrastructure/manual_change.md

@@ -6,7 +6,6 @@ placeholders:
 - infrastructureProvider
 - requireConfirmationFrom
 ---
-
 # Manual Change
 
 This is a change to `{{projectName}}` that requires manual changes to the managed {{infrastructureProvider}} resources. {{requireConfirmationFrom}} **MUST** confirm by approval (or authorship of pull request) that these changes have been made before this can be merged in.

package/templates/pullRequest/infrastructure/miscellaneous.md

@@ -4,7 +4,6 @@ category: infrastructure
 placeholders:
 - projectName
 ---
-
 # Miscellaneous
 
 This is a general change to `{{projectName}}` that does not fit in any of the other provided categories.

package/templates/pullRequest/infrastructure/new_feature.md

@@ -5,7 +5,6 @@ placeholders:
 - projectName
 - infrastructureProvider
 ---
-
 # New Feature
 
 This is a new feature for `{{projectName}}` that adds a new {{infrastructureProvider}}-managed resource.

package/templates/pullRequest/infrastructure/refactor.md

@@ -4,7 +4,6 @@ category: infrastructure
 placeholders:
 - projectName
 ---
-
 # Refactor
 
 This is a change to the code layout of `{{projectName}}`. It changes how the code is presented in terms of quality and structure without changing the overall plan.

package/templates/pullRequest/infrastructure/resource_update.md

@@ -5,7 +5,6 @@ placeholders:
 - projectName
 - infrastructureProvider
 ---
-
 # Resource Update
 
 This is a change to an existing resource in `{{projectName}}` in the {{infrastructureProvider}} plan. It changes the currently managed state without removing or adding anything else to the plan.

package/templates/pullRequest/infrastructure/tooling_change.md

@@ -4,7 +4,6 @@ category: infrastructure
 placeholders:
 - projectName
 ---
-
 # Tooling Change
 
 This is a change to the tooling of `{{projectName}}`. It changes the internal workings of the repository and should have no noticeable effect on the plan.