Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elliotjreed/php-package-template
A template for PHP packages or libraries with PHPUnit, Psalm, PHPCS, and PHP-CS-Fixer; for unit testing, and code style checking and formatting.
https://github.com/elliotjreed/php-package-template
composer php
Last synced: about 22 hours ago
JSON representation
A template for PHP packages or libraries with PHPUnit, Psalm, PHPCS, and PHP-CS-Fixer; for unit testing, and code style checking and formatting.
- Host: GitHub
- URL: https://github.com/elliotjreed/php-package-template
- Owner: elliotjreed
- License: mit
- Created: 2019-11-28T17:08:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T08:07:05.000Z (27 days ago)
- Last Synced: 2024-10-11T23:15:36.673Z (27 days ago)
- Topics: composer, php
- Language: Shell
- Homepage: https://www.elliotjreed.com
- Size: 7.72 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
[](code-of-conduct.md)
**This is a template. To use it, clone this repository or select "Use this template" from [github.com/elliotjreed/php-package-template](https://github.com/elliotjreed/php-package-template) and run:**
```bash
bash ./setup.sh
```
**The following instructions and information are related to the project after the [setup](setup.sh) script has been run (they will throw errors if run before the [setup](setup.sh) has been run).**
# :package_name
## Getting Started
PHP 8.1 or above and Composer is expected to be installed.
### Installing Composer
For instructions on how to install Composer visit [getcomposer.org](https://getcomposer.org/download/).
### Installing
After cloning this repository, change into the newly created directory and run:
```bash
composer install
```
or if you have installed Composer locally in your current directory:
```bash
php composer.phar install
```
This will install all dependencies needed for the project.
Henceforth, the rest of this README will assume `composer` is installed globally (ie. if you are using `composer.phar` you will need to use `composer.phar` instead of `composer` in your terminal / command-line).
## Running the Tests
### Unit tests
Unit testing in this project is via [PHPUnit](https://phpunit.de/).
All unit tests can be run by executing:
```bash
composer phpunit
```
#### Debugging
To have PHPUnit stop and report on the first failing test encountered, run:
```bash
composer phpunit:debug
```
## Code formatting
A standard for code style can be important when working in teams, as it means that less time is spent by developers processing what they are reading (as everything will be consistent).
Code formatting is automated via [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
PHP-CS-Fixer will not format line lengths which do form part of the PSR-2 coding standards so these will product warnings when checked by [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer).
These can be run by executing:
```bash
composer phpcs
```
### Running everything
All of the tests can be run by executing:
```bash
composer test
```
### Outdated dependencies
Checking for outdated Composer dependencies can be performed by executing:
```bash
composer outdated
```
### Validating Composer configuration
Checking that the [composer.json](composer.json) is valid can be performed by executing:
```bash
composer validate --no-check-publish
```
### Running via GNU Make
If GNU [Make](https://www.gnu.org/software/make/) is installed, you can replace the above `composer` command prefixes with `make`.
All of the tests can be run by executing:
```bash
make test
```
### Running the tests on a Continuous Integration platform (eg. Github Actions)
Specific output formats better suited to CI platforms are included as Composer scripts.
To output unit test coverage in text and Clover XML format (which can be used for services such as [Coveralls](https://coveralls.io/)):
```
composer phpunit:ci
```
To output PHP-CS-Fixer (dry run) and PHPCS results in checkstyle format (which GitHub Actions will use to output a readable format):
```
composer phpcs:ci
```
#### Github Actions
Look at the example in [.github/workflows/main.yml](.github/workflows/main.yml).
## Built With
- [PHP](https://secure.php.net/)
- [Composer](https://getcomposer.org/)
- [PHPUnit](https://phpunit.de/)
- [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
- [GNU Make](https://www.gnu.org/software/make/)
## License
This project is licensed under the MIT License - see the [LICENCE.md](LICENCE.md) file for details.