codelicia / xulieta
Xulieta is a light php binary that lint documentation snippets
Installs: 2 178
Dependents: 1
Suggesters: 0
Security: 0
Stars: 62
Watchers: 4
Forks: 4
Open Issues: 5
Requires
- php: >=7.4 | ~8.0
- beberlei/assert: ^v3.2.7
- doctrine/rst-parser: ^0.1.0
- nikic/php-parser: ^v4.10.2
- ocramius/package-versions: ^1.9
- symfony/config: ^v5.1.8
- symfony/console: ^v5.1.8
- symfony/finder: ^v5.1.8
- symfony/process: ^v5.1.8
- webmozart/assert: ^1.9.1
Requires (Dev)
- doctrine/coding-standard: ^8.2.0
- infection/infection: ^0.19.2
- malukenho/mcbumpface: ^1.1.5
- phpunit/phpunit: ^9.4.2
- roave/security-advisories: dev-master
- staabm/annotate-pull-request-from-checkstyle: ^1.4.0
- vimeo/psalm: ^4.1.1
README
🌹 XULIETA
Xulieta is a light php binary that lint documentation snippets.
Xulieta is a light php binary that find code snippets thought out
documentation files — as for example *.md
, *.markdown
and *.rst
— and lint the pieces of code, so you can find basic documentation errors.
NOTE: For now we just lint PHP code.
Installation
composer require codelicia/xulieta
Checking for errors
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>
Integration with GitHub Actions
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
commenting.
We recommend the usage of cs2pr.
./vendor/bin/xulieta check:erromeu <directory> --output=checkstyle | cs2pr
Commenting example
Advanced Configuration
Xulieta tries to find a .xulieta.xml
file in the root of your project
with the following configuration format:
<?xml version="1.0" encoding="UTF-8" ?> <xulieta xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/codelicia/xulieta/xulieta.xsd"> <plugin>Codelicia\Xulieta\Plugin\PhpOnMarkdownPlugin</plugin> <plugin>Codelicia\Xulieta\Plugin\PhpOnRstPlugin</plugin> <exclude>vendor</exclude> <exclude>node_modules</exclude> </xulieta>
plugin
: listing of all formats handlersexclude
: excluded directory or files
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Alexandre Eher 🚇 🚧 💻 |
Jefersson Nathan 🚇 🚧 💻 |
Airton Zanon 👀 |
This project follows the all-contributors specification. Contributions of any kind welcome!