通过
搜索
搜索wouterj / docbot
文档校验工具。
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-08-25 01:16:17 UTC
README
欢迎使用DocBot！此机器人将根据Symfony 文档标准校验您的文档文件。
安装
$ composer global require wouterj/docbot
校验
# 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 ...
贡献
您开始阅读本节？您是我的英雄！请随意提交PR、问题或做任何有助于Docbot的事情。
内部结构
DocBot 被编写为一个大型验证器，每个审查者都是一个为 Gnugat\Redaktilo\Text 类约束的 ConstraintValidator。
许可证
本项目在BSD许可证下创建。