sh4ka/composer-package-template

为创建其他包的基本 composer 包模板。

v1.2.5 2017-12-12 10:00 UTC

This package is auto-updated.

Last update: 2024-09-12 21:36:27 UTC


README

Latest Stable Version License composer.lock Total Downloads

如果您正在尝试创建新的 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 的配置文件,以便测试类能够测试您编写的类;

有关更多信息,请参阅原始 文章

有用工具

运行测试

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 以保持跟踪。

贡献

  1. 叉它。
  2. 创建您的功能分支(git checkout -b my-new-feature)。
  3. 进行您的更改。
  4. 运行测试,如有必要为您的代码添加新测试(phpunit)。
  5. 提交您的更改(git commit -am '添加了一些功能')。
  6. 将更改推送到分支(git push origin my-new-feature)。
  7. 创建新的拉取请求。

另外,请参阅 CONTRIBUTION.md

许可证

请参阅 LICENSE