refactor: make links clickable (#85) [skip ci]

Author: eglavin

package.json

@@ -73,7 +73,7 @@
     "fork-version": "node dist/cli.js",
     "dev": "tsup --watch",
     "build": "tsup",
-    "generate-json-schema": "node scripts/generate-json-schema.js",
+    "update-json-schema": "node scripts/update-json-schema.js",
     "update-readme-cli-options": "node scripts/update-readme-cli-options.js",
     "lint": "eslint --fix \"src/**/*.ts\"",
     "lint:check": "eslint \"src/**/*.ts\"",

scripts/generate-json-schema.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+// @ts-check
+
+import { join } from "node:path";
+import { pathToFileURL } from "node:url";
+import { writeFileSync } from "node:fs";
+import { zodToJsonSchema } from "zod-to-json-schema";
+import { ForkConfigSchema } from "../src/config/schema.js";
+import { clickableLink } from "./utils/clickable-link.js";
+
+const schemaLocation = join(import.meta.dirname, "..", "schema", `latest.json`);
+const jsonSchema = zodToJsonSchema(ForkConfigSchema);
+
+writeFileSync(
+	schemaLocation,
+	JSON.stringify(
+		{
+			$schema: "http://json-schema.org/draft-07/schema#",
+			type: "object",
+			additionalProperties: false,
+			properties: jsonSchema["properties"],
+		},
+		null,
+		2,
+	),
+);
+
+console.log(
+	`Updated JSON schema: ${clickableLink(pathToFileURL(schemaLocation).href, schemaLocation)}`,
+);

scripts/update-json-schema.js

@@ -1,14 +1,13 @@
 #!/usr/bin/env node
 // @ts-check
 
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { join } from "node:path";
+import { pathToFileURL } from "node:url";
 import { readFileSync, writeFileSync } from "node:fs";
 import { helperText } from "../src/config/cli-arguments.js";
+import { clickableLink } from "./utils/clickable-link.js";
 
-const projectRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
-const readmeLocation = join(projectRoot, "README.md");
-
+const readmeLocation = join(import.meta.dirname, "..", "README.md");
 const readmeContent = readFileSync(readmeLocation, "utf-8");
 
 const startMarker = "<!-- START COMMAND LINE OPTIONS -->";
@@ -27,3 +26,5 @@ ${helperText}
 ${endMarker}`,
 	),
 );
+
+console.log(`Updated README: ${clickableLink(pathToFileURL(readmeLocation).href, readmeLocation)}`);

scripts/update-readme-cli-options.js

@@ -0,0 +1,10 @@
+/**
+ * https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#quick-example
+ * https://github.com/Alhadis/OSC8-Adoption/?tab=readme-ov-file#testing-support
+ * @param {string} url
+ * @param {string} text
+ * @returns {string}
+ */
+export function clickableLink(url, text) {
+	return `\u001b]8;;${url}\u001b\\${text}\u001b]8;;\u001b\\`;
+}