https://github.com/codelicia/xulieta

🌹Xulieta is a light php executable that lint documentation snippets
https://github.com/codelicia/xulieta

documentation documentation-lint lint linter php

Last synced: 3 months ago
JSON representation

🌹Xulieta is a light php executable that lint documentation snippets

Host: GitHub
URL: https://github.com/codelicia/xulieta
Owner: codelicia
License: mit
Created: 2020-02-01T12:29:30.000Z (about 6 years ago)
Default Branch: 2.0.x
Last Pushed: 2026-01-14T12:47:38.000Z (4 months ago)
Last Synced: 2026-01-14T16:52:54.394Z (4 months ago)
Topics: documentation, documentation-lint, lint, linter, php
Language: PHP
Size: 505 KB
Stars: 67
Watchers: 4
Forks: 5
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

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

```shell script
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.

```shell script
./vendor/bin/xulieta check:error
```

### 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](https://github.com/staabm/annotate-pull-request-from-checkstyle).

```
./vendor/bin/xulieta check:error --output=checkstyle | cs2pr
```

#### Commenting example

$Codelicia\Xulieta$

### Advanced Configuration

**Xulieta** tries to find a `.xulieta.xml` file in the root of your project
with the following configuration format:

```xml

Codelicia\Xulieta\Parser\MarkdownParser
Codelicia\Xulieta\Parser\RstParser

Codelicia\Xulieta\Validator\PhpValidator

Codelicia\Xulieta\Output\Checkstyle

vendor
node_modules

```

- `parser`: listing of all parses to handle file formats based in the extention name
- `validator`: performs verification on a given code block
- `outputFormatters`: personalized output formatter
- `exclude`: 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:

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

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Alexandre Eher}
🚇 🚧 💻

_{Jefersson Nathan}
🚇 🚧 💻

_{Airton Zanon}
👀