README

警告此库非常实验性。

🤓 文献编程？

文献编程是由Donald Knuth提出的一种编程范式，其中计算机程序在自然语言（如英语）中给出其逻辑的解释，穿插着宏和传统源代码的片段，从而可以生成可编译的源代码。这种方法在科学计算和数据科学中通常用于可重复研究和开放访问目的。今天，数百万程序员使用文献编程工具。

注意此库将进行代码检查并运行PHP代码，请小心处理副作用。

安装

composer require codelicia/xulieta-lp --dev

检查错误

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

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

与GitHub Actions集成

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

我们推荐使用cs2pr。

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

高级配置

要启用它，您应使用以下parser和validator配置.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\XulietaPhpLP\Parser\MarkdownParser</parser>
   <validator>Codelicia\XulietaPhpLP\LiterateProgramming</validator>

</xulieta>

内部结构

点击查看内部图

作者 🎩✨

malukenho (@malukenho)
Eher (@EHER)

codelicia / xulieta-php-lp

维护者

详细信息