外部参照检查

[图书馆，英里/小时，程序，未分类的][建议标签]

请参阅GitHub上的自述文件https://github.com/serokell/xrefcheck#自述文件

[跳到自述]

模块

[上次文档]

外部参照检查
- 外部参照检查。CLI（命令行界面）
- 外部参照检查。命令
- 外部参照检查。配置
  - 外部参照检查。配置。违约
- 外部参照检查。核心
- 外部参照检查。孤儿
- 外部参照检查。进度
- 外部参照检查。扫描
- 外部参照检查。扫描仪
  - 外部参照检查。扫描仪。降价
- 外部参照检查。系统
- 外部参照检查。Util公司
  - 外部参照检查。实用程序。着色
- 外部参照检查。验证

下载

外部参照检查0.2.2.tar.gz[浏览]（Cabal源包）
程序包描述(修订过的从包中）

注意：此软件包具有元数据修订在阴谋集团的描述中比tarball中包含的更新。要打开包含修订的包，请使用“cabal-get”。

维修人员角落

包装维护人员

格鲁马克，马图恩，dcastro公司，塞罗凯尔

对于包维护者和黑客托管者

编辑程序包信息

候选人

没有候选人

版本[RSS（RSS）]	0.1.0.0，0.1.1，0.1.1.1，0.1.1.2，0.1.2，0.1.3，0.2，0.2.1，0.2.2
更改日志	变化.md
依赖关系	伊森，aeson套管，异步，基础（>=4.14.3.0&&<5），字节删除，cmark-gfm公司(>=0.2.5)，容器，数据默认值，目录，数据清单，例外，文件路径，柔性制造技术，ftp客户端，手套，http-客户端，http类型，透镜，现代美国，mtl公司，o时钟，optparse应用程序(<0.18)，漂亮的码头，过程，原始字符串-qq，反射，正则表达式-tdfa，请求，塔格汤，文本，文本度量，th-lift实例，时间，变压器，宇宙，尿液分泌，带-utf8，外部参照检查，山药[细节]
许可证	MPL-2.0标准
版权	2018-2019年塞罗基尔<https://serokell.io>
作者	塞罗基尔·克斯特亚·伊万诺夫
维护人员	塞罗基尔<hi@serokell.io邮箱>
修订过的	第1次修订制造商安德烈亚斯·阿贝尔在2023-06-10T17:38:06Z
主页	https://github.com/serokell/xrefcheck#自述文件
Bug跟踪器	https://github.com/serokell/xrefcheck/issues
源回购	头：git克隆https://github.com/serokell/xrefcheck网站
已上传	通过dcastro公司在2022-10-26T10:56:01Z
分配
可执行程序	外部参照检查
下载	总计1147人（过去30天内有7人）
额定值	（尚未投票）[估算人贝叶斯平均]
您的评分	λ λ λ
状态	文档不可用[生成日志] 截至2022-10-26年，所有报告的构建都失败[所有2个报告]

外部参照检查自述文件0.2.2

[返回包描述]

外部参照检查

Xrefcheck是一种用于验证存储库文档中本地和外部引用的工具，该工具快速、易于设置，并且适合添加到CI中。

动机

随着项目的发展，文档中的链接有断开的趋势。这通常是因为：

文件移动；
降价标题重命名；
外部站点停止存在。

此工具将帮助您保持参考的有序性。

目的

与其他解决方案相比，此工具尝试实现以下几点：

快速性-即使对于中等大小的存储库，也会立即验证本地引用。
简单的设置-无需额外操作，只需在存储库根目录中运行该工具即可。现成支持相对和绝对本地链接。
保守的验证器允许在CI中使用此工具，不应报告误报（例如在需要验证的站点上）。

与其他解决方案的比较

链接（linky）-一个用Rust编写的配置良好的验证器，一次扫描一个指定的文件，与诸如找到.此工具需要进行一些配置，然后才能应用于存储库或添加到CI。
棒极了-用Ruby编写的解决方案，可以轻松地包含在CI中或集成到GitHub中。它的功能包括重复URL检测、指定允许的HTTP错误代码和报告生成。在写作时，它只扫描外部引用，不可能检查锚定。
备注验证链接和remark-lint-no-dead-urls公司-高度可配置的Javascript解决方案，用于分别检查本地和远程链接。如果多个存储库集中在一个文件夹中，它可以一次检查它们。使用JavaScript编写，在大型存储库上速度相当慢。
标记-链接-检查-另一个用JavaScript编写的检查器每次扫描一个特定的文件。支架邮寄地址：链接解析。
url检查器-检查指定文件中链接的GitHub操作。
链接检查-高级网站爬虫，检查HTML格式文件夹。对于这项特殊任务，还有其他解决方案，我们在这里没有提到。

在编写本文时，列出的解决方案不支持ftp/ftps链接。

依赖关系↑

外部参照检查要求您吉特PATH中的2.18.0或更高版本。

用法↑

我们为您提供了以下使用外部参照检查的方法：

如果这些都不适合你，请打开一个问题！

要查找存储库中所有断开的链接，请从其文件夹中运行：

外部参照检查

要同时显示所有找到的链接和定位，请执行以下操作：

外部参照检查-v

有关其他选项的说明：

xrefcheck帮助

特殊功能

忽略外部链接

如果不想验证某些外部链接，可以使用以下方法之一忽略这些链接：

将与忽略链接匹配的正则表达式添加到ignoreRefs（忽略参考）配置文件的参数。

例如：
```
ignoreRefs（忽略参考）：-https://bad.参考。（org|com）（/？）
```
允许忽略这两者https://bad.reference.org和https://bad.reference.com带或不带最后一个“/”。
使用以下忽略模式之一添加右侧就地注释（每个模式只是具有特定语法的注释）。
- 忽略链接：
  
  有几种方法可以添加此注释：
  - 只需在忽略链接之前像常规文本一样添加它。
```
错误的['com'引用](https://bad.reference.com) 和错误的[“org”引用](https://bad.reference.org网站)
```
  - 用单行新行将忽略链接与注释和以下文本分开。
```
错误的['com'引用](https://bad.reference.com)和坏<！--xrefcheck:忽略链接-->[组织](https://bad.reference.org)参考
```
    因此，只有https://bad.reference.org网站将被忽略。
  - 如果忽略链接是段落中的第一个链接，则也可以在段落之前添加注释。
```
[错误的“组织”引用](https://bad.reference.org)[错误的“com”引用](https://bad.reference.com)
```
    还是一样的https://bad.reference.org在这种情况下将被忽略。
- 忽略以下段落：
```
错误的['org'引用](https://bad.reference.org)错误的['com'引用](https://bad.reference.com)错误的['io'引用](https://bad.参考.io)
```
  这样，https://bad.reference.org和https://bad.reference.com将被忽略，并且https://bad.参考.io仍将进行验证。
- 忽略整个文件：
```
…文件的其余部分。。。
```
  使用此选项可以忽略整个文件。

正在配置

配置模板（解释了所有选项）可以转储为：

xrefcheck转储配置-t GitHub

当前支持的选项包括：

检查外部参考的超时；
忽略文件的列表。

构建说明↑

运行烟囱安装构建所有内容并安装可执行文件。如果你想使用阴谋集团，你需要运行(堆叠2容器)[https://hackage.haskell.org/package/stack2cabal]首先！

CI和nix↑

要仅生成可执行文件，请运行无构建。可以在CI上使用此行来使用外部参照检查：

nix运行-fhttps://github.com/serokell/xrefcheck/archive/master.tar.gz-c外部参照检查

我们的CI使用nix-build xrefcheck.nix构建整个项目，包括测试和Haddock。它基于哈斯克尔nix项目。如果你愿意，你也可以这样做。

用于进一步的工作↑

支持非Unix系统。
支持不同语言的链接检测，而不仅仅是Markdown。
- 哈斯克尔·哈多克（Haskell Haddock）位居第一。

问题跟踪程序↑

我们使用GitHub问题作为问题跟踪程序。您可以使用GitHub帐户登录以发表评论或创建新问题。

供参与者使用↑

请参阅贡献.md了解更多信息。

关于Serokell↑

外部参照检查由❤️ 通过塞罗凯尔.塞罗基尔的名称和标志是塞罗基尔奥尤的商标。

我们喜欢开源软件！请参见我们的其他项目或雇佣我们设计、发展和发展您的想法！