@v1hz/md2docx 1.0.0 → 1.0.2

package/README.md

@@ -21,28 +21,42 @@
 - [Bun](https://bun.sh) ≥ 1.3
 - [pandoc](https://pandoc.org)（可选，需导出 Word 时安装）
 
-### 克隆并安装
+### 通过 npx（推荐，无需安装）
+
+```bash
+npx @v1hz/md2docx README.md
+```
+
+### 全局安装
+
+```bash
+npm install -g @v1hz/md2docx
+md2docx README.md
+```
+
+### 从源码运行
 
 ```bash
 git clone https://github.com/WXY-V1hZ/md2docx.git
 cd md2docx
 bun install
+bun run src/index.ts docs/example.md
 ```
 
 ## 快速开始
 
 ```bash
 # 处理 Markdown 并生成 Word 文档
-bun run src/index.ts docs/example.md
+npx @v1hz/md2docx docs/example.md
 
 # 只预处理，不调用 pandoc
-bun run src/index.ts docs/example.md --pandoc.enabled false
+npx @v1hz/md2docx docs/example.md --pandoc.enabled false
 
 # 指定输出路径
-bun run src/index.ts docs/example.md -o output/example.docx
+npx @v1hz/md2docx docs/example.md -o output/example.docx
 
 # 使用自定义配置文件
-bun run src/index.ts docs/example.md --config ./my-config.json
+npx @v1hz/md2docx docs/example.md --config ./my-config.json
 ```
 
 ## 配置
@@ -52,7 +66,7 @@ bun run src/index.ts docs/example.md --config ./my-config.json
 所有配置项均可通过命令行覆盖：
 
 ```bash
-bun run src/index.ts docs/example.md --figureCaption.enabled false
+npx @v1hz/md2docx docs/example.md --figureCaption.enabled false
 ```
 
 ### 配置项概览

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v1hz/md2docx",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "基于 pandoc 的 Markdown 转 Word (docx) 工具，自动处理标题、编号、Mermaid 图表等",
   "keywords": [
     "converter",
@@ -51,8 +51,10 @@
     "xpath": "^0.0.34"
   },
   "devDependencies": {
+    "@types/bun": "^1.3.14",
     "oxfmt": "^0.58.0",
-    "oxlint": "^1.73.0"
+    "oxlint": "^1.73.0",
+    "typescript": "^7.0.2"
   },
   "engines": {
     "bun": ">=1.3"

package/src/cli.ts

@@ -24,6 +24,7 @@ export interface ConfigOption {
 
 export interface CliOptions {
   help: boolean;
+  version: boolean;
   web: boolean;
   mdPath?: string;
   outputPath?: string;
@@ -60,7 +61,7 @@ export function getConfigOptions(schema: SchemaNode): ConfigOption[] {
 
 export function parseCliArgs(args: string[], configOptions: ConfigOption[]): CliOptions {
   const optionsByName = new Map(configOptions.map((option) => [option.path, option]));
-  const result: CliOptions = { help: false, web: false, overrides: new Map() };
+  const result: CliOptions = { help: false, version: false, web: false, overrides: new Map() };
   const positional: string[] = [];
 
   for (let i = 0; i < args.length; i++) {
@@ -69,6 +70,10 @@ export function parseCliArgs(args: string[], configOptions: ConfigOption[]): Cli
       result.help = true;
       continue;
     }
+    if (arg === "-v" || arg === "--version") {
+      result.version = true;
+      continue;
+    }
     if (arg === "--web") {
       result.web = true;
       continue;
@@ -132,6 +137,7 @@ export function formatHelp(configOptions: ConfigOption[]): string {
     "  -o <path>                         输出 docx 路径",
     "  --config <path>                   配置文件路径，默认 config/config.json",
     "  --web                             打开默认配置的网页编辑器",
+    "  -v, --version                     显示版本号",
     "  -h, --help                        显示帮助",
     "",
     "配置覆盖:",

package/src/index.ts

@@ -6,7 +6,7 @@ import { $ } from "bun";
 
 import { applyConfigOverrides, formatHelp, getConfigOptions, parseCliArgs } from "./cli";
 import { loadConfig } from "./config";
-import { CONFIG_PATH, CONFIG_SCHEMA_PATH, formattedMdPath, preprocessDir } from "./paths";
+import { CONFIG_PATH, CONFIG_SCHEMA_PATH, PKG_DIR, formattedMdPath, preprocessDir } from "./paths";
 import { preprocess } from "./preprocess/index";
 import { startWebEditor } from "./web";
 
@@ -16,6 +16,13 @@ export async function run(args: string[]): Promise<number> {
     const configOptions = getConfigOptions(schema);
     const cli = parseCliArgs(args, configOptions);
 
+    if (cli.version) {
+      const { version } = JSON.parse(await Bun.file(resolve(PKG_DIR, "package.json")).text()) as {
+        version: string;
+      };
+      console.log(`@v1hz/md2docx v${version}`);
+      return 0;
+    }
     if (cli.help) {
       console.log(formatHelp(configOptions));
       return 0;

package/src/paths.ts

@@ -1,15 +1,20 @@
-// ── 路径常量 ───────────────────────────────────────────
+import { resolve } from "path";
 
-/** 配置文件路径 */
-export const CONFIG_PATH = "config/config.json";
+const PKG_DIR = resolve(import.meta.dir, "..");
 
-/** 配置 schema 路径 */
-export const CONFIG_SCHEMA_PATH = "config/config.schema.json";
+/** 包根目录 */
+export { PKG_DIR };
 
-/** 临时文件根目录 */
+/** 默认配置文件路径（相对于包安装目录） */
+export const CONFIG_PATH = resolve(PKG_DIR, "config/config.json");
+
+/** 默认配置 schema 路径（相对于包安装目录） */
+export const CONFIG_SCHEMA_PATH = resolve(PKG_DIR, "config/config.schema.json");
+
+/** 临时文件根目录（相对于当前工作目录） */
 export const TMP_DIR = "tmp";
 
-/** 预处理模块的输出目录（相对于项目根目录） */
+/** 预处理模块的输出目录（相对于当前工作目录） */
 export function preprocessDir(baseName: string): string {
   return `${TMP_DIR}/preprocess/${baseName}`;
 }