jordikroon/docbook-cs

A static-analysis linter for DocBook XML files

1.1.2 2026-04-30 20:36 UTC

Requires

• php: ^8.5
• ext-dom: *
• ext-libxml: *
• ext-simplexml: *

Requires (Dev)

• phpstan/phpstan: ^2.1
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/php-code-coverage: ^14.1
• phpunit/phpunit: ^13.1
• squizlabs/php_codesniffer: ^4.0

Apache-2.0

• Jordi Kroon

README

A static-analysis linter for DocBook XML files. It scans XML documentation sources and reports style and convention violations.

Full documentation: jordikroon.github.io/docbook-cs

Contributing

Requirements

• PHP 8.5+
• Extensions: dom, libxml, simplexml

Setup

composer install

Running checks

# Tests
vendor/bin/phpunit

# Static analysis
vendor/bin/phpstan

# Code style
vendor/bin/phpcs

Writing a sniff

Implement DocbookCS\Sniff\SniffInterface (or extend AbstractSniff):

namespace Acme\DocbookSniffs;

use DocbookCS\Sniff\AbstractSniff;

final class MySniff extends AbstractSniff
{
    public function getCode(): string
    {
        return 'Acme.MySniff';
    }

    public function process(\DOMDocument $document, string $content, string $filePath): array
    {
        $violations = [];
        // ... inspect $document, add violations via $this->createViolation(...)
        return $violations;
    }
}

Register it in your config:

<sniff class="Acme\DocbookSniffs\MySniff" />

License

Apache 2.0