通过 
搜索
搜索jwpage / composerdoc
用于显示包文档的命令行工具。
v2.0.0
2013-07-10 00:56 UTC
Requires
- symfony/console: >=2.1.0,<2.4
Requires (Dev)
- phpunit/phpunit: ~3.7.10
README
[](https://travis-ci. org/jwpage/composerdoc)
Composerdoc 是一个工具，允许您将项目中所需包的列表导出为用于文档的 Markdown 格式。
安装
通过运行 composer.phar require jwpage/composerdoc --dev 将此添加到您的 composer.json 中。
或者，由于 Composerdoc 是一个文档工具，您也可以单独安装它，并通过 --path 选项运行它。
echo -n '{ "require": { "jwpage/composerdoc": "*" } }' > composer.json
composer.phar install
使用方法
composerdoc dump
生成 composerdoc 输出
./vendor/bin/composerdoc --path <path_to_composer.json_dir>
包含开发需求
./vendor/bin/composerdoc --dev
包含需求的依赖项
./vendor/bin/composerdoc --sub
composerdoc check
您可以使用 composerdoc 检查 README 文件是否包含最新的 composerdoc 信息。
./vendor/bin/composerdoc --path <README.markdown>
此命令与 composerdoc dump 命令具有相同的选项。
composerdoc update
您还可以通过一个命令自动更新 README 文件，以包含最新的 composerdoc 信息。
./vendor/bin/composerdoc --path <README.markdown>
此命令与 composerdoc dump 命令具有相同的选项。
示例输出
所需包
- composer/composer: 包管理器: https://getcomposer.org.cn/
- justinrainbow/json-schema: 用于验证 JSON 架构的库: https://github.com/justinrainbow/json-schema
- seld/jsonlint: JSON Linter: 无
- symfony/console: Symfony 控制台组件: https://symfony.com.cn
- symfony/finder: Symfony Finder 组件: https://symfony.com.cn
- symfony/process: Symfony Process 组件: https://symfony.com.cn
- symfony/console: Symfony 控制台组件: https://symfony.com.cn
开发包
- phpunit/phpunit: PHP 单元测试框架: http://www.phpunit.de/
- phpunit/php-file-iterator: 基于后缀列表过滤文件的 FilterIterator 实现: http://www.phpunit.de/
- phpunit/php-text-template: 简单的模板引擎: https://github.com/sebastianbergmann/php-text-template/
- phpunit/php-code-coverage: 提供收集、处理和渲染 PHP 代码覆盖率信息的库: https://github.com/sebastianbergmann/php-code-coverage
- phpunit/php-timer: 用于计时的实用类: http://www.phpunit.de/
- phpunit/phpunit-mock-objects: PHPUnit 的 Mock Object 库: https://github.com/sebastianbergmann/phpunit-mock-objects/
- symfony/yaml: Symfony Yaml 组件: https://symfony.com.cn
运行测试
首先，使用 composer.phar install --dev 安装 PHPUnit，然后运行 ./vendor/bin/phpunit。