wouterj / docbot
A linter tool for documentations.
0.2.0
2015-07-23 20:18 UTC
Requires
- php: >=5.4
- gnugat/redaktilo: ~1.7
- sebastian/diff: ^1.3
- sebastian/git: ^2.0
- symfony/config: ~2.3
- symfony/console: ~2.3
- symfony/dependency-injection: ~2.5
- symfony/finder: ~2.3
- symfony/validator: ~2.7
Requires (Dev)
- phpunit/phpunit: ^4.7
- symfony/phpunit-bridge: ^2.7
This package is auto-updated.
Last update: 2024-10-25 01:35:54 UTC
README
Welcome to DocBot! This bot will lint your documentation files according to the Symfony Doc Standards.
Install
$ composer global require wouterj/docbot
Lint
# linting a directory
$ docbot lint some_directory/
# linting a file
$ docbot lint path/to/file.rst
# ignoring files (like backup files)
$ docbot lint --ignore *~ some_directory/
# or
$ docbot lint -i *~ some_directory/
# specifying a reviewer type (available types: rst, doc, symfony)
$ docbot lint --types rst ...
# or
$ docbot lint -t rst ...
# or multiple types
$ docbot lint -t rst -t doc ...
Contribute
You started reading this section? You're my hero! Feel free to submit PRs, issues or do any other thing that benefits Docbot.
Internals
The DocBot is written as a big validator, each reviewer being a
ConstraintValidator for a class constraint of Gnugat\Redaktilo\Text
.
License
This project is created under the BSD license.