alex-c-line 2.0.3 → 2.2.0

package/dist/index.cjs

@@ -21,8 +21,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	enumerable: true
 }) : target, mod));
 //#endregion
-let _alextheman_utility = require("@alextheman/utility");
 let commander = require("commander");
+let _alextheman_utility = require("@alextheman/utility");
 let chalk = require("chalk");
 chalk = __toESM(chalk);
 let boxen = require("boxen");
@@ -46,6 +46,8 @@ let node_module = require("node:module");
 let gray_matter = require("gray-matter");
 gray_matter = __toESM(gray_matter);
 let _alextheman_utility_node = require("@alextheman/utility/node");
+let axios = require("axios");
+axios = __toESM(axios);
 let supports_color = require("supports-color");
 supports_color = __toESM(supports_color);
 let node_crypto = require("node:crypto");
@@ -375,6 +377,34 @@ function gitPostMergeCleanup(program) {
 	});
 }
 //#endregion
+//#region src/cli/commands/internal/media/generate.ts
+function internalMediaGenerate(program) {
+	program.command("generate").argument("[directory]", "The directory to generate from", process.cwd()).action(async (directory) => {
+		async function readDirectory(directory) {
+			const directoryContents = await (0, node_fs_promises.readdir)(directory, { withFileTypes: true });
+			for (const entry of directoryContents) {
+				const fullPath = node_path.default.join(directory, entry.name);
+				if (entry.isDirectory() && ![
+					".git",
+					"node_modules",
+					"__pycache__",
+					".venv"
+				].includes(entry.name)) await readDirectory(fullPath);
+				if (entry.isFile() && entry.name.endsWith(".py")) {
+					console.info(`Rendering ${node_path.default.relative(process.cwd(), fullPath)}...`);
+					await (0, execa.execa)({ stdio: "inherit" })`manim -pql ${fullPath}`;
+				}
+			}
+		}
+		await readDirectory(directory);
+	});
+}
+//#endregion
+//#region src/cli/commands/internal/media/index.ts
+function internalMedia(program) {
+	loadCommands(program.command("media"), { internalMediaGenerate });
+}
+//#endregion
 //#region src/utility/fileSystem/findPackageRoot.ts
 async function findPackageRoot(startDirectory, packageName) {
 	let directory = startDirectory;
@@ -421,6 +451,7 @@ function internal(program) {
 	loadCommands(program.command("internal").description("Commands meant more for internal use by me and is not recommended for production usage."), {
 		checkLockfileVersionDiscrepancy,
 		gitPostMergeCleanup,
+		internalMedia,
 		outdatedDependencies
 	});
 }
@@ -1108,61 +1139,6 @@ function templateReleaseNoteCreate(program) {
 	});
 }
 //#endregion
