通过
搜索
搜索tuefekci / helpers
我的PHP助手
dev-main
2022-09-10 02:44 UTC
Requires
- league/climate: ^3.7
Requires (Dev)
- fakerphp/faker: ^1.16
- phpdocumentor/phpdocumentor: ^2.0
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^6.0
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-09-10 06:54:53 UTC
README
要求
- 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。
贡献
- 分支它。
- 创建您的功能分支（git checkout -b my-new-feature）。
- 进行更改。
- 运行测试，如果需要为您的代码添加新测试（phpunit）。
- 提交更改（git commit -am '添加了一些功能'）。
- 将分支推送到远程（git push origin my-new-feature）。
- 创建新的pull request。
也可以参考CONTRIBUTION.md。
许可证
请参阅LICENSE。