通过 
搜索
搜索gino-pane / composer-package-template
创建其他包的基本 composer 包模板。
v1.2.5
2017-12-12 10:00 UTC
Requires
- php: ^7.0
Requires (Dev)
- phpdocumentor/phpdocumentor: ^2.0
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^6.0
- squizlabs/php_codesniffer: ^3.0
README
如果您正在尝试创建新的 PHP Composer 包，无论是将其提交到 packagist.org，还是仅将其保存在您的 Github 账户中，这个文件模板包将一定有助于您使这个过程变得更加容易和快捷。
要求
- PHP >= 7.0;
- composer.
特性
- PSR-4 自动加载兼容的结构；
- PSR-2 兼容的代码风格；
- 使用 PHPUnit 6 进行单元测试；
- 全面的指南和教程；
- 易于在任何框架或纯 PHP 文件中使用；
- 包含用于提高代码质量的有用工具。
安装
composer create-project gino-pane/composer-package-template yourproject
这将为您创建一个基本的项目结构
- /build 默认用于存储代码覆盖率输出；
- /src 是您代码所在的位置，每个类都需要位于该文件夹内的单独文件中；
- /tests 在 src 文件夹中编写的每个类在“包含”到其他地方之前都需要进行测试。因此，我们基本上在那里有测试类来测试其他类；
- .gitignore 有一些我们不希望在 Git 中发布的文件，所以我们只需将它们添加到这个文件中，让 Git“忽略”它们；
- CHANGELOG.md 用于跟踪包更新；
- CONTRIBUTION.md 贡献者公约代码准则；
- LICENSE 规定了其他程序员可以使用此库的自由程度；
- README.md 是库的迷你文档，这是通常在 GitHub 和 Packagist 上发布时仓库的“主页”；
- composer.json 存储有关您的库的信息，例如包名称、作者和依赖项；
- phpunit.xml 是 PHPUnit 的配置文件，以便测试类可以测试您编写的类；
- .travis.yml 是 Travis CI 的基本配置，其中配置了用于代码气候的测试覆盖率报告。
有关更多信息，请参阅原始 文章。
有用工具
运行测试
php vendor/bin/phpunit
或
composer test
代码检查器工具
php vendor/bin/phpcs --standard=PSR2 src/
或
composer psr2check
代码自动修复器
php vendor/bin/phpcbf --standard=PSR2 src/
或
composer psr2autofix
构建文档
php vendor/bin/phpdoc -d "src" -t "docs"
或
composer docs
变更日志
为了跟踪，请参阅 CHANGELOG.md。
贡献
- 将其 Fork。
- 创建您的功能分支（git checkout -b my-new-feature）。
- 进行更改。
- 运行测试，如果有必要为您的代码添加新测试（phpunit）。
- 提交您的更改（git commit -am '添加一些功能'）。
- 将分支推送到远程（git push origin my-new-feature）。
- 创建新的拉取请求。
也请参阅 CONTRIBUTION.md。
许可证
请参阅 LICENSE。