README

🌹 XULIETA

Xulieta 是一个轻量级的 PHP 二进制程序，用于检查文档片段。

Xulieta 是一个轻量级的 PHP 二进制程序，用于在文档文件（例如 *.md，*.markdown 和 *.rst）中找到代码片段，并检查代码，以便您可以找到基本的文档错误。

注意：目前我们只检查 PHP 代码。

安装

composer require codelicia/xulieta

检查错误

为了检查文档结构的基线，只需提供要检查的目录或文件的路径即可。

./vendor/bin/xulieta check:error <directory>

与 GitHub Actions 集成

我们提供了一种开箱即用的 output 格式，您可以使用它从 GitHub CI 获取自动反馈。这是通过指定 checkstyle 输出并将其传递给某些外部二进制文件来完成的，这些文件执行注释。

我们建议使用 cs2pr。

./vendor/bin/xulieta check:error <directory> --output=checkstyle | cs2pr

注释示例

高级配置

Xulieta 尝试在项目的根目录中找到 .xulieta.xml 文件，其配置格式如下

<?xml version="1.0" encoding="UTF-8" ?>
<xulieta xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="./vendor/codelicia/xulieta/xulieta.xsd">

    <parser>Codelicia\Xulieta\Parser\MarkdownParser</parser>
    <parser>Codelicia\Xulieta\Parser\RstParser</parser>

    <validator>Codelicia\Xulieta\Validator\PhpValidator</validator>

    <outputFormatters>Codelicia\Xulieta\Output\Checkstyle</outputFormatters>

    <exclude>vendor</exclude>
    <exclude>node_modules</exclude>
</xulieta>

• parser：处理基于扩展名的文件格式的所有解析器的列表
• validator：对给定的代码块执行验证
• outputFormatters：个性化的输出格式化程序
• exclude：排除的目录或文件

命令名称

出于历史原因和巴西 MEME 的考虑，我们保留了原始命令 xulieta check:erromeu。

插件

Xulieta 将自动扫描依赖项，以查看是否有任何包提供默认配置。

如果您想使您的插件利用该功能，我们期望您在您的 composer.json 文件中提供一些信息，即

{
  "extra": {
    "xulieta": {
      "parser": ["Malukenho\\QuoPrimumTempore\\JsonParser"],
      "validator": ["Malukenho\\QuoPrimumTempore\\JsonValidator"]
    }
  }
}

贡献者 ✨

感谢这些可爱的人 (emoji key)

本项目遵循 all-contributors 规范。欢迎任何形式的贡献！