Download the PHP package codelicia/xulieta without Composer
On this page you can find all versions of the php package codelicia/xulieta. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codelicia/xulieta
More information about codelicia/xulieta
Files in codelicia/xulieta
Package xulieta
Short Description Xulieta is a light php binary that lint documentation snippets
License MIT
Homepage https://github.com/codelicia/xulieta
Informations about the package xulieta
🌹 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
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.
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.
Commenting example
Advanced Configuration
Xulieta tries to find a .xulieta.xml
file in the root of your project
with the following configuration format:
parser
: listing of all parses to handle file formats based in the extention namevalidator
: performs verification on a given code blockoutputFormatters
: personalized output formatterexclude
: excluded directory or files
Command name
For historic reasons and the sake of the Brazilian MEME we keep the original command xulieta check:erromeu
.
Plugins
Xulieta
will automatically scan dependencies to see if there is
any package that is providing default configurations.
If you want your plugin to take advantage of that functionality,
we expect you to provide some information on your composer.json
file, ie:
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!
All versions of xulieta with dependencies
ext-dom Version *
beberlei/assert Version ^v3.3.2
composer-plugin-api Version ^2.2
doctrine/rst-parser Version ^0.1.0 || ^0.3.0
nikic/php-parser Version ^v4.13.2
symfony/config Version ^v5.4.3
symfony/console Version ^v5.4.3
symfony/finder Version ^v5.4.3
symfony/process Version ^v5.4.3
webmozart/assert Version ^1.10.0