{"_id":"@0bipinnata0/path-fixer","name":"@0bipinnata0/path-fixer","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@0bipinnata0/path-fixer","version":"1.0.0","description":"修复 DocC 文档中的绝对路径问题","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","repository":{"type":"git","url":"git+https://github.com/0bipinnata0/path-fixer.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"bin":{"path-fixer":"dist/index.js"},"keywords":["cli","docc","path","ios"],"author":"","license":"ISC","dependencies":{"cac":"^6.7.14","fs-extra":"^11.3.0"},"devDependencies":{"@types/fs-extra":"^11.0.4","tsup":"^8.4.0","typescript":"^5.8.2"},"scripts":{"dev":"tsup --watch","build":"tsup"},"_id":"@0bipinnata0/path-fixer@1.0.0","bugs":{"url":"https://github.com/0bipinnata0/path-fixer/issues"},"homepage":"https://github.com/0bipinnata0/path-fixer#readme","_integrity":"sha512-/byvA1lnBq66BzXmPnjTxZ316B0H4a2hAoKzJZuQWCoGufOthhECtkfwid3vokr6O1fSunc1ILmb01zmoDHpHg==","_resolved":"/tmp/2833feb70ee51bc5ff90a62e50e4bf2a/0bipinnata0-path-fixer-1.0.0.tgz","_from":"file:0bipinnata0-path-fixer-1.0.0.tgz","_nodeVersion":"20.18.3","_npmVersion":"10.8.2","dist":{"integrity":"sha512-/byvA1lnBq66BzXmPnjTxZ316B0H4a2hAoKzJZuQWCoGufOthhECtkfwid3vokr6O1fSunc1ILmb01zmoDHpHg==","shasum":"4aaa8bd46c2d639d76c4a31e27e5ac1865ecccef","tarball":"https://registry.npmjs.org/@0bipinnata0/path-fixer/-/path-fixer-1.0.0.tgz","fileCount":6,"unpackedSize":16383,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEvkncZTXe91qGmPSajtS/amRQDQN10eDIq9/oBCqn3cAiBou+oJAmjO3Z+vvTkHtg3fvlt7DgMDXzAkiOM+lXQwyQ=="}]},"_npmUser":{"name":"0bipinnata0","email":"odinzero@outlook.com"},"directories":{},"maintainers":[{"name":"0bipinnata0","email":"odinzero@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/path-fixer_1.0.0_1741678418347_0.9004150238680564"},"_hasShrinkwrap":false}},"time":{"created":"2025-03-11T07:33:38.285Z","1.0.0":"2025-03-11T07:33:38.586Z","modified":"2025-03-11T07:33:38.885Z"},"maintainers":[{"name":"0bipinnata0","email":"odinzero@outlook.com"}],"description":"修复 DocC 文档中的绝对路径问题","homepage":"https://github.com/0bipinnata0/path-fixer#readme","keywords":["cli","docc","path","ios"],"repository":{"type":"git","url":"git+https://github.com/0bipinnata0/path-fixer.git"},"bugs":{"url":"https://github.com/0bipinnata0/path-fixer/issues"},"license":"ISC","readme":"# Path-Fixer\n\n一个用于修复 iOS DocC 文档中绝对路径问题的命令行工具。\n\n## 问题背景\n\niOS 使用 DocC 生成的文档在不同环境下部署时，由于绝对路径的问题，可能导致资源无法正确加载。这个工具可以自动修复这些路径问题。\n\n## 安装\n\n```bash\n# 全局安装\nnpm install -g path-fixer\n\n# 或使用 pnpm\npnpm add -g path-fixer\n```\n\n## 使用方法\n\n```bash\n# 基本用法\npath-fixer fix ./SlothCreator.doccarchive --base-url=/SlothCreator.doccarchive\n\n# 显示详细日志\npath-fixer fix ./SlothCreator.doccarchive --base-url=/SlothCreator.doccarchive --verbose\n\n# 查看帮助\npath-fixer --help\n\n# 查看版本\npath-fixer --version\n```\n\n### 参数说明\n\n- `fix <docArchivePath>`: 指定要修复的 DocC 文档路径\n- `--base-url <baseUrl>`: 设置基础 URL 前缀，默认为空\n- `--verbose`: 显示详细日志信息，默认为 false\n\n## 工作原理\n\n该工具会扫描指定目录中的所有 HTML 文件，执行以下替换操作：\n\n1. 替换 HTML 文件中的 `baseUrl = \"/\"` 为用户指定的 `baseUrl` 值\n2. 替换以下模式的绝对路径引用：\n```\n\"/js/file.js\" -> \"/your-base-url/js/file.js\"\n\"/css/style.css\" -> \"/your-base-url/css/style.css\"\n```\n\n工具会确保替换后的 `baseUrl` 前后都有且仅有一个斜杠，例如：\n- 如果用户输入 `--base-url=my-docs`，将被标准化为 `/my-docs`\n- 如果用户输入 `--base-url=/my-docs/`，将被标准化为 `/my-docs`\n\n该工具会直接修改原始文件。**请在运行工具之前备份重要文件**。\n\n### 日志级别\n\n工具提供两种日志级别：\n\n1. **默认模式**: 只显示基本信息和错误\n2. **详细模式 (--verbose)**: 显示处理过程中的详细信息，包括每个文件的处理状态\n\n## 开发\n\n```bash\n# 克隆仓库\ngit clone https://github.com/yourusername/path-fixer.git\ncd path-fixer\n\n# 安装依赖\npnpm install\n\n# 开发模式\npnpm dev\n\n# 构建\npnpm build\n```\n\n## 发布流程\n\n项目使用 GitHub Actions 自动化发布流程。发布新版本时，请遵循以下步骤：\n\n1. 更新 `package.json` 中的版本号\n2. 提交更改并推送到主分支\n3. 创建一个新的 Git 标签，格式为 `v*`（例如 `v1.0.1`）\n4. 推送标签到 GitHub\n\n```bash\n# 示例发布流程\ngit add .\ngit commit -m \"feat: 添加新功能\"\nnpm version patch  # 或 minor 或 major\ngit push\ngit push --tags\n```\n\n当标签推送到 GitHub 后，GitHub Actions 会自动构建并发布包到 npm。\n\n## 代码结构\n\n项目的主要代码文件：\n\n- `src/index.ts`: 命令行入口点和主要逻辑\n- `src/replacer.ts`: 文件路径替换功能\n- `src/logger.ts`: 日志处理功能\n\n## 许可证\n\nISC ","readmeFilename":"README.md","_rev":"1-39487e6df06c9ae06d05fae1e653a869"}