@repo-toolkit/confluence 0.15.0 → 0.17.0

package/README.md

@@ -73,7 +73,8 @@ Flags:
 - `--parent-page-id <id>` — numeric Confluence page id (required)
 - `--version-message <text>` — version-message suffix appended to every PUT
 - `--repository-url <url>` — repository URL appended to synced pages as an
-  italic source notice. When omitted, GitHub Actions runs infer this from
+  italic source notice. The `--folder` path is added to the notice link when it
+  is relative to `--cwd`. When omitted, GitHub Actions runs infer this from
   `GITHUB_SERVER_URL` and `GITHUB_REPOSITORY`.
 - `--skip-unchanged` / `--no-skip-unchanged` — skip pages whose body is unchanged (default: `skip`)
 - `--dry-run` — walk the doc tree and validate every markdown file and local

package/cli.js

@@ -14,7 +14,7 @@ import {
 
 // src/index.ts
 import { readFileSync as readFileSync2 } from "fs";
-import { dirname, isAbsolute as isAbsolute2, resolve as resolve2 } from "path";
+import { dirname, isAbsolute as isAbsolute2, relative as relative3, resolve as resolve2 } from "path";
 
 // src/confluence-client.ts
 import { Buffer } from "buffer";
@@ -1688,7 +1688,8 @@ function resolveConfluenceSyncPlan(options = {}) {
       throw new Error(`parentPageId must be numeric, got: ${options.parentPageId}`);
     }
   }
-  if (options.repositoryUrl && !isAllowedUrl(options.repositoryUrl)) {
+  const repositoryUrl = options.repositoryUrl ? repositoryNoticeUrl(options.repositoryUrl, cwd, options.folder ?? "") : "";
+  if (repositoryUrl && !isAllowedUrl(repositoryUrl)) {
     throw new Error(
       "repositoryUrl must be an http(s), protocol-relative, server-relative, mailto, tel, or relative URL"
     );
@@ -1705,7 +1706,7 @@ function resolveConfluenceSyncPlan(options = {}) {
     skipUnchanged: options.skipUnchanged ?? true,
     dryRun: options.dryRun ?? false,
     renderHtmlBlocks: options.renderHtmlBlocks === true,
-    repositoryUrl: options.repositoryUrl ?? ""
+    repositoryUrl
   };
 }
 async function syncConfluenceToDocs(options = {}) {
@@ -1909,6 +1910,28 @@ function appendRepositoryNotice(html, repositoryUrl) {
   const text = escapeHtml(repositoryUrl);
   return html + '\n<p><em>This document is synced from repository <a href="' + url + '">' + text + "</a>.</em></p>";
 }
+function repositoryNoticeUrl(repositoryUrl, cwd, folder) {
+  const folderPath = repositoryFolderPath(cwd, folder);
+  if (folderPath.length === 0) {
+    return repositoryUrl;
+  }
+  const trimmedUrl = repositoryUrl.replace(/\/+$/, "").replace(/\.git$/, "");
+  const encodedFolder = folderPath.split("/").map(encodeURIComponent).join("/");
+  if (/^https?:\/\/github\.com\//i.test(trimmedUrl) && !/\/tree\/|\/blob\//.test(trimmedUrl)) {
+    return trimmedUrl + "/tree/HEAD/" + encodedFolder;
+  }
+  return trimmedUrl + "/" + encodedFolder;
+}
+function repositoryFolderPath(cwd, folder) {
+  if (folder.length === 0) {
+    return "";
+  }
+  const relativePath = relative3(cwd, resolveInputPath(cwd, folder));
+  if (relativePath === "" || relativePath.startsWith("..") || isAbsolute2(relativePath)) {
+    return "";
+  }
+  return relativePath.split(/[\\/]+/).filter((part) => part !== "" && part !== ".").join("/");
+}
 async function predictBody(html, mermaidBlocks, pageId, client, ctx) {
   let predicted = html;
   if (ctx.hasMermaidBlocks) {

package/index.js

@@ -1,6 +1,6 @@
 // src/index.ts
 import { readFileSync as readFileSync2 } from "fs";
-import { dirname, isAbsolute as isAbsolute2, resolve as resolve2 } from "path";
+import { dirname, isAbsolute as isAbsolute2, relative as relative3, resolve as resolve2 } from "path";
 
 // src/confluence-client.ts
 import { Buffer } from "buffer";
@@ -1675,7 +1675,8 @@ function resolveConfluenceSyncPlan(options = {}) {
       throw new Error(`parentPageId must be numeric, got: ${options.parentPageId}`);
     }
   }
-  if (options.repositoryUrl && !isAllowedUrl(options.repositoryUrl)) {
+  const repositoryUrl = options.repositoryUrl ? repositoryNoticeUrl(options.repositoryUrl, cwd, options.folder ?? "") : "";
+  if (repositoryUrl && !isAllowedUrl(repositoryUrl)) {
     throw new Error(
       "repositoryUrl must be an http(s), protocol-relative, server-relative, mailto, tel, or relative URL"
     );
@@ -1692,7 +1693,7 @@ function resolveConfluenceSyncPlan(options = {}) {
     skipUnchanged: options.skipUnchanged ?? true,
     dryRun: options.dryRun ?? false,
     renderHtmlBlocks: options.renderHtmlBlocks === true,
-    repositoryUrl: options.repositoryUrl ?? ""
+    repositoryUrl
   };
 }
 async function syncConfluenceToDocs(options = {}) {
@@ -1896,6 +1897,28 @@ function appendRepositoryNotice(html, repositoryUrl) {
   const text = escapeHtml(repositoryUrl);
   return html + '\n<p><em>This document is synced from repository <a href="' + url + '">' + text + "</a>.</em></p>";
 }
+function repositoryNoticeUrl(repositoryUrl, cwd, folder) {
+  const folderPath = repositoryFolderPath(cwd, folder);
+  if (folderPath.length === 0) {
+    return repositoryUrl;
+  }
+  const trimmedUrl = repositoryUrl.replace(/\/+$/, "").replace(/\.git$/, "");
+  const encodedFolder = folderPath.split("/").map(encodeURIComponent).join("/");
+  if (/^https?:\/\/github\.com\//i.test(trimmedUrl) && !/\/tree\/|\/blob\//.test(trimmedUrl)) {
+    return trimmedUrl + "/tree/HEAD/" + encodedFolder;
+  }
+  return trimmedUrl + "/" + encodedFolder;
+}
+function repositoryFolderPath(cwd, folder) {
+  if (folder.length === 0) {
+    return "";
+  }
+  const relativePath = relative3(cwd, resolveInputPath(cwd, folder));
+  if (relativePath === "" || relativePath.startsWith("..") || isAbsolute2(relativePath)) {
+    return "";
+  }
+  return relativePath.split(/[\\/]+/).filter((part) => part !== "" && part !== ".").join("/");
+}
 async function predictBody(html, mermaidBlocks, pageId, client, ctx) {
   let predicted = html;
   if (ctx.hasMermaidBlocks) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@repo-toolkit/confluence",
   "description": "Sync a folder of markdown docs to Confluence pages and attachments (GitHub Action compatible)",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "type": "module",
   "sideEffects": false,
   "keywords": [
@@ -27,7 +27,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@repo-toolkit/publish-package": "0.15.0"
+    "@repo-toolkit/publish-package": "0.17.0"
   },
   "files": [
     "**/*",