Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onramplab/composer-package-template
https://github.com/onramplab/composer-package-template
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/onramplab/composer-package-template
- Owner: OnrampLab
- License: mit
- Created: 2023-01-07T09:22:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T11:09:33.000Z (over 1 year ago)
- Last Synced: 2024-04-14T05:22:32.124Z (7 months ago)
- Language: PHP
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# composer-package-template
[](LICENSE.md)
[](https://circleci.com/gh/OnrampLab/composer-package-template)
[](https://packagist.org/packages/onramplab/composer-package-template)
If you are trying to create a new PHP Composer package, whether it is going to be submitted to packagist.org or just to exist in your Github account, this template package of files will surely help you make the process a lot easier and faster.
## Requirements
- PHP >= 7.4;
- composer.
## Features
- PSR-4 autoloading compliant structure;
- PSR-2 compliant code style;
- Unit-Testing with PHPUnit 6;
- Comprehensive guide and tutorial;
- Easy to use with any framework or even a plain php file;
- Useful tools for better code included.
## Installation
```bash
composer create-project onramplab/composer-package-template yourproject
```
This will create a basic project structure for you:
* **/build** is used to store code coverage output by default;
* **/src** is where your codes will live in, each class will need to reside in its own file inside this folder;
* **/tests** each class that you write in src folder needs to be tested before it was even "included" into somewhere else. So basically we have tests classes there to test other classes;
* **.gitignore** there are certain files that we don't want to publish in Git, so we just add them to this fle for them to "get ignored by git";
* **CHANGELOG.md** to keep track of package updates;
* **CONTRIBUTION.md** Contributor Covenant Code of Conduct;
* **LICENSE** terms of how much freedom other programmers is allowed to use this library;
* **README.md** it is a mini documentation of the library, this is usually the "home page" of your repo if you published it on GitHub and Packagist;
* **composer.json** is where the information about your library is stored, like package name, author and dependencies;
* **phpunit.xml** It is a configuration file of PHPUnit, so that tests classes will be able to test the classes you've written;
* **.travis.yml** basic configuration for Travis CI with configured test coverage reporting for code climate.
Please refer to original [article](http://www.darwinbiler.com/creating-composer-package-library/) for more information.
## Useful Tools
## Running Tests:
php vendor/bin/phpunit
or
composer test
## Code Sniffer Tool:
php vendor/bin/phpcs --standard=PSR2 src/
or
composer psr2check
## Code Auto-fixer:
composer psr2autofix
composer insights:fix
rector:fix
## Building Docs:
php vendor/bin/phpdoc -d "src" -t "docs"
or
composer docs
## Changelog
To keep track, please refer to [CHANGELOG.md](https://github.com/Onramplab/composer-package-template/blob/master/CHANGELOG.md).
## Contributing
1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Make your changes.
4. Run the tests, adding new ones for your own code if necessary (phpunit).
5. Commit your changes (git commit -am 'Added some feature').
6. Push to the branch (git push origin my-new-feature).
7. Create new pull request.
Also please refer to [CONTRIBUTION.md](https://github.com/Onramplab/composer-package-template/blob/master/CONTRIBUTION.md).
## License
Please refer to [LICENSE](https://github.com/Onramplab/composer-package-template/blob/master/LICENSE).