lark-docx2md 0.3.1-0 → 0.3.2

package/dist/cli.js

@@ -59,7 +59,7 @@ program.command("download").alias("dl").description("Download a wiki document to
 		wbFormat: opts.wbFormat,
 		agent: agentLocal ? "local" : opts.agent === true
 	});
-	if (agentLocal) process.stdout.write(`The Feishu document has been downloaded to the following absolute path:\n${result.filePath}\n\nPlease read this file to access the full markdown content.\n`);
+	if (agentLocal) process.stdout.write(`**The Feishu document has been downloaded to the following absolute path:**\n\n\`${result.filePath}\`\n\n**Read this file to access the full markdown content.**\n`);
 	else if (opts.agent === true) process.stdout.write(result.markdown);
 });
 program.parse();

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { Command } from 'commander';\nimport { LoggerLevel } from '@larksuiteoapi/node-sdk';\nimport { convert } from './converter.js';\nimport { setLogLevel } from './logger.js';\nimport type { SvgBackground, WbFormat, WbImageMode } from './types.js';\n\nconst program = new Command();\nprogram.name('larkDocx2md').description('Download Lark/Feishu documents to markdown');\n\nprogram\n  .command('download')\n  .alias('dl')\n  .description('Download a wiki document to markdown')\n  .option('--app-id <id>', 'Feishu app ID (or read from LARK_DOCX2MD_APP_ID)')\n  .option('--app-secret <secret>', 'Feishu app secret (or read from LARK_DOCX2MD_APP_SECRET)')\n  .option('-o, --output <dir>', 'Output directory (or LARK_DOCX2MD_OUTPUT)')\n  .option('--agent [mode]', 'Enable agent mode: ERROR log level, and AI-oriented stdout. Pass \"local\" to save markdown/images/whiteboards to disk and print a read-file prompt (or LARK_DOCX2MD_AGENT=true|local)')\n  .option('--wb-format <format>', 'Whiteboard output format: \"base64\", \"inline-svg\", \"svg\", or \"yaml\" (or LARK_DOCX2MD_WB_FORMAT)')\n  .option('--wb-bg <style>', 'Whiteboard SVG background: \"none\", \"dot\", or a color like \"#fff\" (or LARK_DOCX2MD_WB_BG)')\n  .option('--wb-image-mode <mode>', 'Whiteboard image mode: \"online\", \"base64\", or \"local\" (or LARK_DOCX2MD_WB_IMAGE_MODE)')\n  .option('--image-mode <mode>', 'Image handling mode: \"local\" or \"online\" (or LARK_DOCX2MD_IMAGE_MODE)')\n  .argument('<url>', 'Feishu wiki document URL: https://*.feishu.cn/wiki/*')\n  .action(async (url: string, opts: { appId?: string; appSecret?: string; output?: string; agent?: boolean | string; imageMode?: string; wbImageMode?: string; wbBg?: SvgBackground; wbFormat?: string }) => {\n    // ─── 环境变量默认值（直接指定 > 环境变量 > 内置默认值）────────────────\n    opts.appId = opts.appId ?? process.env.LARK_DOCX2MD_APP_ID;\n    opts.appSecret = opts.appSecret ?? process.env.LARK_DOCX2MD_APP_SECRET;\n    opts.output = opts.output ?? process.env.LARK_DOCX2MD_OUTPUT ?? './larkDocx2mdOutput';\n    // 解析 --agent：可能为 undefined | true | 'local' | 其他字符串\n    if (opts.agent === undefined) {\n      const envAgent = process.env.LARK_DOCX2MD_AGENT;\n      if (envAgent === 'true') opts.agent = true;\n      else if (envAgent === 'local') opts.agent = 'local';\n      else opts.agent = false;\n    } else if (typeof opts.agent === 'string' && opts.agent !== 'local') {\n      program.error(`Invalid --agent value \"${opts.agent}\", only \"local\" is supported (or omit the value)`);\n    }\n    const agentEnabled = opts.agent === true || opts.agent === 'local';\n    const agentLocal = opts.agent === 'local';\n\n    opts.imageMode = opts.imageMode ?? process.env.LARK_DOCX2MD_IMAGE_MODE ?? 'local';\n    opts.wbFormat = opts.wbFormat ?? process.env.LARK_DOCX2MD_WB_FORMAT;\n    opts.wbBg = opts.wbBg ?? process.env.LARK_DOCX2MD_WB_BG ?? 'none';\n    opts.wbImageMode = opts.wbImageMode ?? process.env.LARK_DOCX2MD_WB_IMAGE_MODE ?? 'local';\n\n    // 设置 wb-format 默认值：--agent local 默认 inline-svg（兼容本地画板图片），--agent（在线）默认 yaml，其余 svg\n    if (!opts.wbFormat) {\n      opts.wbFormat = agentEnabled ? 'yaml' : 'svg';\n    }\n\n    if (agentEnabled) {\n      setLogLevel(LoggerLevel.error);\n      if (agentLocal) {\n        // --agent local：图片/画板图片均落盘\n        opts.imageMode = 'local';\n        opts.wbImageMode = 'local';\n      } else {\n        // --agent（在线）：一律在线，且画板仅支持内嵌形式\n        opts.imageMode = 'online';\n        opts.wbImageMode = 'online';\n      }\n      if (!['inline-svg', 'yaml'].includes(opts.wbFormat)) {\n        program.error(`Agent mode only supports \"inline-svg\" or \"yaml\" for --wb-format`);\n      }\n    } else {\n      // yaml 格式图片仅支持 online\n      if (opts.wbFormat === 'yaml') {\n        opts.wbImageMode = 'online';\n      }\n    }\n\n    if (opts.imageMode && !['local', 'online'].includes(opts.imageMode)) {\n      program.error(`Invalid --image-mode \"${opts.imageMode}\", must be \"local\" or \"online\"`);\n    }\n    if (!['base64', 'inline-svg', 'svg', 'yaml'].includes(opts.wbFormat)) {\n      program.error(`Invalid --wb-format \"${opts.wbFormat}\", must be \"base64\", \"inline-svg\", \"svg\", or \"yaml\"`);\n    }\n    if (!['online', 'base64', 'local'].includes(opts.wbImageMode)) {\n      program.error(`Invalid --wb-image-mode \"${opts.wbImageMode}\", must be \"online\", \"base64\", or \"local\"`);\n    }\n\n    const appId = opts.appId!;\n    const appSecret = opts.appSecret!;\n    if (!appId || !appSecret) {\n      program.error('Missing credentials: pass --app-id/--app-secret or set LARK_DOCX2MD_APP_ID/LARK_DOCX2MD_APP_SECRET');\n    }\n\n    const result = await convert({\n      appId,\n      appSecret,\n      url,\n      output: opts.output,\n      imageMode: opts.imageMode as 'local' | 'online',\n      wbImageMode: opts.wbImageMode as WbImageMode,\n      wbBg: opts.wbBg,\n      wbFormat: opts.wbFormat as WbFormat,\n      agent: agentLocal ? 'local' : (opts.agent === true),\n    });\n\n    if (agentLocal) {\n      // 本地模式：输出引导 AI 读取文件的提示词（绝对路径）\n      process.stdout.write(\n        `The Feishu document has been downloaded to the following absolute path:\\n` +\n        `${result.filePath}\\n\\n` +\n        `Please read this file to access the full markdown content.\\n`,\n      );\n    } else if (opts.agent === true) {\n      process.stdout.write(result.markdown);\n    }\n  });\n\nprogram.parse();\n"],"mappings":";;;;;AAOA,MAAM,UAAU,IAAI,SAAS;AAC7B,QAAQ,KAAK,cAAc,CAAC,YAAY,6CAA6C;AAErF,QACG,QAAQ,WAAW,CACnB,MAAM,KAAK,CACX,YAAY,uCAAuC,CACnD,OAAO,iBAAiB,mDAAmD,CAC3E,OAAO,yBAAyB,2DAA2D,CAC3F,OAAO,sBAAsB,4CAA4C,CACzE,OAAO,kBAAkB,yLAAuL,CAChN,OAAO,wBAAwB,yGAAiG,CAChI,OAAO,mBAAmB,iGAA2F,CACrH,OAAO,0BAA0B,8FAAwF,CACzH,OAAO,uBAAuB,4EAAwE,CACtG,SAAS,SAAS,uDAAuD,CACzE,OAAO,OAAO,KAAa,SAA+K;AAEzM,MAAK,QAAQ,KAAK,SAAS,QAAQ,IAAI;AACvC,MAAK,YAAY,KAAK,aAAa,QAAQ,IAAI;AAC/C,MAAK,SAAS,KAAK,UAAU,QAAQ,IAAI,uBAAuB;AAEhE,KAAI,KAAK,UAAU,KAAA,GAAW;EAC5B,MAAM,WAAW,QAAQ,IAAI;AAC7B,MAAI,aAAa,OAAQ,MAAK,QAAQ;WAC7B,aAAa,QAAS,MAAK,QAAQ;MACvC,MAAK,QAAQ;YACT,OAAO,KAAK,UAAU,YAAY,KAAK,UAAU,QAC1D,SAAQ,MAAM,0BAA0B,KAAK,MAAM,kDAAkD;CAEvG,MAAM,eAAe,KAAK,UAAU,QAAQ,KAAK,UAAU;CAC3D,MAAM,aAAa,KAAK,UAAU;AAElC,MAAK,YAAY,KAAK,aAAa,QAAQ,IAAI,2BAA2B;AAC1E,MAAK,WAAW,KAAK,YAAY,QAAQ,IAAI;AAC7C,MAAK,OAAO,KAAK,QAAQ,QAAQ,IAAI,sBAAsB;AAC3D,MAAK,cAAc,KAAK,eAAe,QAAQ,IAAI,8BAA8B;AAGjF,KAAI,CAAC,KAAK,SACR,MAAK,WAAW,eAAe,SAAS;AAG1C,KAAI,cAAc;AAChB,cAAY,YAAY,MAAM;AAC9B,MAAI,YAAY;AAEd,QAAK,YAAY;AACjB,QAAK,cAAc;SACd;AAEL,QAAK,YAAY;AACjB,QAAK,cAAc;;AAErB,MAAI,CAAC,CAAC,cAAc,OAAO,CAAC,SAAS,KAAK,SAAS,CACjD,SAAQ,MAAM,kEAAkE;YAI9E,KAAK,aAAa,OACpB,MAAK,cAAc;AAIvB,KAAI,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,SAAS,KAAK,UAAU,CACjE,SAAQ,MAAM,yBAAyB,KAAK,UAAU,gCAAgC;AAExF,KAAI,CAAC;EAAC;EAAU;EAAc;EAAO;EAAO,CAAC,SAAS,KAAK,SAAS,CAClE,SAAQ,MAAM,wBAAwB,KAAK,SAAS,qDAAqD;AAE3G,KAAI,CAAC;EAAC;EAAU;EAAU;EAAQ,CAAC,SAAS,KAAK,YAAY,CAC3D,SAAQ,MAAM,4BAA4B,KAAK,YAAY,2CAA2C;CAGxG,MAAM,QAAQ,KAAK;CACnB,MAAM,YAAY,KAAK;AACvB,KAAI,CAAC,SAAS,CAAC,UACb,SAAQ,MAAM,qGAAqG;CAGrH,MAAM,SAAS,MAAM,QAAQ;EAC3B;EACA;EACA;EACA,QAAQ,KAAK;EACb,WAAW,KAAK;EAChB,aAAa,KAAK;EAClB,MAAM,KAAK;EACX,UAAU,KAAK;EACf,OAAO,aAAa,UAAW,KAAK,UAAU;EAC/C,CAAC;AAEF,KAAI,WAEF,SAAQ,OAAO,MACb,4EACG,OAAO,SAAS,kEAEpB;UACQ,KAAK,UAAU,KACxB,SAAQ,OAAO,MAAM,OAAO,SAAS;EAEvC;AAEJ,QAAQ,OAAO"}
+{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { Command } from 'commander';\nimport { LoggerLevel } from '@larksuiteoapi/node-sdk';\nimport { convert } from './converter.js';\nimport { setLogLevel } from './logger.js';\nimport type { SvgBackground, WbFormat, WbImageMode } from './types.js';\n\nconst program = new Command();\nprogram.name('larkDocx2md').description('Download Lark/Feishu documents to markdown');\n\nprogram\n  .command('download')\n  .alias('dl')\n  .description('Download a wiki document to markdown')\n  .option('--app-id <id>', 'Feishu app ID (or read from LARK_DOCX2MD_APP_ID)')\n  .option('--app-secret <secret>', 'Feishu app secret (or read from LARK_DOCX2MD_APP_SECRET)')\n  .option('-o, --output <dir>', 'Output directory (or LARK_DOCX2MD_OUTPUT)')\n  .option('--agent [mode]', 'Enable agent mode: ERROR log level, and AI-oriented stdout. Pass \"local\" to save markdown/images/whiteboards to disk and print a read-file prompt (or LARK_DOCX2MD_AGENT=true|local)')\n  .option('--wb-format <format>', 'Whiteboard output format: \"base64\", \"inline-svg\", \"svg\", or \"yaml\" (or LARK_DOCX2MD_WB_FORMAT)')\n  .option('--wb-bg <style>', 'Whiteboard SVG background: \"none\", \"dot\", or a color like \"#fff\" (or LARK_DOCX2MD_WB_BG)')\n  .option('--wb-image-mode <mode>', 'Whiteboard image mode: \"online\", \"base64\", or \"local\" (or LARK_DOCX2MD_WB_IMAGE_MODE)')\n  .option('--image-mode <mode>', 'Image handling mode: \"local\" or \"online\" (or LARK_DOCX2MD_IMAGE_MODE)')\n  .argument('<url>', 'Feishu wiki document URL: https://*.feishu.cn/wiki/*')\n  .action(async (url: string, opts: { appId?: string; appSecret?: string; output?: string; agent?: boolean | string; imageMode?: string; wbImageMode?: string; wbBg?: SvgBackground; wbFormat?: string }) => {\n    // ─── 环境变量默认值（直接指定 > 环境变量 > 内置默认值）────────────────\n    opts.appId = opts.appId ?? process.env.LARK_DOCX2MD_APP_ID;\n    opts.appSecret = opts.appSecret ?? process.env.LARK_DOCX2MD_APP_SECRET;\n    opts.output = opts.output ?? process.env.LARK_DOCX2MD_OUTPUT ?? './larkDocx2mdOutput';\n    // 解析 --agent：可能为 undefined | true | 'local' | 其他字符串\n    if (opts.agent === undefined) {\n      const envAgent = process.env.LARK_DOCX2MD_AGENT;\n      if (envAgent === 'true') opts.agent = true;\n      else if (envAgent === 'local') opts.agent = 'local';\n      else opts.agent = false;\n    } else if (typeof opts.agent === 'string' && opts.agent !== 'local') {\n      program.error(`Invalid --agent value \"${opts.agent}\", only \"local\" is supported (or omit the value)`);\n    }\n    const agentEnabled = opts.agent === true || opts.agent === 'local';\n    const agentLocal = opts.agent === 'local';\n\n    opts.imageMode = opts.imageMode ?? process.env.LARK_DOCX2MD_IMAGE_MODE ?? 'local';\n    opts.wbFormat = opts.wbFormat ?? process.env.LARK_DOCX2MD_WB_FORMAT;\n    opts.wbBg = opts.wbBg ?? process.env.LARK_DOCX2MD_WB_BG ?? 'none';\n    opts.wbImageMode = opts.wbImageMode ?? process.env.LARK_DOCX2MD_WB_IMAGE_MODE ?? 'local';\n\n    // 设置 wb-format 默认值：--agent local 默认 inline-svg（兼容本地画板图片），--agent（在线）默认 yaml，其余 svg\n    if (!opts.wbFormat) {\n      opts.wbFormat = agentEnabled ? 'yaml' : 'svg';\n    }\n\n    if (agentEnabled) {\n      setLogLevel(LoggerLevel.error);\n      if (agentLocal) {\n        // --agent local：图片/画板图片均落盘\n        opts.imageMode = 'local';\n        opts.wbImageMode = 'local';\n      } else {\n        // --agent（在线）：一律在线，且画板仅支持内嵌形式\n        opts.imageMode = 'online';\n        opts.wbImageMode = 'online';\n      }\n      if (!['inline-svg', 'yaml'].includes(opts.wbFormat)) {\n        program.error(`Agent mode only supports \"inline-svg\" or \"yaml\" for --wb-format`);\n      }\n    } else {\n      // yaml 格式图片仅支持 online\n      if (opts.wbFormat === 'yaml') {\n        opts.wbImageMode = 'online';\n      }\n    }\n\n    if (opts.imageMode && !['local', 'online'].includes(opts.imageMode)) {\n      program.error(`Invalid --image-mode \"${opts.imageMode}\", must be \"local\" or \"online\"`);\n    }\n    if (!['base64', 'inline-svg', 'svg', 'yaml'].includes(opts.wbFormat)) {\n      program.error(`Invalid --wb-format \"${opts.wbFormat}\", must be \"base64\", \"inline-svg\", \"svg\", or \"yaml\"`);\n    }\n    if (!['online', 'base64', 'local'].includes(opts.wbImageMode)) {\n      program.error(`Invalid --wb-image-mode \"${opts.wbImageMode}\", must be \"online\", \"base64\", or \"local\"`);\n    }\n\n    const appId = opts.appId!;\n    const appSecret = opts.appSecret!;\n    if (!appId || !appSecret) {\n      program.error('Missing credentials: pass --app-id/--app-secret or set LARK_DOCX2MD_APP_ID/LARK_DOCX2MD_APP_SECRET');\n    }\n\n    const result = await convert({\n      appId,\n      appSecret,\n      url,\n      output: opts.output,\n      imageMode: opts.imageMode as 'local' | 'online',\n      wbImageMode: opts.wbImageMode as WbImageMode,\n      wbBg: opts.wbBg,\n      wbFormat: opts.wbFormat as WbFormat,\n      agent: agentLocal ? 'local' : (opts.agent === true),\n    });\n\n    if (agentLocal) {\n      // 本地模式：输出引导 AI 读取文件的提示词（绝对路径）\n      process.stdout.write(\n        `**The Feishu document has been downloaded to the following absolute path:**\\n\\n` +\n        `\\`${result.filePath}\\`\\n\\n` +\n        `**Read this file to access the full markdown content.**\\n`,\n      );\n    } else if (opts.agent === true) {\n      process.stdout.write(result.markdown);\n    }\n  });\n\nprogram.parse();\n"],"mappings":";;;;;AAOA,MAAM,UAAU,IAAI,SAAS;AAC7B,QAAQ,KAAK,cAAc,CAAC,YAAY,6CAA6C;AAErF,QACG,QAAQ,WAAW,CACnB,MAAM,KAAK,CACX,YAAY,uCAAuC,CACnD,OAAO,iBAAiB,mDAAmD,CAC3E,OAAO,yBAAyB,2DAA2D,CAC3F,OAAO,sBAAsB,4CAA4C,CACzE,OAAO,kBAAkB,yLAAuL,CAChN,OAAO,wBAAwB,yGAAiG,CAChI,OAAO,mBAAmB,iGAA2F,CACrH,OAAO,0BAA0B,8FAAwF,CACzH,OAAO,uBAAuB,4EAAwE,CACtG,SAAS,SAAS,uDAAuD,CACzE,OAAO,OAAO,KAAa,SAA+K;AAEzM,MAAK,QAAQ,KAAK,SAAS,QAAQ,IAAI;AACvC,MAAK,YAAY,KAAK,aAAa,QAAQ,IAAI;AAC/C,MAAK,SAAS,KAAK,UAAU,QAAQ,IAAI,uBAAuB;AAEhE,KAAI,KAAK,UAAU,KAAA,GAAW;EAC5B,MAAM,WAAW,QAAQ,IAAI;AAC7B,MAAI,aAAa,OAAQ,MAAK,QAAQ;WAC7B,aAAa,QAAS,MAAK,QAAQ;MACvC,MAAK,QAAQ;YACT,OAAO,KAAK,UAAU,YAAY,KAAK,UAAU,QAC1D,SAAQ,MAAM,0BAA0B,KAAK,MAAM,kDAAkD;CAEvG,MAAM,eAAe,KAAK,UAAU,QAAQ,KAAK,UAAU;CAC3D,MAAM,aAAa,KAAK,UAAU;AAElC,MAAK,YAAY,KAAK,aAAa,QAAQ,IAAI,2BAA2B;AAC1E,MAAK,WAAW,KAAK,YAAY,QAAQ,IAAI;AAC7C,MAAK,OAAO,KAAK,QAAQ,QAAQ,IAAI,sBAAsB;AAC3D,MAAK,cAAc,KAAK,eAAe,QAAQ,IAAI,8BAA8B;AAGjF,KAAI,CAAC,KAAK,SACR,MAAK,WAAW,eAAe,SAAS;AAG1C,KAAI,cAAc;AAChB,cAAY,YAAY,MAAM;AAC9B,MAAI,YAAY;AAEd,QAAK,YAAY;AACjB,QAAK,cAAc;SACd;AAEL,QAAK,YAAY;AACjB,QAAK,cAAc;;AAErB,MAAI,CAAC,CAAC,cAAc,OAAO,CAAC,SAAS,KAAK,SAAS,CACjD,SAAQ,MAAM,kEAAkE;YAI9E,KAAK,aAAa,OACpB,MAAK,cAAc;AAIvB,KAAI,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,SAAS,KAAK,UAAU,CACjE,SAAQ,MAAM,yBAAyB,KAAK,UAAU,gCAAgC;AAExF,KAAI,CAAC;EAAC;EAAU;EAAc;EAAO;EAAO,CAAC,SAAS,KAAK,SAAS,CAClE,SAAQ,MAAM,wBAAwB,KAAK,SAAS,qDAAqD;AAE3G,KAAI,CAAC;EAAC;EAAU;EAAU;EAAQ,CAAC,SAAS,KAAK,YAAY,CAC3D,SAAQ,MAAM,4BAA4B,KAAK,YAAY,2CAA2C;CAGxG,MAAM,QAAQ,KAAK;CACnB,MAAM,YAAY,KAAK;AACvB,KAAI,CAAC,SAAS,CAAC,UACb,SAAQ,MAAM,qGAAqG;CAGrH,MAAM,SAAS,MAAM,QAAQ;EAC3B;EACA;EACA;EACA,QAAQ,KAAK;EACb,WAAW,KAAK;EAChB,aAAa,KAAK;EAClB,MAAM,KAAK;EACX,UAAU,KAAK;EACf,OAAO,aAAa,UAAW,KAAK,UAAU;EAC/C,CAAC;AAEF,KAAI,WAEF,SAAQ,OAAO,MACb,oFACK,OAAO,SAAS,iEAEtB;UACQ,KAAK,UAAU,KACxB,SAAQ,OAAO,MAAM,OAAO,SAAS;EAEvC;AAEJ,QAAQ,OAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lark-docx2md",
-  "version": "0.3.1-0",
+  "version": "0.3.2",
   "description": "Convert Lark/Feishu documents to Markdown",
   "type": "module",
   "main": "./dist/converter.js",
@@ -12,15 +12,11 @@
   "bin": {
     "larkDocx2md": "./dist/cli.js"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsx src/cli.ts",
-    "prepack": "pnpm build"
-  },
   "keywords": [
     "lark",
     "feishu",
     "markdown",
+    "sheet",
     "converter"
   ],
   "author": "byte",
@@ -36,7 +32,6 @@
   "engines": {
     "node": ">=18"
   },
-  "packageManager": "pnpm@10.30.1",
   "dependencies": {
     "@larksuiteoapi/node-sdk": "^1.60.0",
     "commander": "^14.0.3"
@@ -47,5 +42,9 @@
     "tsdown": "^0.12.9",
     "tsx": "^4.21.0",
     "typescript": "^6.0.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsx src/cli.ts"
   }
-}
+}