pict-docuserve 0.0.8 → 0.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-docuserve",
-    "version": "0.0.8",
+    "version": "0.0.10",
     "description": "Pict Documentation Server - A single-page documentation viewer built on Pict",
     "main": "source/Pict-Application-Docuserve.js",
     "bin": {
@@ -18,7 +18,7 @@
         "build-docs": "npx quack build && npx quack copy && node source/cli/Docuserve-CLI-Run.js inject ./docs && node example_applications/build-examples.js stage-docs",
         "serve-docs": "node source/cli/Docuserve-CLI-Run.js serve ./docs",
         "serve-examples": "node example_applications/build-examples.js",
-        "test": "echo \"Error: no test specified\" && exit 0",
+        "test": "npx mocha -u tdd --exit -R spec",
         "tests": "npx mocha -u tdd --exit -R spec --grep",
         "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec"
     },
@@ -33,6 +33,8 @@
         "pict-view": "^1.0.64"
     },
     "devDependencies": {
+        "chai": "^6.2.2",
+        "mocha": "^11.7.5",
         "quackage": "^1.0.47"
     },
     "copyFilesSettings": {

package/source/providers/Pict-Provider-Docuserve-Documentation.js

@@ -994,6 +994,57 @@ class DocuserveDocumentationProvider extends libPictProvider
 		return null;
 	}
 
+	/**
+	 * Resolve a GitHub repository URL to an internal hash route.
+	 *
+	 * If the URL matches a module in the loaded catalog, returns the
+	 * corresponding #/doc/ route so the link navigates within docuserve
+	 * instead of leaving to GitHub.
+	 *
+	 * @param {string} pURL - A GitHub URL (e.g. "https://github.com/stevenvelozo/fable")
+	 * @returns {string|null} The hash route (e.g. "#/doc/fable/fable") or null if not a catalog module
+	 */
+	resolveGitHubURLToRoute(pURL)
+	{
+		if (!this._Catalog || !this._Catalog.Groups || !pURL)
+		{
+			return null;
+		}
+
+		// Match https://github.com/{org}/{repo} with optional trailing path/slash
+		let tmpMatch = pURL.match(/^https?:\/\/github\.com\/([^/]+)\/([^/]+)/);
+		if (!tmpMatch)
+		{
+			return null;
+		}
+
+		let tmpOrg = tmpMatch[1];
+		let tmpRepo = tmpMatch[2];
+
+		// Only resolve URLs that match the catalog's GitHub org
+		if (tmpOrg !== this._Catalog.GitHubOrg)
+		{
+			return null;
+		}
+
+		// Search catalog for a module with a matching Repo
+		for (let i = 0; i < this._Catalog.Groups.length; i++)
+		{
+			let tmpGroup = this._Catalog.Groups[i];
+
+			for (let j = 0; j < tmpGroup.Modules.length; j++)
+			{
+				let tmpModule = tmpGroup.Modules[j];
+				if (tmpModule.Repo === tmpRepo)
+				{
+					return '#/doc/' + tmpGroup.Key + '/' + tmpModule.Name;
+				}
+			}
+		}
+
+		return null;
+	}
+
 	/**
 	 * Get the module-specific sidebar entries for a given group/module.
 	 *
@@ -1435,6 +1486,12 @@ class DocuserveDocumentationProvider extends libPictProvider
 				let tmpRoute = this.convertDocLink(pHref, pCurrentGroup, pCurrentModule, pCurrentDocPath);
 				return '<a href="' + tmpRoute + '">' + pLinkText + '</a>';
 			}
+			// Check if this is a GitHub URL that matches a catalog module
+			let tmpCatalogRoute = this.resolveGitHubURLToRoute(pHref);
+			if (tmpCatalogRoute)
+			{
+				return '<a href="' + tmpCatalogRoute + '">' + pLinkText + '</a>';
+			}
 			return '<a href="' + pHref + '" target="_blank" rel="noopener">' + pLinkText + '</a>';
 		});