alex-c-line 2.10.2 → 2.11.0

package/dist/configs/internal/index.d.cts

@@ -65,6 +65,7 @@ declare let scripts: {
   command: string;
   "create-local-package": string;
   "create-release-note": string;
+  dev: string;
   format: string;
   "format-eslint": string;
   "format-markdownlint": string;

package/dist/configs/internal/index.d.ts

@@ -65,6 +65,7 @@ declare let scripts: {
   command: string;
   "create-local-package": string;
   "create-release-note": string;
+  dev: string;
   format: string;
   "format-eslint": string;
   "format-markdownlint": string;

package/dist/index.cjs

@@ -303,13 +303,33 @@ async function findPackageRoot(startDirectory, packageName) {
 const __filename$3 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
 const ALEX_C_LINE_PACKAGE_ROOT = findPackageRoot(node_path.default.dirname(__filename$3), "alex-c-line");
 //#endregion
+//#region src/utility/licenses/resolveLicense.ts
+function resolveLicense(license) {
+	return license.replaceAll(/[()]/g, "").split(/\s+OR\s+/).map((part) => {
+		return part.trim();
+	});
+}
+//#endregion
+//#region src/utility/licenses/isValidLicense.ts
+function isValidLicense(license, allowedLicenses) {
+	return resolveLicense(license).some((license) => {
+		return allowedLicenses.includes(license);
+	});
+}
+//#endregion
 //#region src/cli/commands/internal/dependency-audit/helpers/getLicenseCheck.ts
 const ALLOWED_LICENSES = [
 	"MIT",
+	"MIT-0",
 	"ISC",
 	"Apache-2.0",
 	"BSD-2-Clause",
-	"BSD-3-Clause"
+	"BSD-3-Clause",
+	"BlueOak-1.0.0",
+	"Python-2.0",
+	"0BSD",
+	"Unlicense",
+	"CC0-1.0"
 ];
 const pnpmLicensesSchema = zod.default.record(zod.default.string(), zod.default.array(zod.default.object({
 	name: zod.default.string(),
@@ -336,7 +356,7 @@ async function getLicenseCheck(program) {
 		return summaryTableRowTemplate.replace("{{license}}", (0, _alextheman_utility.escapeHTML)(license)).replace("{{count}}", (0, _alextheman_utility.escapeHTML)(data.length.toString()));
 	}).join("\n"));
 	const invalidLicenses = licenseEntries.filter(([license, _]) => {
-		return !ALLOWED_LICENSES.includes(license);
+		return !isValidLicense(license, ALLOWED_LICENSES);
 	});
 	let invalidSummary;
 	if (invalidLicenses.length === 0) invalidSummary = "No licenses requiring review.";
@@ -581,7 +601,7 @@ async function readdirSafe(path) {
 //#region src/cli/commands/internal/media/generate.ts
 function internalMediaGenerate(program) {
 	program.command("generate").argument("[target]", "The directory to generate from.", process.cwd()).option("--ignore <ignore>", "Extra directories to ignore as comma-separated list.").option("-r --resolution <resolution>", "The resolution of the rendered scenes, with a comma between width and height.").action(async (target, { ignore, resolution }) => {
-		const ignored = new Set([
+		const ignored = /* @__PURE__ */ new Set([
 			".git",
 			"node_modules",
 			"__pycache__",
@@ -1081,6 +1101,58 @@ function root(program) {
 	});
 }
 //#endregion
+//#region src/cli/commands/template/changeRequest/helpers/resolveBasename.ts
+function resolveBasename(basename) {
+	return basename.trim().replace(/[.!?/]+$/, "").toLowerCase().replace(/\s+/g, "_");
+}
+//#endregion
+//#region src/utility/fileSystem/getNextFileName.ts
+function getNextFileName(directoryContents, newFileName) {
+	const extension = node_path.default.extname(newFileName);
+	const baseName = node_path.default.basename(newFileName, extension);
+	const fileRegex = new RegExp(String.raw`^${(0, _alextheman_utility.escapeRegexPattern)(baseName)}(?:_(\d+))?${(0, _alextheman_utility.escapeRegexPattern)(extension)}$`);
+	const matches = directoryContents.map((fileName) => {
+		return fileName.match(fileRegex);
+	}).filter((match) => {
+		return match !== null;
+	});
+	if (matches.length === 0) return newFileName;
+	const highestSuffix = Math.max(...matches.map((match) => {
+		return match[1] === void 0 ? 0 : (0, _alextheman_utility.parseIntStrict)(match[1]);
+	}));
+	return highestSuffix === 0 ? `${baseName}_1${extension}` : `${baseName}_${highestSuffix + 1}${extension}`;
+}
+//#endregion
+//#region src/utility/markdownTemplates/replaceMarkdownPlaceholders.ts
+function replaceMarkdownPlaceholders(rawContent, templateVariables) {
+	const { content, data } = (0, gray_matter.default)(rawContent);
+	const placeholders = _alextheman_utility.az.with(zod.default.array(zod.default.string()).default([])).parse(data.placeholders);
+	let finalContent = content;
+	for (const placeholder of placeholders) {
+		if (!(placeholder in templateVariables)) throw new _alextheman_utility_v6.DataError({ placeholder }, "INVALID_PLACEHOLDER", "The placeholder found in frontmatter can not be found in the metadata.");
+		finalContent = finalContent.replaceAll(`{{${placeholder}}}`, templateVariables[placeholder]);
+	}
+	return finalContent;
+}
+//#endregion
+//#region src/cli/commands/template/changeRequest/create.ts
+function templateChangeRequestCreate(program) {
+	program.command("create").description("Generate a change request document.").requiredOption("-p, --project-name <projectName>", "The project to request a change for.").requiredOption("-r, --reason <reason>", "The reason for the change.").option("-d, --description <description>", "A further description of the change.", "Redeploy the service.").requiredOption("-q, --requested-by <requestedBy>", "The user making the change request.").option("-o, --output-directory <outputDirectory>", "The directory to output the document in. The name of the document is determined by the reason.", node_path.default.join("docs", "changeRequests")).action(async ({ outputDirectory, ...templateVariables }) => {
+		const resolvedOutputDirectory = node_path.default.resolve(outputDirectory);
+		const newDocumentContents = replaceMarkdownPlaceholders(await (0, node_fs_promises.readFile)(node_path.default.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "changeRequest", "template.md"), "utf-8"), templateVariables);
+		await (0, node_fs_promises.mkdir)(resolvedOutputDirectory, { recursive: true });
+		const newFileName = getNextFileName(await (0, node_fs_promises.readdir)(resolvedOutputDirectory), `${resolveBasename(templateVariables.reason)}.md`);
+		const outputPath = node_path.default.join(resolvedOutputDirectory, newFileName);
+		await (0, node_fs_promises.writeFile)(outputPath, newDocumentContents);
+		console.info(`Change document successfully written to \`${outputPath}\`.`);
+	});
+}
+//#endregion
+//#region src/cli/commands/template/changeRequest/index.ts
+function templateChangeRequest(program) {
+	loadCommands(program.command("change-request").description("Manage change request documents."), { templateChangeRequestCreate });
+}
+//#endregion
 //#region src/utility/markdownTemplates/pullRequest/createPullRequestTemplatesFromTemplates.ts
 const __filename$2 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
 function getTemplateVariables$1(config) {
@@ -1277,18 +1349,6 @@ async function getEditableSectionFromTemplate(version) {
 	return await (0, node_fs_promises.readFile)(node_path.default.join(templatesPath, version.type === "major" ? "editableSectionMajor.md" : "editableSection.md"), "utf-8");
 }
 //#endregion
-//#region src/utility/markdownTemplates/replaceMarkdownPlaceholders.ts
-function replaceMarkdownPlaceholders(rawContent, templateVariables) {
-	const { content, data } = (0, gray_matter.default)(rawContent);
-	const placeholders = _alextheman_utility.az.with(zod.default.array(zod.default.string()).default([])).parse(data.placeholders);
-	let finalContent = content;
-	for (const placeholder of placeholders) {
-		if (!(placeholder in templateVariables)) throw new _alextheman_utility_v6.DataError({ placeholder }, "INVALID_PLACEHOLDER", "The placeholder found in frontmatter can not be found in the metadata.");
-		finalContent = finalContent.replaceAll(`{{${placeholder}}}`, templateVariables[placeholder]);
-	}
-	return finalContent;
-}
-//#endregion
 //#region src/utility/markdownTemplates/releaseNote/createReleaseNoteFromTemplates.ts
 async function getTemplateVariables(projectName, version, templateVariables) {
 	if ("editableSection" in templateVariables && templateVariables.editableSection) {
@@ -1416,6 +1476,7 @@ function templateReleaseNote(program) {
 //#region src/cli/commands/template/index.ts
 function template(program) {
 	loadCommands(program.command("template").description("Manage the automatically-generatable template files."), {
+		templateChangeRequest,
 		templatePullRequest,
 		templateReleaseNote
 	});
@@ -1423,7 +1484,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.10.2";
+var version$1 = "2.11.0";
 var description = "Command-line tool with commands to streamline the developer workflow.";
 //#endregion
 //#region src/utility/updates/checkUpdate.ts

package/dist/index.js

@@ -7,7 +7,7 @@ import boxen from "boxen";
 import figlet from "figlet";
 import envPaths from "env-paths";
 import path from "node:path";
-import { ONE_DAY_IN_MILLISECONDS, VersionNumber, az, escapeHTML, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, parseVersionType, removeDuplicates, removeUndefinedFromObject, sortBy, stringifyDotenv } from "@alextheman/utility";
+import { ONE_DAY_IN_MILLISECONDS, VersionNumber, az, escapeHTML, escapeRegexPattern, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, parseIntStrict, parseVersionType, removeDuplicates, removeUndefinedFromObject, sortBy, stringifyDotenv } from "@alextheman/utility";
 import { confirm, input, password, select } from "@inquirer/prompts";
 import { access, mkdir, readFile, readdir, rm, stat, writeFile } from "node:fs/promises";
 import { parse } from "dotenv";
@@ -272,13 +272,33 @@ async function findPackageRoot(startDirectory, packageName) {
 const __filename$2 = fileURLToPath(import.meta.url);
 const ALEX_C_LINE_PACKAGE_ROOT = findPackageRoot(path.dirname(__filename$2), "alex-c-line");
 //#endregion
+//#region src/utility/licenses/resolveLicense.ts
+function resolveLicense(license) {
+	return license.replaceAll(/[()]/g, "").split(/\s+OR\s+/).map((part) => {
+		return part.trim();
+	});
+}
+//#endregion
+//#region src/utility/licenses/isValidLicense.ts
+function isValidLicense(license, allowedLicenses) {
+	return resolveLicense(license).some((license) => {
+		return allowedLicenses.includes(license);
+	});
+}
+//#endregion
 //#region src/cli/commands/internal/dependency-audit/helpers/getLicenseCheck.ts
 const ALLOWED_LICENSES = [
 	"MIT",
+	"MIT-0",
 	"ISC",
 	"Apache-2.0",
 	"BSD-2-Clause",
-	"BSD-3-Clause"
+	"BSD-3-Clause",
+	"BlueOak-1.0.0",
+	"Python-2.0",
+	"0BSD",
+	"Unlicense",
+	"CC0-1.0"
 ];
 const pnpmLicensesSchema = z.record(z.string(), z.array(z.object({
 	name: z.string(),
@@ -305,7 +325,7 @@ async function getLicenseCheck(program) {
 		return summaryTableRowTemplate.replace("{{license}}", escapeHTML(license)).replace("{{count}}", escapeHTML(data.length.toString()));
 	}).join("\n"));
 	const invalidLicenses = licenseEntries.filter(([license, _]) => {
-		return !ALLOWED_LICENSES.includes(license);
+		return !isValidLicense(license, ALLOWED_LICENSES);
 	});
 	let invalidSummary;
 	if (invalidLicenses.length === 0) invalidSummary = "No licenses requiring review.";
@@ -550,7 +570,7 @@ async function readdirSafe(path) {
 //#region src/cli/commands/internal/media/generate.ts
 function internalMediaGenerate(program) {
 	program.command("generate").argument("[target]", "The directory to generate from.", process.cwd()).option("--ignore <ignore>", "Extra directories to ignore as comma-separated list.").option("-r --resolution <resolution>", "The resolution of the rendered scenes, with a comma between width and height.").action(async (target, { ignore, resolution }) => {
-		const ignored = new Set([
+		const ignored = /* @__PURE__ */ new Set([
 			".git",
 			"node_modules",
 			"__pycache__",
@@ -1050,6 +1070,58 @@ function root(program) {
 	});
 }
 //#endregion
+//#region src/cli/commands/template/changeRequest/helpers/resolveBasename.ts
+function resolveBasename(basename) {
+	return basename.trim().replace(/[.!?/]+$/, "").toLowerCase().replace(/\s+/g, "_");
+}
+//#endregion
+//#region src/utility/fileSystem/getNextFileName.ts
+function getNextFileName(directoryContents, newFileName) {
+	const extension = path.extname(newFileName);
+	const baseName = path.basename(newFileName, extension);
+	const fileRegex = new RegExp(String.raw`^${escapeRegexPattern(baseName)}(?:_(\d+))?${escapeRegexPattern(extension)}$`);
+	const matches = directoryContents.map((fileName) => {
+		return fileName.match(fileRegex);
+	}).filter((match) => {
+		return match !== null;
+	});
+	if (matches.length === 0) return newFileName;
+	const highestSuffix = Math.max(...matches.map((match) => {
+		return match[1] === void 0 ? 0 : parseIntStrict(match[1]);
+	}));
+	return highestSuffix === 0 ? `${baseName}_1${extension}` : `${baseName}_${highestSuffix + 1}${extension}`;
+}
+//#endregion
+//#region src/utility/markdownTemplates/replaceMarkdownPlaceholders.ts
+function replaceMarkdownPlaceholders(rawContent, templateVariables) {
+	const { content, data } = matter(rawContent);
+	const placeholders = az.with(z.array(z.string()).default([])).parse(data.placeholders);
+	let finalContent = content;
+	for (const placeholder of placeholders) {
+		if (!(placeholder in templateVariables)) throw new DataError({ placeholder }, "INVALID_PLACEHOLDER", "The placeholder found in frontmatter can not be found in the metadata.");
+		finalContent = finalContent.replaceAll(`{{${placeholder}}}`, templateVariables[placeholder]);
+	}
+	return finalContent;
+}
+//#endregion
+//#region src/cli/commands/template/changeRequest/create.ts
+function templateChangeRequestCreate(program) {
+	program.command("create").description("Generate a change request document.").requiredOption("-p, --project-name <projectName>", "The project to request a change for.").requiredOption("-r, --reason <reason>", "The reason for the change.").option("-d, --description <description>", "A further description of the change.", "Redeploy the service.").requiredOption("-q, --requested-by <requestedBy>", "The user making the change request.").option("-o, --output-directory <outputDirectory>", "The directory to output the document in. The name of the document is determined by the reason.", path.join("docs", "changeRequests")).action(async ({ outputDirectory, ...templateVariables }) => {
+		const resolvedOutputDirectory = path.resolve(outputDirectory);
+		const newDocumentContents = replaceMarkdownPlaceholders(await readFile(path.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "changeRequest", "template.md"), "utf-8"), templateVariables);
+		await mkdir(resolvedOutputDirectory, { recursive: true });
+		const newFileName = getNextFileName(await readdir(resolvedOutputDirectory), `${resolveBasename(templateVariables.reason)}.md`);
+		const outputPath = path.join(resolvedOutputDirectory, newFileName);
+		await writeFile(outputPath, newDocumentContents);
+		console.info(`Change document successfully written to \`${outputPath}\`.`);
+	});
+}
+//#endregion
+//#region src/cli/commands/template/changeRequest/index.ts
+function templateChangeRequest(program) {
+	loadCommands(program.command("change-request").description("Manage change request documents."), { templateChangeRequestCreate });
+}
+//#endregion
 //#region src/utility/markdownTemplates/pullRequest/createPullRequestTemplatesFromTemplates.ts
 const __filename$1 = fileURLToPath(import.meta.url);
 function getTemplateVariables$1(config) {
@@ -1246,18 +1318,6 @@ async function getEditableSectionFromTemplate(version) {
 	return await readFile(path.join(templatesPath, version.type === "major" ? "editableSectionMajor.md" : "editableSection.md"), "utf-8");
 }
 //#endregion
-//#region src/utility/markdownTemplates/replaceMarkdownPlaceholders.ts
-function replaceMarkdownPlaceholders(rawContent, templateVariables) {
-	const { content, data } = matter(rawContent);
-	const placeholders = az.with(z.array(z.string()).default([])).parse(data.placeholders);
-	let finalContent = content;
-	for (const placeholder of placeholders) {
-		if (!(placeholder in templateVariables)) throw new DataError({ placeholder }, "INVALID_PLACEHOLDER", "The placeholder found in frontmatter can not be found in the metadata.");
-		finalContent = finalContent.replaceAll(`{{${placeholder}}}`, templateVariables[placeholder]);
-	}
-	return finalContent;
-}
-//#endregion
 //#region src/utility/markdownTemplates/releaseNote/createReleaseNoteFromTemplates.ts
 async function getTemplateVariables(projectName, version, templateVariables) {
 	if ("editableSection" in templateVariables && templateVariables.editableSection) {
@@ -1385,6 +1445,7 @@ function templateReleaseNote(program) {
 //#region src/cli/commands/template/index.ts
 function template(program) {
 	loadCommands(program.command("template").description("Manage the automatically-generatable template files."), {
+		templateChangeRequest,
 		templatePullRequest,
 		templateReleaseNote
 	});
@@ -1392,7 +1453,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.10.2";
+var version$1 = "2.11.0";
 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.10.2",
+  "version": "2.11.0",
   "description": "Command-line tool with commands to streamline the developer workflow.",
   "repository": {
     "type": "git",
@@ -34,9 +34,9 @@
     "templates"
   ],
   "dependencies": {
-    "@alextheman/utility": "5.22.0",
+    "@alextheman/utility": "5.23.0",
     "@inquirer/prompts": "8.5.2",
-    "axios": "1.18.0",
+    "axios": "1.18.1",
     "boxen": "8.0.1",
     "chalk": "5.6.2",
     "commander": "15.0.0",
@@ -46,16 +46,17 @@
     "execa": "9.6.1",
     "figlet": "1.11.0",
     "gray-matter": "4.0.3",
-    "semver": "7.8.4",
+    "semver": "7.8.5",
     "supports-color": "10.2.2",
     "toml": "4.1.1",
     "zod": "4.4.3"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "5.17.1",
+    "@alextheman/eslint-plugin": "5.18.0",
     "@commander-js/extra-typings": "15.0.0",
+    "@faker-js/faker": "10.5.0",
     "@types/eslint": "9.6.1",
-    "@types/node": "25.9.3",
+    "@types/node": "26.0.1",
     "@types/semver": "7.7.1",
     "@types/update-notifier": "6.0.8",
     "cross-env": "10.1.0",
@@ -66,10 +67,11 @@
     "prettier": "3.8.4",
     "tempy": "3.2.0",
     "ts-node": "10.9.2",
-    "tsdown": "0.22.2",
+    "tsdown": "0.22.3",
+    "tsx": "4.22.4",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.61.1",
-    "vite": "8.0.16",
+    "typescript-eslint": "8.62.0",
+    "vite": "8.1.0",
     "vitest": "4.1.9"
   },
   "engines": {
@@ -80,6 +82,7 @@
     "command": "bash -c 'pnpm run build && echo && echo \"Command output:\" && node dist/index.js \"$@\"' --",
     "create-local-package": "pnpm run build && rm -f alex-c-line-*.tgz && pnpm pack",
     "create-release-note": "bash -c 'git pull origin main && pnpm run command template release-note create $@' --",
+    "dev": "tsx src/cli/index.ts",
     "format": "pnpm run format-prettier && pnpm run format-eslint && pnpm run format-markdownlint",
     "format-eslint": "eslint --fix --suppress-all \"package.json\" \"{src,tests}/**/*.ts\" && rm -f eslint-suppressions.json",
     "format-markdownlint": "pnpm exec markdownlint-cli2 --fix \"**/*.md\" \"!{node_modules,dist}/**\" | grep -v \"^Finding:\"",

package/templates/changeRequest/template.md

@@ -0,0 +1,18 @@
+---
+placeholders:
+- projectName
+- requestedBy
+- reason
+- description
+---
+# Change Request
+
+This is a request for a change to {{projectName}} by {{requestedBy}}. If this gets accepted it will trigger a new deployment to apply the change. Please see more details below
+
+## Change reason
+
+{{reason}}
+
+## Change description
+
+{{description}}