PHPackages                             codelicia/xulieta - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. codelicia/xulieta

ActiveComposer-plugin[Utility & Helpers](/categories/utility)

codelicia/xulieta
=================

Xulieta is a light php binary that lint documentation snippets

1.0.0(4y ago)6713.7k↓46.7%5[3 issues](https://github.com/codelicia/xulieta/issues)[10 PRs](https://github.com/codelicia/xulieta/pulls)5MITPHPPHP ~7.4 || ~8.0CI failing

Since Apr 23Pushed 5d ago4 watchersCompare

[ Source](https://github.com/codelicia/xulieta)[ Packagist](https://packagist.org/packages/codelicia/xulieta)[ Docs](https://github.com/codelicia/xulieta)[ GitHub Sponsors](https://github.com/EHER)[ GitHub Sponsors](https://github.com/malukenho)[ RSS](/packages/codelicia-xulieta/feed)WikiDiscussions 2.0.x Synced 2d ago

READMEChangelog (7)Dependencies (17)Versions (30)Used By (5)

 [![Xulieta](./meme.jpg)](./meme.jpg)

 🌹 XULIETA
===========

[](#--xulieta-)

###  Xulieta is a light php binary that lint documentation snippets.

[](#-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

[](#installation)

```
composer require codelicia/xulieta
```

### Checking for errors

[](#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:error
```

### Integration with GitHub Actions

[](#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

[](#commenting-example)

[![Codelicia\Xulieta](./github-action.png)](./github-action.png)

### Advanced Configuration

[](#advanced-configuration)

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

```

    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

[](#command-name)

For historic reasons and the sake of the Brazilian MEME we keep the original command `xulieta check:erromeu`.

Plugins
-------

[](#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:

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

Contributors ✨
--------------

[](#contributors-)

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

  [![](https://avatars0.githubusercontent.com/u/398034?v=4)
**Alexandre Eher**](http://about:blank)
[🚇](#infra-EHER "Infrastructure (Hosting, Build-Tools, etc)") [🚧](#maintenance-EHER "Maintenance") [💻](https://github.com/codelicia/xulieta/commits?author=EHER "Code") [![](https://avatars2.githubusercontent.com/u/3275172?v=4)
**Jefersson Nathan**](https://twitter.com/malukenho)
[🚇](#infra-malukenho "Infrastructure (Hosting, Build-Tools, etc)") [🚧](#maintenance-malukenho "Maintenance") [💻](https://github.com/codelicia/xulieta/commits?author=malukenho "Code") [![](https://avatars1.githubusercontent.com/u/6540546?v=4)
**Airton Zanon**](https://airton.dev)
[👀](https://github.com/codelicia/xulieta/pulls?q=is%3Apr+reviewed-by%3Aairtonzanon "Reviewed Pull Requests") This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

###  Health Score

53

—

FairBetter than 96% of packages

Maintenance64

Regular maintenance activity

Popularity37

Limited adoption so far

Community27

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 69.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~149 days

Recently: every ~384 days

Total

13

Last Release

467d ago

Major Versions

0.1.x-dev → 1.0.02022-02-25

1.0.x-dev → 2.0.x-dev2025-03-23

PHP version history (4 changes)0.1.0PHP >=7.4

0.1.3PHP >=7.4 | ~8.0

1.0.0PHP ~7.4 || ~8.0

2.0.x-devPHP ~8.4.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/1582e6b6023d34b69760da85219041ab8b376706b86ec03d942d12f946e4a7dc?d=identicon)[EHER](/maintainers/EHER)

![](https://www.gravatar.com/avatar/7140a8c7b834b07674c6bd74d6cb75792522ceba17dfb1f347489083a0ba1c48?d=identicon)[malukenho](/maintainers/malukenho)

---

Top Contributors

[![malukenho](https://avatars.githubusercontent.com/u/3275172?v=4)](https://github.com/malukenho "malukenho (206 commits)")[![EHER](https://avatars.githubusercontent.com/u/398034?v=4)](https://github.com/EHER "EHER (46 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (28 commits)")[![allcontributors[bot]](https://avatars.githubusercontent.com/in/23186?v=4)](https://github.com/allcontributors[bot] "allcontributors[bot] (6 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (4 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (2 commits)")[![Ocramius](https://avatars.githubusercontent.com/u/154256?v=4)](https://github.com/Ocramius "Ocramius (1 commits)")[![ScullWM](https://avatars.githubusercontent.com/u/1017746?v=4)](https://github.com/ScullWM "ScullWM (1 commits)")[![szepeviktor](https://avatars.githubusercontent.com/u/952007?v=4)](https://github.com/szepeviktor "szepeviktor (1 commits)")

---

Tags

documentationdocumentation-lintlintlinterphpdocumentationlintercheck documentation

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Type Coverage Yes

### Embed Badge

![Health badge](/badges/codelicia-xulieta/health.svg)

```
[![Health](https://phpackages.com/badges/codelicia-xulieta/health.svg)](https://phpackages.com/packages/codelicia-xulieta)
```

###  Alternatives

[jolicode/castor

A lightweight and modern task runner. Automate everything. In PHP.

54743.1k4](/packages/jolicode-castor)[rector/rector-src

Instant Upgrade and Automated Refactoring of any PHP code

136406.3k14](/packages/rector-rector-src)[typo3/cms

TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL.

1.2k1.9M122](/packages/typo3-cms)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.4M203](/packages/sulu-sulu)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.1k17.8k](/packages/prestashop-prestashop)[contao/core-bundle

Contao Open Source CMS

1231.6M2.8k](/packages/contao-core-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)