Xulieta Plugin for supporting of Literate programming
Literate programming is a programming paradigm introduced by Donald Knuth in which a computer program is given an explanation of its logic in a natural language, such as English, interspersed with snippets of macros and traditional source code, from which compilable source code can be generated. The approach is used in scientific computing and in data science routinely for reproducible research and open access purposes. Literate programming tools are used by millions of programmers today.
NOTE: For now we just lint PHP code, we don't run it.
composer require codelicia/xulieta-lp --dev
In order to lint the basics of documentation structure, one just needs to provide a path for a directory or file to be linted.
./vendor/bin/xulieta check:erromeu <directory>
We provide out of the box an
output format that you can use to have
automatic feedback from GitHub CI. That is done by specifying the
checkstyle output and passing it to some external binary that does the
We recommend the usage of cs2pr.
./vendor/bin/xulieta check:erromeu <directory> --output=checkstyle | cs2pr
In order to enable it, you should configure the
.xulieta.xml with the following
<?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)