package-skeleton

简体中文 | ENGLISH

Note

A PHP package template repository. - 一个 PHP 软件包模板存储库。

Features

• Integrated brainmaestro/composer-git-hooks - Git hooks
• Integrated brianium/paratest - Parallel testing for PHPUnit
• Integrated codedungeon/phpunit-result-printer - PHPUnit Pretty Result Printer
• Integrated dg/bypass-finals - Unit test assistant package
• Integrated dms/phpunit-arraysubset-asserts - Unit test assistant package
• Integrated sebastianbergmann/phpunit - Unit test
• Integrated bovigo/vfsStream - Unit test assistant package
• Integrated mockery/mockery - Mock
• Integrated Nyholm/NSA - Unit test assistant package
• Integrated phpbench/phpbench - Benchmarks
• Integrated FriendsOfPHP/PHP-CS-Fixer - Coding standard check
• Integrated johnkary/phpunit-speedtrap - Reports on slow-running tests in your PHPUnit test suite
• Integrated overtrue/phplint - Grammar check
• Integrated symplify/monorepo-builder - Monorepo
• Integrated vimeo/psalm - Static check
• Integrated lint-md/lint-md - Markdown grammar check
• Integrated povils/phpmnd - PHP Magic Number Detector
• Integrated ...
• With IDE helper file
• With github/pages docsify documentation site
• With common badge icons
• With Chinese and English README.md file

Requirement

• PHP >= 7.2

Installation

composer require guanguans/package-skeleton --prefer-dist -vvv

Usage

1. execute $ git clone https://github.com/guanguans/package-skeleton.git
2. replace guanguans/package-skeleton -> vendorName/package-name
3. replace Guanguans\\PackageSkeleton -> VendorName\\PackageName
4. replace Guanguans\PackageSkeleton -> VendorName\PackageName
5. replace GuanguansPackageSkeletonUpdateHelper -> VendorNamePackageNameUpdateHelper
6. replace package-skeleton -> your repository name
7. replace ityaozm@gmail.com -> your email
8. execute $ composer install && composer dumpautoload
9. execute $ rm .git/ && git init && git add . && git commit -m 'Build the basic skeleton'

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• guanguans
• All Contributors

License

The MIT License (MIT). Please see License File for more information.