@repo-toolkit/confluence 0.14.2 → 0.15.0

package/README.md

@@ -72,6 +72,9 @@ Flags:
 - `--space-key <key>` — Confluence space key (required; resolved to a `spaceId`)
 - `--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
+  `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
   image source (same preflight as a real sync) then log the plan. No API
@@ -99,6 +102,7 @@ both read for every option. Boolean env values accept `true|1|yes|on` /
 | spaceKey                | `CONFLUENCE_SPACE_KEY`          | `INPUT_SPACE-KEY`                             |
 | parentPageId            | `CONFLUENCE_PARENT_PAGE_ID`     | `INPUT_PARENT-PAGE-ID`                        |
 | versionMessage          | `CONFLUENCE_VERSION_MESSAGE`    | `INPUT_VERSION-MESSAGE`                       |
+| repositoryUrl           | `CONFLUENCE_REPOSITORY_URL`     | `INPUT_REPOSITORY-URL`                        |
 | skipUnchanged (bool)    | `CONFLUENCE_SKIP_UNCHANGED`     | `INPUT_SKIP-UNCHANGED`                        |
 | dryRun (bool)           | `CONFLUENCE_DRY_RUN`            | `INPUT_DRY-RUN`                               |
 | renderHtmlBlocks (bool) | `CONFLUENCE_RENDER_HTML_BLOCKS` | `INPUT_RENDER-HTML-BLOCKS`                    |

package/cli.js

@@ -720,13 +720,22 @@ function markdownToStorage(markdown, options = {}) {
       out.push(`<blockquote>${renderInline(quoteLines.join("\n"))}</blockquote>`);
       continue;
     }
+    if (isTableStart(lines, i)) {
+      const tableLines = [];
+      while (i < lines.length && typeof lines[i] === "string" && isTableRow(lines[i])) {
+        tableLines.push(lines[i]);
+        i += 1;
+      }
+      out.push(renderTable(tableLines));
+      continue;
+    }
     if (/^\s{0,3}---+\s*$/.test(line) || /^\s{0,3}\*\*\*+\s*$/.test(line)) {
       out.push("<hr />");
       i += 1;
       continue;
     }
     const para = [];