-//#region src/cli/commands/template/releaseNote/migrate.ts
-function templateReleaseNoteMigrate(program) {
-	program.command("migrate").description(_alextheman_utility.normaliseIndents`
-        Migrate the docs/releases folder generated from \`create-release-note\` to be more compatible with v2.
-        The release documents will now be structured as docs/releases/vX/vX.Y/vX.Y.Z.md, rather than docs/releases/<major|minor|patch>/vX.Y.Z`).option("--dry-run", "Perform a dry run of the migration without changing any files.").action(async ({ dryRun }) => {
-		if (dryRun) {
-			console.info("Running migration in dry-run mode. Existing files will not be altered.");
-			console.info();
-		}
-		const oldReleasesPath = node_path.default.join(process.cwd(), "docs", "releases");
-		const oldReleasesDirectory = await (0, node_fs_promises.readdir)(oldReleasesPath);
-		const versionTypes = Object.values(_alextheman_utility.VersionType).filter((value) => {
-			return oldReleasesDirectory.includes(value);
-		});
-		let filesMovedCount = 0;
-		for (const versionType of versionTypes) {
-			const versionPath = node_path.default.join(oldReleasesPath, versionType);
-			const versionNumbers = (await (0, node_fs_promises.readdir)(versionPath)).filter((fileName) => {
-				return fileName.endsWith(".md");
-			}).map((fileName) => {
-				const fileNameNoExtension = fileName.slice(0, -3);
-				try {
-					return new _alextheman_utility.VersionNumber(fileNameNoExtension);
-				} catch {}
-			}).filter((item) => {
-				return item !== void 0;
-			});
-			for (const versionNumber of versionNumbers) {
-				const oldFilePath = node_path.default.join(versionPath, `${versionNumber}.md`);
-				const newFilePath = node_path.default.join(oldReleasesPath, `v${versionNumber.major}`, `v${versionNumber.major}.${versionNumber.minor}`, `${versionNumber}.md`);
-				const relativeOldFilePath = node_path.default.relative(process.cwd(), oldFilePath);
-				const relativeNewFilePath = node_path.default.relative(process.cwd(), newFilePath);
-				if (dryRun) console.info(`Would move \`${relativeOldFilePath}\` to \`${relativeNewFilePath}\``);
-				else {
-					await (0, node_fs_promises.mkdir)(node_path.default.dirname(newFilePath), { recursive: true });
-					await (0, node_fs_promises.rename)(oldFilePath, newFilePath);
-					console.info(`Moved \`${relativeOldFilePath}\` to \`${relativeNewFilePath}\``);
-				}
-				filesMovedCount++;
-			}
-		}
-		console.info();
-		if (!dryRun) for (const oldFolderName of versionTypes) {
-			const oldFolderPath = node_path.default.join(oldReleasesPath, oldFolderName);
-			const relativeOldFolderPath = node_path.default.relative(process.cwd(), oldFolderPath);
-			if ((await (0, node_fs_promises.readdir)(oldFolderPath)).length === 0) {
-				await (0, node_fs_promises.rmdir)(oldFolderPath);
-				console.info(`All files from \`${relativeOldFolderPath}\` removed. Deleting \`${relativeOldFolderPath}\`.`);
-			}
-		}
-		console.info();
-		console.info(dryRun ? `Dry run complete! ${filesMovedCount} files would be moved.` : `Migration complete! ${filesMovedCount} files moved.`);
-	});
-}
-//#endregion
 //#region src/cli/commands/template/releaseNote/path.ts
 function templateReleaseNotePath(program) {
 	program.command("path").description("Get the path to the release note for a given version.").argument("[version]", "The version number to get the release note path for (leave blank to default to the current directory's package.json version)", (rawVersion) => {
@@ -1208,7 +1184,6 @@ function templateReleaseNote(program) {
 	loadCommands(program.command("release-note").description("Manage the release notes"), {
 		templateReleaseNoteCheck,
 		templateReleaseNoteCreate,
-		templateReleaseNoteMigrate,
 		templateReleaseNotePath,
 		templateReleaseNoteSetStatus
 	});
@@ -1224,14 +1199,14 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.0.3";
+var version$1 = "2.2.0";
 var description = "Command-line tool with commands to streamline the developer workflow.";
 //#endregion
 //#region src/utility/updates/checkUpdate.ts
 async function checkUpdate(options) {
 	const currentVersion = new _alextheman_utility.VersionNumber(version$1);
-	const { stdout: npmViewResult } = await execa.execa`npm view alex-c-line version`;
-	const latestVersion = new _alextheman_utility.VersionNumber(npmViewResult.trim());
+	const { data } = await axios.default.get("https://registry.npmjs.org/alex-c-line/latest", { timeout: 5e3 });
+	const latestVersion = new _alextheman_utility.VersionNumber(data.version);
 	if (!_alextheman_utility.VersionNumber.isEqual(currentVersion, latestVersion)) {
 		const message = _alextheman_utility.normaliseIndents`
               A new update of \`alex-c-line\` is available!
@@ -1254,7 +1229,10 @@ async function checkUpdate(options) {
 				exitCode: 2,
 				code: "OUTDATED_VERSION"
 			});
-		} else console.info(messageWithArtwork);
+		} else {
+			const { updateLogger = console.info } = options ?? {};
+			updateLogger(messageWithArtwork);
+		}
 	} else if (options?.logNoUpdates) console.info(`alex-c-line is up to date (${currentVersion}).`);
 }
 //#endregion
@@ -1465,6 +1443,25 @@ function formatError(error) {
 	throw error;
 }
 //#endregion
+//#region src/utility/updates/pendingUpdateMessage.ts
+let pendingUpdateMessage = null;
+let registered = false;
+function setPendingUpdateMessage(message) {
+	pendingUpdateMessage = message;
+}
+function registerUpdateMessagePrinter() {
+	if (registered) return;
+	registered = true;
+	function print() {
+		if (pendingUpdateMessage) {
+			console.info(`\n${pendingUpdateMessage}`);
+			pendingUpdateMessage = null;
+		}
+	}
+	process.once("beforeExit", print);
+	process.once("exit", print);
+}
+//#endregion
 //#region src/cache/global/createAlexCLineGlobalCache.ts
 async function createAlexCLineGlobalCache(cacheData) {
 	await (0, node_fs_promises.mkdir)(ALEX_C_LINE_GLOBAL_CACHE_DIRECTORY, { recursive: true });
@@ -1496,7 +1493,10 @@ async function runAutomatedUpdateCheck() {
 		const lastChecked = cacheData?.updateChecks?.[version$1] ? new Date(cacheData?.updateChecks?.[version$1]) : void 0;
 		const currentDate = /* @__PURE__ */ new Date();
 		if (lastChecked === void 0 || currentDate.getTime() - lastChecked.getTime() >= _alextheman_utility.ONE_DAY_IN_MILLISECONDS) {
-			await checkUpdate({ logNoUpdates: false });
+			await checkUpdate({
+				logNoUpdates: false,
+				updateLogger: setPendingUpdateMessage
+			});
 			await createAlexCLineGlobalCache({
 				...cacheData ?? {},
 				updateChecks: {
@@ -1508,12 +1508,18 @@ async function runAutomatedUpdateCheck() {
 	} catch {}
 }
 //#endregion
+//#region src/utility/updates/shouldRunAutomatedUpdateCheck.ts
+const shouldRunAutomatedUpdateCheck = !(process.env.NODE_ENV === "test" || (0, _alextheman_utility.parseBoolean)(process.env.RUN_END_TO_END ?? "false") || (0, _alextheman_utility.parseBoolean)(process.env.CI ?? "false"));
+//#endregion
 //#region src/cli/index.ts
 (async () => {
 	try {
 		const program = new commander.Command();
 		program.name(name).description(description).version(version$1);
-		if (!(process.env.NODE_ENV === "test" || (0, _alextheman_utility.parseBoolean)(process.env.RUN_END_TO_END ?? "false") || (0, _alextheman_utility.parseBoolean)(process.env.CI ?? "false"))) await runAutomatedUpdateCheck();
+		registerUpdateMessagePrinter();
+		if (shouldRunAutomatedUpdateCheck) setTimeout(() => {
+			runAutomatedUpdateCheck();
+		}, 0);
 		createCommands(program);
 		await program.parseAsync(process.argv);
 	} catch (error) {

package/dist/index.js

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 import { createRequire } from "node:module";
-import { DataError, ONE_DAY_IN_MILLISECONDS, VersionNumber, VersionType, encryptWithKey, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, parseVersionType, parseZodSchema, parseZodSchemaAsync, removeDuplicates, removeUndefinedFromObject, stringifyDotenv } from "@alextheman/utility";
 import { Command } from "commander";
+import { DataError, ONE_DAY_IN_MILLISECONDS, VersionNumber, encryptWithKey, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, parseVersionType, parseZodSchema, parseZodSchemaAsync, removeDuplicates, removeUndefinedFromObject, stringifyDotenv } from "@alextheman/utility";
 import chalk from "chalk";
 import boxen from "boxen";
 import figlet from "figlet";
 import path from "node:path";
 import { createCanvas } from "canvas";
-import { access, mkdir, readFile, readdir, rename, rm, rmdir, writeFile } from "node:fs/promises";
+import { access, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
 import envPaths from "env-paths";
 import { confirm, input, password, select } from "@inquirer/prompts";
 import { parse } from "dotenv";
@@ -17,6 +17,7 @@ import { DependencyGroup, PackageManager, getDependenciesFromGroup, getExpectedT
 import z from "zod";
 import matter from "gray-matter";
 import { parseFilePath } from "@alextheman/utility/node";
+import axios from "axios";
 import supportsColor from "supports-color";
 import { randomUUID } from "node:crypto";
 import { minVersion, prerelease } from "semver";
@@ -345,6 +346,34 @@ function gitPostMergeCleanup(program) {
 	});
 }
 //#endregion
+//#region src/cli/commands/internal/media/generate.ts
+function internalMediaGenerate(program) {
+	program.command("generate").argument("[directory]", "The directory to generate from", process.cwd()).action(async (directory) => {
+		async function readDirectory(directory) {
+			const directoryContents = await readdir(directory, { withFileTypes: true });
+			for (const entry of directoryContents) {
+				const fullPath = path.join(directory, entry.name);
+				if (entry.isDirectory() && ![
+					".git",
+					"node_modules",
+					"__pycache__",
+					".venv"
+				].includes(entry.name)) await readDirectory(fullPath);
+				if (entry.isFile() && entry.name.endsWith(".py")) {
+					console.info(`Rendering ${path.relative(process.cwd(), fullPath)}...`);
+					await execa({ stdio: "inherit" })`manim -pql ${fullPath}`;
+				}
+			}
+		}
+		await readDirectory(directory);
+	});
+}
+//#endregion
+//#region src/cli/commands/internal/media/index.ts
+function internalMedia(program) {
+	loadCommands(program.command("media"), { internalMediaGenerate });
+}
+//#endregion
 //#region src/utility/fileSystem/findPackageRoot.ts
 async function findPackageRoot(startDirectory, packageName) {
 	let directory = startDirectory;
@@ -391,6 +420,7 @@ function internal(program) {
 	loadCommands(program.command("internal").description("Commands meant more for internal use by me and is not recommended for production usage."), {
 		checkLockfileVersionDiscrepancy,
 		gitPostMergeCleanup,
+		internalMedia,
 		outdatedDependencies
 	});
 }
@@ -1078,61 +1108,6 @@ function templateReleaseNoteCreate(program) {
 	});
 }
 //#endregion
-//#region src/cli/commands/template/releaseNote/migrate.ts
-function templateReleaseNoteMigrate(program) {
-	program.command("migrate").description(normaliseIndents`
-        Migrate the docs/releases folder generated from \`create-release-note\` to be more compatible with v2.
-        The release documents will now be structured as docs/releases/vX/vX.Y/vX.Y.Z.md, rather than docs/releases/<major|minor|patch>/vX.Y.Z`).option("--dry-run", "Perform a dry run of the migration without changing any files.").action(async ({ dryRun }) => {
-		if (dryRun) {
-			console.info("Running migration in dry-run mode. Existing files will not be altered.");
-			console.info();
-		}
-		const oldReleasesPath = path.join(process.cwd(), "docs", "releases");
-		const oldReleasesDirectory = await readdir(oldReleasesPath);
-		const versionTypes = Object.values(VersionType).filter((value) => {
-			return oldReleasesDirectory.includes(value);
-		});
-		let filesMovedCount = 0;
-		for (const versionType of versionTypes) {
-			const versionPath = path.join(oldReleasesPath, versionType);
-			const versionNumbers = (await readdir(versionPath)).filter((fileName) => {
-				return fileName.endsWith(".md");
-			}).map((fileName) => {
-				const fileNameNoExtension = fileName.slice(0, -3);
-				try {
-					return new VersionNumber(fileNameNoExtension);
-				} catch {}
-			}).filter((item) => {
-				return item !== void 0;
-			});
-			for (const versionNumber of versionNumbers) {
-				const oldFilePath = path.join(versionPath, `${versionNumber}.md`);
-				const newFilePath = path.join(oldReleasesPath, `v${versionNumber.major}`, `v${versionNumber.major}.${versionNumber.minor}`, `${versionNumber}.md`);
-				const relativeOldFilePath = path.relative(process.cwd(), oldFilePath);
-				const relativeNewFilePath = path.relative(process.cwd(), newFilePath);
-				if (dryRun) console.info(`Would move \`${relativeOldFilePath}\` to \`${relativeNewFilePath}\``);
-				else {
-					await mkdir(path.dirname(newFilePath), { recursive: true });
-					await rename(oldFilePath, newFilePath);
-					console.info(`Moved \`${relativeOldFilePath}\` to \`${relativeNewFilePath}\``);
-				}
-				filesMovedCount++;
-			}
-		}
-		console.info();
-		if (!dryRun) for (const oldFolderName of versionTypes) {
-			const oldFolderPath = path.join(oldReleasesPath, oldFolderName);
-			const relativeOldFolderPath = path.relative(process.cwd(), oldFolderPath);
-			if ((await readdir(oldFolderPath)).length === 0) {
-				await rmdir(oldFolderPath);
-				console.info(`All files from \`${relativeOldFolderPath}\` removed. Deleting \`${relativeOldFolderPath}\`.`);
-			}
-		}
-		console.info();
-		console.info(dryRun ? `Dry run complete! ${filesMovedCount} files would be moved.` : `Migration complete! ${filesMovedCount} files moved.`);
-	});
-}
-//#endregion
 //#region src/cli/commands/template/releaseNote/path.ts
 function templateReleaseNotePath(program) {
 	program.command("path").description("Get the path to the release note for a given version.").argument("[version]", "The version number to get the release note path for (leave blank to default to the current directory's package.json version)", (rawVersion) => {
@@ -1178,7 +1153,6 @@ function templateReleaseNote(program) {
 	loadCommands(program.command("release-note").description("Manage the release notes"), {
 		templateReleaseNoteCheck,
 		templateReleaseNoteCreate,
-		templateReleaseNoteMigrate,
 		templateReleaseNotePath,
 		templateReleaseNoteSetStatus
 	});
@@ -1194,14 +1168,14 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.0.3";
+var version$1 = "2.2.0";
 var description = "Command-line tool with commands to streamline the developer workflow.";
 //#endregion
 //#region src/utility/updates/checkUpdate.ts
 async function checkUpdate(options) {
 	const currentVersion = new VersionNumber(version$1);
-	const { stdout: npmViewResult } = await execa`npm view alex-c-line version`;
-	const latestVersion = new VersionNumber(npmViewResult.trim());
+	const { data } = await axios.get("https://registry.npmjs.org/alex-c-line/latest", { timeout: 5e3 });
+	const latestVersion = new VersionNumber(data.version);
 	if (!VersionNumber.isEqual(currentVersion, latestVersion)) {
 		const message = normaliseIndents`
               A new update of \`alex-c-line\` is available!
@@ -1224,7 +1198,10 @@ async function checkUpdate(options) {
 				exitCode: 2,
 				code: "OUTDATED_VERSION"
 			});
-		} else console.info(messageWithArtwork);
+		} else {
+			const { updateLogger = console.info } = options ?? {};
+			updateLogger(messageWithArtwork);
+		}
 	} else if (options?.logNoUpdates) console.info(`alex-c-line is up to date (${currentVersion}).`);
 }
 //#endregion
@@ -1435,6 +1412,25 @@ function formatError(error) {
 	throw error;
 }
 //#endregion
+//#region src/utility/updates/pendingUpdateMessage.ts
+let pendingUpdateMessage = null;
+let registered = false;
+function setPendingUpdateMessage(message) {
+	pendingUpdateMessage = message;
+}
+function registerUpdateMessagePrinter() {
+	if (registered) return;
+	registered = true;
+	function print() {
+		if (pendingUpdateMessage) {
+			console.info(`\n${pendingUpdateMessage}`);
+			pendingUpdateMessage = null;
+		}
+	}
+	process.once("beforeExit", print);
+	process.once("exit", print);
+}
+//#endregion
 //#region src/cache/global/createAlexCLineGlobalCache.ts
 async function createAlexCLineGlobalCache(cacheData) {
 	await mkdir(ALEX_C_LINE_GLOBAL_CACHE_DIRECTORY, { recursive: true });
@@ -1466,7 +1462,10 @@ async function runAutomatedUpdateCheck() {
 		const lastChecked = cacheData?.updateChecks?.[version$1] ? new Date(cacheData?.updateChecks?.[version$1]) : void 0;
 		const currentDate = /* @__PURE__ */ new Date();
 		if (lastChecked === void 0 || currentDate.getTime() - lastChecked.getTime() >= ONE_DAY_IN_MILLISECONDS) {
-			await checkUpdate({ logNoUpdates: false });
+			await checkUpdate({
+				logNoUpdates: false,
+				updateLogger: setPendingUpdateMessage
+			});
 			await createAlexCLineGlobalCache({
 				...cacheData ?? {},
 				updateChecks: {
@@ -1478,12 +1477,18 @@ async function runAutomatedUpdateCheck() {
 	} catch {}
 }
 //#endregion
+//#region src/utility/updates/shouldRunAutomatedUpdateCheck.ts
+const shouldRunAutomatedUpdateCheck = !(process.env.NODE_ENV === "test" || parseBoolean(process.env.RUN_END_TO_END ?? "false") || parseBoolean(process.env.CI ?? "false"));
+//#endregion
 //#region src/cli/index.ts
 (async () => {
 	try {
 		const program = new Command();
 		program.name(name).description(description).version(version$1);
-		if (!(process.env.NODE_ENV === "test" || parseBoolean(process.env.RUN_END_TO_END ?? "false") || parseBoolean(process.env.CI ?? "false"))) await runAutomatedUpdateCheck();
+		registerUpdateMessagePrinter();
+		if (shouldRunAutomatedUpdateCheck) setTimeout(() => {
+			runAutomatedUpdateCheck();
+		}, 0);
 		createCommands(program);
 		await program.parseAsync(process.argv);
 	} catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alex-c-line",
-  "version": "2.0.3",
+  "version": "2.2.0",
   "description": "Command-line tool with commands to streamline the developer workflow.",
   "repository": {
     "type": "git",
@@ -34,8 +34,9 @@
     "templates"
   ],
   "dependencies": {
-    "@alextheman/utility": "^5.6.1",
+    "@alextheman/utility": "^5.6.2",
     "@inquirer/prompts": "^8.3.0",
+    "axios": "^1.13.6",
     "boxen": "^8.0.1",
     "canvas": "^3.2.1",
     "chalk": "^5.6.2",