@vdfor/confluence-sync 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,124 @@
+# @vdfor/confluence-sync
+
+Confluence 文档同步 CLI 工具，支持将本地 Markdown 文件上传至 Confluence 并自动转换为 Confluence 页面格式。
+
+## 安装
+
+```bash
+# pnpm
+pnpm add -g @vdfor/confluence-sync
+
+# npm
+npm install -g @vdfor/confluence-sync
+
+# yarn
+yarn global add @vdfor/confluence-sync
+```
+
+## 配置
+
+### 方式1：环境变量
+
+```bash
+# 必填：Confluence 服务地址
+export CONFLUENCE_BASE_URL="https://your-confluence-instance.com"
+
+# 认证方式（二选一）
+# 方式1（推荐）：Personal Access Token
+export CONFLUENCE_PAT="your-personal-access-token"
+
+# 方式2：Basic Auth
+export CONFLUENCE_USERNAME="your-username"
+export CONFLUENCE_API_TOKEN="your-api-token"
+```
+
+### 方式2：CLI 参数（优先于环境变量）
+
+```bash
+confluence-sync upload --file test.md \
+  --base-url https://your-confluence-instance.com \
+  --pat your-token
+```
+
+## 命令
+
+### upload - 上传 Markdown 为新页面
+
+```bash
+confluence-sync upload --file <path> [--title <标题>] [--space <key>] [--parent <ID或标题>] [--dry-run]
+```
+
+### update - 更新已有页面
+
+```bash
+confluence-sync update --file <path> (--page-id <ID> | --title <标题>) [--space <key>] [--minor-edit]
+```
+
+### upload-file - 上传附件
+
+```bash
+confluence-sync upload-file --page-id <ID> --file <path> [--name <文件名>]
+```
+
+### list-pages - 列出空间页面
+
+```bash
+confluence-sync list-pages [--space <key>]
+```
+
+### list-files - 列出页面附件
+
+```bash
+confluence-sync list-files --page-id <ID>
+```
+
+### get-content - 获取页面内容
+
+```bash
+confluence-sync get-content --page-id <ID> [--markdown]
+```
+
+使用 `--markdown` 参数可将 Confluence 内容转换为 Markdown 格式输出。
+
+## 配置参数
+
+| 参数 | 说明 |
+|------|------|
+| `--base-url` | Confluence 服务地址 |
+| `--pat` | Personal Access Token |
+| `--username` | Confluence 登录名 |
+| `--api-token` | API Token 或密码 |
+| `--space` | Space Key |
+| `--file` | 本地文件路径 |
+| `--title` | 页面标题 |
+| `--page-id` | 页面 ID |
+| `--parent` | 父页面 ID 或标题 |
+| `--dry-run` | 仅打印转换结果，不实际上传 |
+| `--minor-edit` | 标记为小修改（不通知关注者） |
+| `--markdown` | get-content 时输出为 Markdown 格式 |
+
+## 示例
+
+```bash
+# 上传 Markdown 文件
+confluence-sync upload --file README.md --title "项目文档" --space MYSPACE
+
+# 更新已有页面
+confluence-sync update --file README.md --page-id 123456
+
+# 上传附件
+confluence-sync upload-file --page-id 123456 --file image.png
+
+# 列出空间所有页面
+confluence-sync list-pages --space MYSPACE
+
+# 获取页面内容
+confluence-sync get-content --page-id 123456
+
+# 获取页面内容并转换为 Markdown
+confluence-sync get-content --page-id 123456 --markdown
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vdfor/confluence-sync",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": "vdfor",
   "license": "MIT",
   "private": false,
@@ -37,9 +37,9 @@
     "upload": "node upload.mjs upload",
     "update": "node upload.mjs update",
     "help": "node upload.mjs help",
-    "release:beta": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && pnpm version $v && pnpm publish --registry https://registry.npmjs.org/ --access public --tag beta --no-git-checks",
-    "release": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && pnpm version $v && pnpm publish --registry https://registry.npmjs.org/ --access public --no-git-checks",
-    "v": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && pnpm version $v",
+    "release:beta": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && NPM_CONFIG_GIT_CHECKS=false pnpm version $v --no-git-tag-version --no-git-checks && pnpm publish --tag beta --access public --no-git-checks",
+    "release": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && NPM_CONFIG_GIT_CHECKS=false pnpm version $v --no-git-tag-version --no-git-checks && pnpm publish --access public --no-git-checks",
+    "v": "read -p '请输入版本号 (例如: patch, minor, major 或具体版本号): ' v && pnpm version $v --no-git-tag-version --no-git-checks",
     "clean": "rimraf dist node_modules"
   }
 }

package/src/confluence.mjs

@@ -271,6 +271,104 @@ export function mdToConfluence(md) {
   return renderTokens(tokens);
 }
 
+// ── Confluence Storage Format → Markdown ─────────────────────────────────────
+
+/**
+ * 将 Confluence storage format（XHTML）转换为 Markdown
+ * @param {string} html - Confluence storage format HTML
+ * @returns {string} Markdown 文本
+ */
+export function confluenceToMd(html) {
+  if (!html) return '';
+
+  let md = html;
+
+  // 代码块：<ac:structured-macro ac:name="code">
+  md = md.replace(/<ac:structured-macro\s+ac:name="code">[\s\S]*?<ac:parameter\s+ac:name="language">([\s\S]*?)<\/ac:parameter>[\s\S]*?<ac:plain-text-body><!\[CDATA\[([\s\S]*?)\]\]><\/ac:plain-text-body>[\s\S]*?<\/ac:structured-macro>/g,
+    (_, lang, code) => `\n\`\`\`${lang}\n${code}\n\`\`\`\n`);
+
+  // 标题
+  md = md.replace(/<h1[^>]*>([\s\S]*?)<\/h1>/gi, '\n# $1\n');
+  md = md.replace(/<h2[^>]*>([\s\S]*?)<\/h2>/gi, '\n## $1\n');
+  md = md.replace(/<h3[^>]*>([\s\S]*?)<\/h3>/gi, '\n### $1\n');
+  md = md.replace(/<h4[^>]*>([\s\S]*?)<\/h4>/gi, '\n#### $1\n');
+  md = md.replace(/<h5[^>]*>([\s\S]*?)<\/h5>/gi, '\n##### $1\n');
+  md = md.replace(/<h6[^>]*>([\s\S]*?)<\/h6>/gi, '\n###### $1\n');
+
+  // 粗体、斜体、删除线、行内代码
+  md = md.replace(/<strong>([\s\S]*?)<\/strong>/gi, '**$1**');
+  md = md.replace(/<b>([\s\S]*?)<\/b>/gi, '**$1**');
+  md = md.replace(/<em>([\s\S]*?)<\/em>/gi, '*$1*');
+  md = md.replace(/<i>([\s\S]*?)<\/i>/gi, '*$1*');
+  md = md.replace(/<s>([\s\S]*?)<\/s>/gi, '~~$1~~');
+  md = md.replace(/<del>([\s\S]*?)<\/del>/gi, '~~$1~~');
+  md = md.replace(/<code>([\s\S]*?)<\/code>/gi, '`$1`');
+
+  // 链接
+  md = md.replace(/<a\s+href="([^"]*)"[^>]*>([\s\S]*?)<\/a>/gi, '[$2]($1)');
+
+  // 图片：<ac:image><ri:attachment ri:filename="xxx" /></ac:image>
+  md = md.replace(/<ac:image>[\s\S]*?<ri:attachment\s+ri:filename="([^"]*)"[\s\S]*?\/>[\s\S]*?<\/ac:image>/gi, '![]($1)');
+
+  // 普通图片
+  md = md.replace(/<img\s+[^>]*src="([^"]*)"[^>]*\/?>/gi, '![]($1)');
+
+  // 水平线
+  md = md.replace(/<hr\s*\/?>/gi, '\n---\n');
+
+  // 换行
+  md = md.replace(/<br\s*\/?>/gi, '\n');
+
+  // 段落
+  md = md.replace(/<p>([\s\S]*?)<\/p>/gi, '\n$1\n');
+
+  // 引用块
+  md = md.replace(/<blockquote>([\s\S]*?)<\/blockquote>/gi, (_, content) => {
+    return content.split('\n').map(line => `> ${line}`).join('\n');
+  });
+
+  // 无序列表
+  md = md.replace(/<ul>([\s\S]*?)<\/ul>/gi, (_, content) => {
+    return content.replace(/<li>([\s\S]*?)<\/li>/gi, '- $1\n');
+  });
+
+  // 有序列表
+  md = md.replace(/<ol>([\s\S]*?)<\/ol>/gi, (_, content) => {
+    let i = 0;
+    return content.replace(/<li>([\s\S]*?)<\/li>/gi, () => `${++i}. $1\n`);
+  });
+
+  // 表格
+  md = md.replace(/<table>([\s\S]*?)<\/table>/gi, (_, tableContent) => {
+    let rows = [];
+    // 表头
+    const headerMatch = tableContent.match(/<thead>([\s\S]*?)<\/thead>/i);
+    if (headerMatch) {
+      const cells = headerMatch[1].match(/<th[^>]*>([\s\S]*?)<\/th>/gi) || [];
+      rows.push(cells.map(c => c.replace(/<th[^>]*>([\s\S]*?)<\/th>/i, '$1').trim()));
+      rows.push(rows[0].map(() => '---'));
+    }
+    // 表体
+    const bodyMatch = tableContent.match(/<tbody>([\s\S]*?)<\/tbody>/i);
+    if (bodyMatch) {
+      const trMatches = bodyMatch[1].match(/<tr>([\s\S]*?)<\/tr>/gi) || [];
+      for (const tr of trMatches) {
+        const cells = tr.match(/<td[^>]*>([\s\S]*?)<\/td>/gi) || [];
+        rows.push(cells.map(c => c.replace(/<td[^>]*>([\s\S]*?)<\/td>/i, '$1').trim()));
+      }
+    }
+    return '\n' + rows.map(r => '| ' + r.join(' | ') + ' |').join('\n') + '\n';
+  });
+
+  // 移除剩余 HTML 标签
+  md = md.replace(/<[^>]+>/g, '');
+
+  // 清理多余空行
+  md = md.replace(/\n{3,}/g, '\n\n');
+
+  return md.trim();
+}
+
 // ── 文件上传（附件）────────────────────────────────────────────────────────────
 
 /**

package/upload.mjs

@@ -15,7 +15,7 @@
  *   confluence-sync upload-file --page-id <ID> --file <path> [--name <文件名>]
  *   confluence-sync list-pages [--space <key>]
  *   confluence-sync list-files --page-id <ID>
- *   confluence-sync get-content --page-id <ID>
+ *   confluence-sync get-content --page-id <ID> [--markdown]
  *
  * 可选配置参数（优先于环境变量）：
  *   --base-url        Confluence 服务地址
@@ -31,6 +31,7 @@ import {
   listPages,
   listAttachments,
   getPageContent,
+  confluenceToMd,
   defaultSpaceKey,
   getBaseUrl,
   configure,
@@ -101,6 +102,7 @@ list-files 选项:
 
 get-content 选项:
   --page-id     页面 ID（必填）
+  --markdown    输出为 Markdown 格式（默认输出 Storage HTML）
 
 配置参数（优先于环境变量）:
   --base-url        Confluence 服务地址
@@ -252,8 +254,13 @@ async function main() {
         console.log(`标题:    ${page.title}`);
         console.log(`Space:   ${page.space?.key}`);
         console.log(`版本:    ${page.version?.number}`);
-        console.log(`\n── Storage HTML ──────────────────────────────\n`);
-        console.log(page.body.storage.value);
+        if (args.markdown) {
+          console.log(`\n── Markdown ──────────────────────────────\n`);
+          console.log(confluenceToMd(page.body.storage.value));
+        } else {
+          console.log(`\n── Storage HTML ──────────────────────────────\n`);
+          console.log(page.body.storage.value);
+        }
         break;
       }