-    while (i < lines.length && typeof lines[i] === "string" && lines[i].trim() !== "" && !/^\s{0,3}#{1,6}\s/.test(lines[i]) && !/^\s{0,3}```/.test(lines[i]) && !/^\s{0,3}(?:-|\*|\+)\s+/.test(lines[i]) && !/^\s{0,3}\d+\.\s+/.test(lines[i]) && !/^\s{0,3}>/.test(lines[i]) && !/^\s{0,3}---+\s*$/.test(lines[i]) && !/^\s{0,3}\*\*\*+\s*$/.test(lines[i])) {
+    while (i < lines.length && typeof lines[i] === "string" && lines[i].trim() !== "" && !/^\s{0,3}#{1,6}\s/.test(lines[i]) && !/^\s{0,3}```/.test(lines[i]) && !/^\s{0,3}(?:-|\*|\+)\s+/.test(lines[i]) && !/^\s{0,3}\d+\.\s+/.test(lines[i]) && !/^\s{0,3}>/.test(lines[i]) && !isTableStart(lines, i) && !/^\s{0,3}---+\s*$/.test(lines[i]) && !/^\s{0,3}\*\*\*+\s*$/.test(lines[i])) {
       para.push(lines[i]);
       i += 1;
     }
@@ -786,6 +795,60 @@ function renderList(listLines) {
   const body = items.map((item) => `<li>${renderInline(item)}</li>`).join("");
   return `<${tag}>${body}</${tag}>`;
 }
+function isTableStart(lines, index) {
+  const header = lines[index];
+  const separator = lines[index + 1];
+  if (typeof header !== "string" || typeof separator !== "string") {
+    return false;
+  }
+  if (!isTableRow(header) || !isTableSeparator(separator)) {
+    return false;
+  }
+  return splitTableRow(header).length === splitTableRow(separator).length;
+}
+function isTableRow(line) {
+  return /^\s{0,3}\|/.test(line) && splitTableRow(line).length > 1;
+}
+function isTableSeparator(line) {
+  const cells = splitTableRow(line);
+  if (cells.length < 2) {
+    return false;
+  }
+  return cells.every((cell) => /^:?-{3,}:?$/.test(cell.trim()));
+}
+function splitTableRow(line) {
+  const trimmed = line.trim();
+  const start = trimmed.startsWith("|") ? 1 : 0;
+  const end = trimmed.endsWith("|") && !isEscapedPipe(trimmed, trimmed.length - 1) ? trimmed.length - 1 : trimmed.length;
+  const cells = [];
+  let cellStart = start;
+  for (let i = start; i < end; i += 1) {
+    if (trimmed[i] === "|" && !isEscapedPipe(trimmed, i)) {
+      cells.push(unescapeTableCell(trimmed.slice(cellStart, i).trim()));
+      cellStart = i + 1;
+    }
+  }
+  cells.push(unescapeTableCell(trimmed.slice(cellStart, end).trim()));
+  return cells;
+}
+function isEscapedPipe(text, index) {
+  let backslashes = 0;
+  for (let i = index - 1; i >= 0 && text[i] === "\\"; i -= 1) {
+    backslashes += 1;
+  }
+  return backslashes % 2 === 1;
+}
+function unescapeTableCell(cell) {
+  return cell.replace(/\\\|/g, "|");
+}
+function renderTable(tableLines) {
+  const rows = tableLines.filter((_, index) => index !== 1).map(splitTableRow);
+  const body = rows.map((cells, rowIndex) => {
+    const tag = rowIndex === 0 ? "th" : "td";
+    return "<tr>" + cells.map((cell) => "<" + tag + ">" + renderInline(cell) + "</" + tag + ">").join("") + "</tr>";
+  }).join("");
+  return "<table><tbody>" + body + "</tbody></table>";
+}
 function renderInline(text) {
   const out = [];
   const tokens = tokenizeInline(text, 0, text.length);
@@ -1558,16 +1621,17 @@ function validateLocalSync(entries, plan) {
       const { html, mermaidBlocks } = markdownToStorage(markdown, {
         renderHtmlBlocks: plan.renderHtmlBlocks
       });
+      const body = appendRepositoryNotice(html, plan.repositoryUrl);
       const markdownDir = dirname(entry.absolute);
-      const hasLocalImages = hasLocalImagePlaceholder(html);
+      const hasLocalImages = hasLocalImagePlaceholder(body);
       const hasMermaidBlocks = mermaidBlocks.length > 0;
-      const attachments = hasLocalImages ? validateAttachmentSources(html, {
+      const attachments = hasLocalImages ? validateAttachmentSources(body, {
         markdownDir,
         allowedRoot: plan.folder
       }) : [];
       plans.push({
         entry,
-        html,
+        html: body,
         mermaidBlocks,
         markdownDir,
         hasLocalImages,
@@ -1624,6 +1688,11 @@ function resolveConfluenceSyncPlan(options = {}) {
       throw new Error(`parentPageId must be numeric, got: ${options.parentPageId}`);
     }
   }
+  if (options.repositoryUrl && !isAllowedUrl(options.repositoryUrl)) {
+    throw new Error(
+      "repositoryUrl must be an http(s), protocol-relative, server-relative, mailto, tel, or relative URL"
+    );
+  }
   return {
     cwd,
     folder,
@@ -1635,7 +1704,8 @@ function resolveConfluenceSyncPlan(options = {}) {
     versionMessage: options.versionMessage ?? "Synced via repo-toolkit-confluence",
     skipUnchanged: options.skipUnchanged ?? true,
     dryRun: options.dryRun ?? false,
-    renderHtmlBlocks: options.renderHtmlBlocks === true
+    renderHtmlBlocks: options.renderHtmlBlocks === true,
+    repositoryUrl: options.repositoryUrl ?? ""
   };
 }
 async function syncConfluenceToDocs(options = {}) {
@@ -1831,6 +1901,14 @@ function hasLocalImagePlaceholder(html) {
   LOCAL_IMAGE_PLACEHOLDER_RE.lastIndex = 0;
   return LOCAL_IMAGE_PLACEHOLDER_RE.test(html);
 }
+function appendRepositoryNotice(html, repositoryUrl) {
+  if (repositoryUrl.length === 0) {
+    return html;
+  }
+  const url = escapeXmlAttribute(repositoryUrl);
+  const text = escapeHtml(repositoryUrl);
+  return html + '\n<p><em>This document is synced from repository <a href="' + url + '">' + text + "</a>.</em></p>";
+}
 async function predictBody(html, mermaidBlocks, pageId, client, ctx) {
   let predicted = html;
   if (ctx.hasMermaidBlocks) {
@@ -1884,6 +1962,7 @@ var SPECS = [
   { name: "space-key" },
   { name: "parent-page-id" },
   { name: "version-message" },
+  { name: "repository-url" },
   { name: "skip-unchanged", boolean: true, negatable: true },
   { name: "dry-run", boolean: true },
   { name: "render-html-blocks", boolean: true },
@@ -1928,6 +2007,7 @@ Environment variables (CLI form; GitHub Action INPUT_* form is also read):
   CONFLUENCE_SPACE_KEY                 Confluence space key
   CONFLUENCE_PARENT_PAGE_ID            Numeric parent page id
   CONFLUENCE_VERSION_MESSAGE            Version-message suffix for every PUT
+  CONFLUENCE_REPOSITORY_URL            Repository URL appended to synced pages
   CONFLUENCE_SKIP_UNCHANGED            true|false (default: true)
   CONFLUENCE_DRY_RUN                   true|false (default: false)
   CONFLUENCE_RENDER_HTML_BLOCKS        true|false (default: false)
@@ -1947,6 +2027,7 @@ Options:
   --space-key <key>             Confluence space key (required). Resolved to a spaceId via the API
   --parent-page-id <id>         Numeric page id under which docs will be published (required)
   --version-message <text>      Commit message appended to every page/attachment PUT
+  --repository-url <url>        Repository URL appended to synced pages as an italic notice
   --skip-unchanged               Skip pages whose body is unchanged (default: true)
   --no-skip-unchanged           Re-upload every page even when unchanged
   --dry-run                     Walk the doc tree and print the plan without API calls
@@ -1965,7 +2046,8 @@ var STRING_OPTION_KEYS = [
   "baseUrl",
   "spaceKey",
   "parentPageId",
-  "versionMessage"
+  "versionMessage",
+  "repositoryUrl"
 ];
 function setIfString(options, key, value) {
   if (typeof value === "string" && value.length > 0) {
@@ -1986,6 +2068,7 @@ var ENV_BINDINGS = [
   { envName: "INPUT_SPACE-KEY", key: "spaceKey", kind: "string" },
   { envName: "INPUT_PARENT-PAGE-ID", key: "parentPageId", kind: "string" },
   { envName: "INPUT_VERSION-MESSAGE", key: "versionMessage", kind: "string" },
+  { envName: "INPUT_REPOSITORY-URL", key: "repositoryUrl", kind: "string" },
   { envName: "INPUT_DRY-RUN", key: "dryRun", kind: "boolean" },
   { envName: "INPUT_SKIP-UNCHANGED", key: "skipUnchanged", kind: "boolean" },
   { envName: "INPUT_RENDER-HTML-BLOCKS", key: "renderHtmlBlocks", kind: "boolean" },
@@ -1997,6 +2080,7 @@ var ENV_BINDINGS = [
   { envName: "CONFLUENCE_SPACE_KEY", key: "spaceKey", kind: "string" },
   { envName: "CONFLUENCE_PARENT_PAGE_ID", key: "parentPageId", kind: "string" },
   { envName: "CONFLUENCE_VERSION_MESSAGE", key: "versionMessage", kind: "string" },
+  { envName: "CONFLUENCE_REPOSITORY_URL", key: "repositoryUrl", kind: "string" },
   { envName: "CONFLUENCE_DRY_RUN", key: "dryRun", kind: "boolean" },
   { envName: "CONFLUENCE_SKIP_UNCHANGED", key: "skipUnchanged", kind: "boolean" },
   { envName: "CONFLUENCE_RENDER_HTML_BLOCKS", key: "renderHtmlBlocks", kind: "boolean" }
@@ -2017,8 +2101,22 @@ function optionsFromEnv(env = process.env) {
       options[key] = parseBooleanEnv(raw, envName);
     }
   }
+  if (options.repositoryUrl === void 0) {
+    const githubRepositoryUrl = repositoryUrlFromGitHubEnv(env);
+    if (githubRepositoryUrl) {
+      options.repositoryUrl = githubRepositoryUrl;
+    }
+  }
   return options;
 }
+function repositoryUrlFromGitHubEnv(env) {
+  const repository = env.GITHUB_REPOSITORY;
+  if (!repository) {
+    return void 0;
+  }
+  const serverUrl = env.GITHUB_SERVER_URL || "https://github.com";
+  return serverUrl.replace(/\/+$/, "") + "/" + repository.replace(/^\/+/, "");
+}
 function buildOptions(result) {
   if (!result) {
     return {};
@@ -2034,6 +2132,7 @@ function buildOptions(result) {
   setIfString(options, "spaceKey", values["space-key"]);
   setIfString(options, "parentPageId", values["parent-page-id"]);
   setIfString(options, "versionMessage", values["version-message"]);
+  setIfString(options, "repositoryUrl", values["repository-url"]);
   if (values["skip-unchanged"] !== void 0) {
     options.skipUnchanged = values["skip-unchanged"] === "true";
   }

package/index.d.ts

@@ -338,6 +338,8 @@ interface ConfluenceSyncOptions {
     skipUnchanged?: boolean;
     /** Render ```html fenced blocks as inline HTML via the Confluence `html` macro instead of a code box (default: false). */
     renderHtmlBlocks?: boolean;
+    /** Repository URL appended to synced pages as an italic source notice. */
+    repositoryUrl?: string;
     /**
      * Dry-run: walk the tree and validate every markdown file and local image
      * source (same preflight as a real sync) then print the plan, but make no
@@ -367,6 +369,7 @@ interface ConfluenceSyncPlan {
     skipUnchanged: boolean;
     dryRun: boolean;
     renderHtmlBlocks: boolean;
+    repositoryUrl: string;
 }
 /** A single markdown entry's locally-validated sync plan. */
 interface LocalSyncEntryPlan {

package/index.js

@@ -706,13 +706,22 @@ function markdownToStorage(markdown, options = {}) {
       out.push(`<blockquote>${renderInline(quoteLines.join("\n"))}</blockquote>`);
       continue;
     }
+    if (isTableStart(lines, i)) {
+      const tableLines = [];
+      while (i < lines.length && typeof lines[i] === "string" && isTableRow(lines[i])) {
+        tableLines.push(lines[i]);
+        i += 1;
+      }
+      out.push(renderTable(tableLines));
+      continue;
+    }
     if (/^\s{0,3}---+\s*$/.test(line) || /^\s{0,3}\*\*\*+\s*$/.test(line)) {
       out.push("<hr />");
       i += 1;
       continue;
     }
     const para = [];
-    while (i < lines.length && typeof lines[i] === "string" && lines[i].trim() !== "" && !/^\s{0,3}#{1,6}\s/.test(lines[i]) && !/^\s{0,3}```/.test(lines[i]) && !/^\s{0,3}(?:-|\*|\+)\s+/.test(lines[i]) && !/^\s{0,3}\d+\.\s+/.test(lines[i]) && !/^\s{0,3}>/.test(lines[i]) && !/^\s{0,3}---+\s*$/.test(lines[i]) && !/^\s{0,3}\*\*\*+\s*$/.test(lines[i])) {
+    while (i < lines.length && typeof lines[i] === "string" && lines[i].trim() !== "" && !/^\s{0,3}#{1,6}\s/.test(lines[i]) && !/^\s{0,3}```/.test(lines[i]) && !/^\s{0,3}(?:-|\*|\+)\s+/.test(lines[i]) && !/^\s{0,3}\d+\.\s+/.test(lines[i]) && !/^\s{0,3}>/.test(lines[i]) && !isTableStart(lines, i) && !/^\s{0,3}---+\s*$/.test(lines[i]) && !/^\s{0,3}\*\*\*+\s*$/.test(lines[i])) {
       para.push(lines[i]);
       i += 1;
     }
@@ -772,6 +781,60 @@ function renderList(listLines) {
   const body = items.map((item) => `<li>${renderInline(item)}</li>`).join("");
   return `<${tag}>${body}</${tag}>`;
 }
+function isTableStart(lines, index) {
+  const header = lines[index];
+  const separator = lines[index + 1];
+  if (typeof header !== "string" || typeof separator !== "string") {
+    return false;
+  }
+  if (!isTableRow(header) || !isTableSeparator(separator)) {
+    return false;
+  }
+  return splitTableRow(header).length === splitTableRow(separator).length;
+}
+function isTableRow(line) {
+  return /^\s{0,3}\|/.test(line) && splitTableRow(line).length > 1;
+}
+function isTableSeparator(line) {
+  const cells = splitTableRow(line);
+  if (cells.length < 2) {
+    return false;
+  }
+  return cells.every((cell) => /^:?-{3,}:?$/.test(cell.trim()));
+}
+function splitTableRow(line) {
+  const trimmed = line.trim();
+  const start = trimmed.startsWith("|") ? 1 : 0;
+  const end = trimmed.endsWith("|") && !isEscapedPipe(trimmed, trimmed.length - 1) ? trimmed.length - 1 : trimmed.length;
+  const cells = [];
+  let cellStart = start;
+  for (let i = start; i < end; i += 1) {
+    if (trimmed[i] === "|" && !isEscapedPipe(trimmed, i)) {
+      cells.push(unescapeTableCell(trimmed.slice(cellStart, i).trim()));
+      cellStart = i + 1;
+    }
+  }
+  cells.push(unescapeTableCell(trimmed.slice(cellStart, end).trim()));
+  return cells;
+}
+function isEscapedPipe(text, index) {
+  let backslashes = 0;
+  for (let i = index - 1; i >= 0 && text[i] === "\\"; i -= 1) {
+    backslashes += 1;
+  }
+  return backslashes % 2 === 1;
+}
+function unescapeTableCell(cell) {
+  return cell.replace(/\\\|/g, "|");
+}
+function renderTable(tableLines) {
+  const rows = tableLines.filter((_, index) => index !== 1).map(splitTableRow);
+  const body = rows.map((cells, rowIndex) => {
+    const tag = rowIndex === 0 ? "th" : "td";
+    return "<tr>" + cells.map((cell) => "<" + tag + ">" + renderInline(cell) + "</" + tag + ">").join("") + "</tr>";
+  }).join("");
+  return "<table><tbody>" + body + "</tbody></table>";
+}
 function renderInline(text) {
   const out = [];
   const tokens = tokenizeInline(text, 0, text.length);
@@ -1545,16 +1608,17 @@ function validateLocalSync(entries, plan) {
       const { html, mermaidBlocks } = markdownToStorage(markdown, {
         renderHtmlBlocks: plan.renderHtmlBlocks
       });
+      const body = appendRepositoryNotice(html, plan.repositoryUrl);
       const markdownDir = dirname(entry.absolute);
-      const hasLocalImages = hasLocalImagePlaceholder(html);
+      const hasLocalImages = hasLocalImagePlaceholder(body);
       const hasMermaidBlocks = mermaidBlocks.length > 0;
-      const attachments = hasLocalImages ? validateAttachmentSources(html, {
+      const attachments = hasLocalImages ? validateAttachmentSources(body, {
         markdownDir,
         allowedRoot: plan.folder
       }) : [];
       plans.push({
         entry,
-        html,
+        html: body,
         mermaidBlocks,
         markdownDir,
         hasLocalImages,
@@ -1611,6 +1675,11 @@ function resolveConfluenceSyncPlan(options = {}) {
       throw new Error(`parentPageId must be numeric, got: ${options.parentPageId}`);
     }
   }
+  if (options.repositoryUrl && !isAllowedUrl(options.repositoryUrl)) {
+    throw new Error(
+      "repositoryUrl must be an http(s), protocol-relative, server-relative, mailto, tel, or relative URL"
+    );
+  }
   return {
     cwd,
     folder,
@@ -1622,7 +1691,8 @@ function resolveConfluenceSyncPlan(options = {}) {
     versionMessage: options.versionMessage ?? "Synced via repo-toolkit-confluence",
     skipUnchanged: options.skipUnchanged ?? true,
     dryRun: options.dryRun ?? false,
-    renderHtmlBlocks: options.renderHtmlBlocks === true
+    renderHtmlBlocks: options.renderHtmlBlocks === true,
+    repositoryUrl: options.repositoryUrl ?? ""
   };
 }
 async function syncConfluenceToDocs(options = {}) {
@@ -1818,6 +1888,14 @@ function hasLocalImagePlaceholder(html) {
   LOCAL_IMAGE_PLACEHOLDER_RE.lastIndex = 0;
   return LOCAL_IMAGE_PLACEHOLDER_RE.test(html);
 }
+function appendRepositoryNotice(html, repositoryUrl) {
+  if (repositoryUrl.length === 0) {
+    return html;
+  }
+  const url = escapeXmlAttribute(repositoryUrl);
+  const text = escapeHtml(repositoryUrl);
+  return html + '\n<p><em>This document is synced from repository <a href="' + url + '">' + text + "</a>.</em></p>";
+}
 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.14.2",
+  "version": "0.15.0",
   "type": "module",
   "sideEffects": false,
   "keywords": [
@@ -27,7 +27,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@repo-toolkit/publish-package": "0.14.2"
+    "@repo-toolkit/publish-package": "0.15.0"
   },
   "files": [
     "**/*",