# @elasticpath/textlint-rule-no-dead-relative-link 中文文档 规范地址：https://npmcn.com/package/%40elasticpath/textlint-rule-no-dead-relative-link/ 版本：1\.1\.1 npm 元数据更新时间：2024-06-04T00:17:49.197Z 中文译文更新时间：2026-11-13T12:39:39.077Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40elasticpath/textlint-rule-no-dead-relative-link 原文对照：https://npmcn.com/package/%40elasticpath/textlint-rule-no-dead-relative-link/?lang=original 项目主页：https://github.com/elasticpath/textlint-rule-no-dead-relative-link#readme 源码仓库：https://github.com/elasticpath/textlint-rule-no-dead-relative-link ## 关键信息（来自 npm 元数据） - 包体积（解压后）：33.2 kB，6 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - Node.js 要求：\>=6\.0\.0 - 运行依赖：3 个 - 首次发布：2022-04-25T18:57:59.163Z - 最新版本发布：2022-05-17T21:21:42.823Z - 近 30 天下载量：3974（2026-10-14 至 2026-11-12，npm 官方下载统计） - 已发布版本数：2（近 12 个月 0 个） ## 中文简介 Textlint 规则以验证下标文档中的相对链接(包括锁定链接) ## 安装 ```sh npm install @elasticpath/textlint-rule-no-dead-relative-link ``` 也可以使用：`pnpm add @elasticpath/textlint-rule-no-dead-relative-link`、`yarn add @elasticpath/textlint-rule-no-dead-relative-link`、`bun add @elasticpath/textlint-rule-no-dead-relative-link` ## README # 文本链接 - 规则 - 不死 - 相对链接 这是一个 [文本lint 规则](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule) 用于验证下调文档中的链接。 它所做的是: - 它忽略了外部链接. 这个 `RegExp` 用于过滤出此类链接的是 `/^[a-z][a-z0-9+.-]*:/i` - 对于所有相对链接,它会检查是否有由链接指定的文件. 相对链接相对于包含链接的文件解决. - 对于所有与主锚的相对链接,或仅在同一个文件中的主锚,它检查主锚是否存在. 它将锁定链接作为标记下文档的方式与github一样,即规则使用 [滑轮](https://github.com/Flet/github-slugger) 进行验证. ## 安装 - 由于这是文本lint规则,所以首先按照 [textlint 正在启动向导](https://textlint.github.io/docs/getting-started.html)。 。 。 . - 此规则作为 npm 软件包可用, 可以使用 - `npm install --save-dev textlint-rule-no-dead-relative-link` 或者说 - `yarn add --dev textlint-rule-no-dead-relative-link` 接下来 `yarn install` ## 使用量 如果你对Textlint不熟悉,请参考 [正在配置文本林特](https://textlint.github.io/docs/configuring.html) 用于 textlint 配置细节. 添加以下一个 `.textlintrc` 文件 - 没有任何选项 ```json { "rules": { "no-dead-relative-link": true } } ``` 或者说 - 有选项 ```json { "rules": { "no-dead-relative-link": { "resolve-as-markdown": "[.html]" } } } ``` 通过命令行参数使用 ``` textlint --rule textlint-rule-no-dead-relative-link README.md ``` ## 选项 ### 解析标记 此选项需要一系列文件扩展值, 并将带有这些扩展名的文件视为已标记的文件 . 为等. 配置如下: ```json { "rules": { "no-dead-relative-link": { "resolve-as-markdown": [".html"] } } } ``` 财务报告和审定财务报表 `[README](README.html)` 作为输入,此规则将检查是否存在 `README.md` 文档. ### 路径图 当需要使用替代文件路径验证相对链接时使用此选项 . 此选项需要一系列源和目的对 。 源值为 a `Regex`,目的地值为 (单位:千美元) `String` 包括来自 `source` 使用 `$` 标注. 为等. 配置如下: ```json { "rules": { "no-dead-relative-link": { "route-map": [ { "source": "^../javadocs/(\\d+\\.\\d+\\.\\w+)", "destination": "../../static/javadocs/$1" } ] } } } ``` 财务报告和审定财务报表 `../javadocs/1.0.x/overview-summary.html` 作为正在检查的链接,此规则检查是否存在 `overview-summary.html` 文件位于 `../../static/javadocs/1.0.x/overview-summary.html`。 。 。 . #### 路由图排序 确保每个 `route-map` 配对是具体的,因为路由图选项将使用第一个验证相对链接 匹配配置中发现的 regex . 为等. 配置如下: ```json { "rules": { "no-dead-relative-link": { "route-map": [ { "source": "../../javadocs/", "destination": "../website/static/javadocs/" }, { "source": "../javadocs/1.0.x/", "destination": "../../static/javadocs/1.0.x/" } ] } } } ``` 财务报告和审定财务报表 `../../javadocs/1.0.x/overview-summary.html` 作为正在检查的链接,此规则检查是否存在 `overview-summary.html` 第一个目的地的文件 `../website/static/javadocs/1.0.x/overview-summary.html` 换成 第二个目的地 `../../static/javadocs/1.0.x/overview-summary.html`。 。 。 . ## 常见问题 ### @elasticpath/textlint-rule-no-dead-relative-link 是什么？ Textlint 规则以验证下标文档中的相对链接\(包括锁定链接\) ### 如何安装 @elasticpath/textlint-rule-no-dead-relative-link？ 在项目目录运行 npm install @elasticpath/textlint-rule-no-dead-relative-link，或使用 pnpm add / yarn add / bun add。 ### @elasticpath/textlint-rule-no-dead-relative-link 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/elasticpath\_\_textlint-rule-no-dead-relative-link 是否存在。 ### @elasticpath/textlint-rule-no-dead-relative-link 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @elasticpath/textlint-rule-no-dead-relative-link 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=6\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @elasticpath/textlint-rule-no-dead-relative-link 可以商用吗？ @elasticpath/textlint-rule-no-dead-relative-link 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @elasticpath/textlint-rule-no-dead-relative-link 的下载量有多少？ 根据 npm 官方下载统计，@elasticpath/textlint-rule-no-dead-relative-link 在 2026/10/14 – 2026/11/12 这 30 天内被下载 3,974 次，日均约 132 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @elasticpath/textlint-rule-no-dead-relative-link 还在维护吗？ 最新版本 1\.1\.1 发布于 2022/05/18（4 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/04/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。