alex-c-line 2.9.2 → 2.10.0

package/dist/index.cjs

@@ -40,8 +40,8 @@ let dotenv = require("dotenv");
 let execa = require("execa");
 let zod = require("zod");
 zod = __toESM(zod, 1);
-let _alextheman_utility_internal = require("@alextheman/utility/internal");
 let node_url = require("node:url");
+let _alextheman_utility_internal = require("@alextheman/utility/internal");
 let node_module = require("node:module");
 let toml = require("toml");
 let gray_matter = require("gray-matter");
@@ -284,12 +284,6 @@ function internalCheckLockfileVersionDiscrepancy(program) {
 	});
 }
 //#endregion
-//#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
-const PullRequestTemplateCategory = {
-	GENERAL: "general",
-	INFRASTRUCTURE: "infrastructure"
-};
-//#endregion
 //#region src/utility/fileSystem/findPackageRoot.ts
 async function findPackageRoot(startDirectory, packageName) {
 	let directory = startDirectory;
@@ -309,6 +303,74 @@ 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/cli/commands/internal/dependency-audit/helpers/getLicenseCheck.ts
+const ALLOWED_LICENSES = [
+	"MIT",
+	"ISC",
+	"Apache-2.0",
+	"BSD-2-Clause",
+	"BSD-3-Clause"
+];
+const pnpmLicensesSchema = zod.default.record(zod.default.string(), zod.default.array(zod.default.object({
+	name: zod.default.string(),
+	versions: zod.default.array(zod.default.string())
+})));
+function parseLicenseCheck(input) {
+	return _alextheman_utility.az.with(pnpmLicensesSchema).parse(input);
+}
+async function getLicenseCheck(program) {
+	const { exitCode, stdout, stderr } = await (0, execa.execa)({ reject: false })`pnpm licenses ls --json`;
+	if (![0, 1].includes(exitCode)) program.error(stderr ?? stdout, {
+		exitCode,
+		code: "LICENSE_CHECK_ERROR"
+	});
+	const licenseCheck = parseLicenseCheck(JSON.parse(stdout.trim()));
+	if (Object.keys(licenseCheck).length === 0) return "No licenses found.";
+	const licenseCheckSummaryPath = node_path.default.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "dependencyAudit", "licenseCheck", "summary");
+	const summaryTableTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(licenseCheckSummaryPath, "table.html"), "utf-8");
+	const summaryTableRowTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(licenseCheckSummaryPath, "tableRow.html"), "utf-8");
+	const summary = summaryTableTemplate.replace("{{tableRows}}", Object.entries(licenseCheck).map(([license, data]) => {
+		return summaryTableRowTemplate.replace("{{license}}", license).replace("{{count}}", data.length.toString());
+	}).join("\n"));
+	const invalidLicenses = Object.keys(licenseCheck).filter((license) => {
+		return !ALLOWED_LICENSES.includes(license);
+	});
+	let invalidSummary;
+	if (invalidLicenses.length === 0) invalidSummary = "No licenses requiring review.";
+	else {
+		const invalidLicensesInvalidPath = node_path.default.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "dependencyAudit", "licenseCheck", "invalid");
+		const invalidLicensesTableTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(invalidLicensesInvalidPath, "table.html"), "utf-8");
+		const invalidLicensesTableRowTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(invalidLicensesInvalidPath, "tableRow.html"), "utf-8");
+		const invalidLicensesListTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(invalidLicensesInvalidPath, "list.html"), "utf-8");
+		const invalidLicensesListItemTemplate = await (0, node_fs_promises.readFile)(node_path.default.join(invalidLicensesInvalidPath, "listItem.html"), "utf-8");
+		invalidSummary = invalidLicensesTableTemplate.replace("{{tableRows}}", Object.entries(licenseCheck).filter(([license]) => {
+			return !ALLOWED_LICENSES.includes(license);
+		}).map(([license, data]) => {
+			return invalidLicensesTableRowTemplate.replaceAll("{{license}}", license).replace("{{count}}", data.length.toString()).replace("{{dependencies}}", invalidLicensesListTemplate.replace("{{listItems}}", data.flatMap((item) => {
+				return item.versions.map((version) => {
+					return invalidLicensesListItemTemplate.replace("{{name}}", item.name).replace("{{version}}", version);
+				});
+			}).join("")));
+		}).join("\n"));
+	}
+	return _alextheman_utility.normaliseIndents`
+    
+    ### Summary
+
+    ${summary}
+
+    ### Requires Review
+
+    ${invalidSummary}
+  `;
+}
+//#endregion
+//#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
+const PullRequestTemplateCategory = {
+	GENERAL: "general",
+	INFRASTRUCTURE: "infrastructure"
+};
+//#endregion
 //#region src/cli/commands/internal/dependency-audit/helpers/getOutdatedDependencies.ts
 const pnpmOutdatedSchema = zod.default.record(zod.default.string(), zod.default.object({
 	current: _alextheman_utility.az.versionNumber(),
@@ -413,9 +475,9 @@ async function getSecurityAudit(program) {
 		low: 2,
 		info: 1
 	};
-	const auditTable = tableTemplate.replace("{{tableRows}}", Object.entries(securityAudit.advisories).toSorted(([_, first], [__, second]) => {
-		return severityOrder[second.severity] - severityOrder[first.severity];
-	}).map(([id, data]) => {
+	const auditTable = tableTemplate.replace("{{tableRows}}", Object.entries(securityAudit.advisories).toSorted((0, _alextheman_utility.sortBy)(([_, advisory]) => {
+		return severityOrder[advisory.severity];
+	}, "desc")).map(([id, data]) => {
 		return tableRowTemplate.replace("{{advisoryId}}", id).replace("{{severity}}", data.severity).replace("{{packageName}}", data.module_name).replace("{{title}}", data.title).replace("{{affected}}", data.vulnerable_versions).replace("{{patched}}", data.patched_versions).replace("{{url}}", data.url);
 	}).join("\n"));
 	return _alextheman_utility.normaliseIndents`
@@ -446,6 +508,10 @@ function internalDependencyAudit(program) {
         ## Outdated Dependencies
 
         ${await getOutdatedDependencies(program)}
+
+        ## Licenses
+
+        ${await getLicenseCheck(program)}
       `;
 		console.info(content);
 		if (output) {
@@ -1356,7 +1422,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.9.2";
+var version$1 = "2.10.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,14 +7,14 @@ 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, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, parseVersionType, removeDuplicates, removeUndefinedFromObject, stringifyDotenv } from "@alextheman/utility";
+import { ONE_DAY_IN_MILLISECONDS, VersionNumber, az, fillArray, getStringsAndInterpolations, interpolate, isTemplateStringsArray, kebabToCamel, normaliseIndents, omitProperties, parseBoolean, 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";
 import { ExecaError, execa } from "execa";
 import z from "zod";
-import { DependencyGroup, PackageManager, getDependenciesFromGroup, getExpectedTgzName, getPackageJsonContents, packageJsonNotFoundError } from "@alextheman/utility/internal";
 import { fileURLToPath, pathToFileURL } from "node:url";
+import { DependencyGroup, PackageManager, getDependenciesFromGroup, getExpectedTgzName, getPackageJsonContents, packageJsonNotFoundError } from "@alextheman/utility/internal";
 import { parse as parse$1 } from "toml";
 import matter from "gray-matter";
 import { parseFilePath } from "@alextheman/utility/node";
@@ -253,12 +253,6 @@ function internalCheckLockfileVersionDiscrepancy(program) {
 	});
 }
 //#endregion
-//#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
-const PullRequestTemplateCategory = {
-	GENERAL: "general",
-	INFRASTRUCTURE: "infrastructure"
-};
-//#endregion
 //#region src/utility/fileSystem/findPackageRoot.ts
 async function findPackageRoot(startDirectory, packageName) {
 	let directory = startDirectory;
@@ -278,6 +272,74 @@ 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/cli/commands/internal/dependency-audit/helpers/getLicenseCheck.ts
+const ALLOWED_LICENSES = [
+	"MIT",
+	"ISC",
+	"Apache-2.0",
+	"BSD-2-Clause",
+	"BSD-3-Clause"
+];
+const pnpmLicensesSchema = z.record(z.string(), z.array(z.object({
+	name: z.string(),
+	versions: z.array(z.string())
+})));
+function parseLicenseCheck(input) {
+	return az.with(pnpmLicensesSchema).parse(input);
+}
+async function getLicenseCheck(program) {
+	const { exitCode, stdout, stderr } = await execa({ reject: false })`pnpm licenses ls --json`;
+	if (![0, 1].includes(exitCode)) program.error(stderr ?? stdout, {
+		exitCode,
+		code: "LICENSE_CHECK_ERROR"
+	});
+	const licenseCheck = parseLicenseCheck(JSON.parse(stdout.trim()));
+	if (Object.keys(licenseCheck).length === 0) return "No licenses found.";
+	const licenseCheckSummaryPath = path.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "dependencyAudit", "licenseCheck", "summary");
+	const summaryTableTemplate = await readFile(path.join(licenseCheckSummaryPath, "table.html"), "utf-8");
+	const summaryTableRowTemplate = await readFile(path.join(licenseCheckSummaryPath, "tableRow.html"), "utf-8");
+	const summary = summaryTableTemplate.replace("{{tableRows}}", Object.entries(licenseCheck).map(([license, data]) => {
+		return summaryTableRowTemplate.replace("{{license}}", license).replace("{{count}}", data.length.toString());
+	}).join("\n"));
+	const invalidLicenses = Object.keys(licenseCheck).filter((license) => {
+		return !ALLOWED_LICENSES.includes(license);
+	});
+	let invalidSummary;
+	if (invalidLicenses.length === 0) invalidSummary = "No licenses requiring review.";
+	else {
+		const invalidLicensesInvalidPath = path.join(await ALEX_C_LINE_PACKAGE_ROOT, "templates", "dependencyAudit", "licenseCheck", "invalid");
+		const invalidLicensesTableTemplate = await readFile(path.join(invalidLicensesInvalidPath, "table.html"), "utf-8");
+		const invalidLicensesTableRowTemplate = await readFile(path.join(invalidLicensesInvalidPath, "tableRow.html"), "utf-8");
+		const invalidLicensesListTemplate = await readFile(path.join(invalidLicensesInvalidPath, "list.html"), "utf-8");
+		const invalidLicensesListItemTemplate = await readFile(path.join(invalidLicensesInvalidPath, "listItem.html"), "utf-8");
+		invalidSummary = invalidLicensesTableTemplate.replace("{{tableRows}}", Object.entries(licenseCheck).filter(([license]) => {
+			return !ALLOWED_LICENSES.includes(license);
+		}).map(([license, data]) => {
+			return invalidLicensesTableRowTemplate.replaceAll("{{license}}", license).replace("{{count}}", data.length.toString()).replace("{{dependencies}}", invalidLicensesListTemplate.replace("{{listItems}}", data.flatMap((item) => {
+				return item.versions.map((version) => {
+					return invalidLicensesListItemTemplate.replace("{{name}}", item.name).replace("{{version}}", version);
+				});
+			}).join("")));
+		}).join("\n"));
+	}
+	return normaliseIndents`
+    
+    ### Summary
+
+    ${summary}
+
+    ### Requires Review
+
+    ${invalidSummary}
+  `;
+}
+//#endregion
+//#region src/configs/types/template/pullRequest/PullRequestTemplateCategory.ts
+const PullRequestTemplateCategory = {
+	GENERAL: "general",
+	INFRASTRUCTURE: "infrastructure"
+};
+//#endregion
 //#region src/cli/commands/internal/dependency-audit/helpers/getOutdatedDependencies.ts
 const pnpmOutdatedSchema = z.record(z.string(), z.object({
 	current: az.versionNumber(),
@@ -382,9 +444,9 @@ async function getSecurityAudit(program) {
 		low: 2,
 		info: 1
 	};
-	const auditTable = tableTemplate.replace("{{tableRows}}", Object.entries(securityAudit.advisories).toSorted(([_, first], [__, second]) => {
-		return severityOrder[second.severity] - severityOrder[first.severity];
-	}).map(([id, data]) => {
+	const auditTable = tableTemplate.replace("{{tableRows}}", Object.entries(securityAudit.advisories).toSorted(sortBy(([_, advisory]) => {
+		return severityOrder[advisory.severity];
+	}, "desc")).map(([id, data]) => {
 		return tableRowTemplate.replace("{{advisoryId}}", id).replace("{{severity}}", data.severity).replace("{{packageName}}", data.module_name).replace("{{title}}", data.title).replace("{{affected}}", data.vulnerable_versions).replace("{{patched}}", data.patched_versions).replace("{{url}}", data.url);
 	}).join("\n"));
 	return normaliseIndents`
@@ -415,6 +477,10 @@ function internalDependencyAudit(program) {
         ## Outdated Dependencies
 
         ${await getOutdatedDependencies(program)}
+
+        ## Licenses
+
+        ${await getLicenseCheck(program)}
       `;
 		console.info(content);
 		if (output) {
@@ -1325,7 +1391,7 @@ function template(program) {
 //#endregion
 //#region package.json
 var name = "alex-c-line";
-var version$1 = "2.9.2";
+var version$1 = "2.10.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.9.2",
+  "version": "2.10.0",
   "description": "Command-line tool with commands to streamline the developer workflow.",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "templates"
   ],
   "dependencies": {
-    "@alextheman/utility": "5.19.2",
+    "@alextheman/utility": "5.21.0",
     "@inquirer/prompts": "8.5.2",
     "axios": "1.17.0",
     "boxen": "8.0.1",
@@ -46,7 +46,7 @@
     "execa": "9.6.1",
     "figlet": "1.11.0",
     "gray-matter": "4.0.3",
-    "semver": "7.8.2",
+    "semver": "7.8.4",
     "supports-color": "10.2.2",
     "toml": "4.1.1",
     "zod": "4.4.3"
@@ -55,7 +55,7 @@
     "@alextheman/eslint-plugin": "5.17.0",
     "@commander-js/extra-typings": "15.0.0",
     "@types/eslint": "9.6.1",
-    "@types/node": "25.9.1",
+    "@types/node": "25.9.3",
     "@types/semver": "7.7.1",
     "@types/update-notifier": "6.0.8",
     "cross-env": "10.1.0",
@@ -63,12 +63,12 @@
     "eslint": "10.4.1",
     "husky": "9.1.7",
     "markdownlint-cli2": "0.22.1",
-    "prettier": "3.8.3",
+    "prettier": "3.8.4",
     "tempy": "3.2.0",
     "ts-node": "10.9.2",
     "tsdown": "0.22.2",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.60.1",
+    "typescript-eslint": "8.61.0",
     "vite": "8.0.16",
     "vitest": "4.1.8"
   },

package/templates/dependencyAudit/licenseCheck/invalid/list.html

@@ -0,0 +1,3 @@
+<ul>
+  {{listItems}}
+</ul>

package/templates/dependencyAudit/licenseCheck/invalid/listItem.html

@@ -0,0 +1 @@
+<li>{{name}}@{{version}}</li>

package/templates/dependencyAudit/licenseCheck/invalid/table.html

@@ -0,0 +1,12 @@
+<table>
+  <thead>
+    <tr>
+      <th scope="col">License</th>
+      <th scope="col">Count</th>
+      <th scope="col">Dependencies</th>
+    </tr>
+  </thead>
+  <tbody>
+    {{tableRows}}
+  </tbody>
+</table>

package/templates/dependencyAudit/licenseCheck/invalid/tableRow.html

@@ -0,0 +1,10 @@
+<tr>
+  <td>{{license}}</td>
+  <td>{{count}}</td>
+  <td>
+    <details>
+      <summary>View all dependencies with {{license}} license</summary>
+      {{dependencies}}
+    </details>
+  </td>
+</tr>

package/templates/dependencyAudit/licenseCheck/summary/table.html

@@ -0,0 +1,11 @@
+<table>
+  <thead>
+    <tr>
+      <th scope="col">License</th>
+      <th scope="col">Count</th>
+    </tr>
+  </thead>
+  <tbody>
+    {{tableRows}}
+  </tbody>
+</table>

package/templates/dependencyAudit/licenseCheck/summary/tableRow.html

@@ -0,0 +1,4 @@
+<tr>
+  <td>{{license}}</td>
+  <td>{{count}}</td>
+</tr>

package/templates/incidents/incident.md

@@ -0,0 +1,41 @@
+---
+id: incident
+placeholders:
+- date
+- severity
+- incidentType
+- projectName
+- reason
+---
+# Incident on {{date}}
+
+**Severity**: {{severity}}
+**Incident Type**: {{incidentType}}
+
+This document details a serious incident related to `{{projectName}}` which affected regular usage. Please read below for a description of what went wrong and the steps being taken to resolve it.
+
+## Description of Incident
+
+### Incident Summary
+
+A high-level overview of what went wrong.
+
+### Cause(s) of Incident
+
+What were the primary contributing factor(s) towards why this incident occurred?
+
+### Consequences of Incident
+
+What ended up being affected as a result of this incident occurring?
+
+## Timeline
+
+A rough timeline on how the incident played out, from the introduction of the issue to the resolution.
+
+##  Action Plan
+
+What steps have we been taking/are planning to take to minimise the chances of this happening again?
+
+## Additional Notes
+
+Additional notes here.