phetit/package-skeleton

Template for a PHP package

v2.0.0 2023-09-18 21:01 UTC

This package is auto-updated.

Last update: 2024-04-19 19:49:07 UTC


README

GitHub tag (with filter) Packagist GitHub

Phetit Package Skeleton

This repository provides a skeleton to start your next PHP package.

Requires PHP 8.1+

Usage

Installation

📦 Create a Composer project:

composer create-project phetit/package-skeleton --keep-vcs PackageName

If you want to get the last changes in the repository, add --stability=dev option.

After installation, follow the console instructions to set up your project.

Composer scripts

Once the project has been set up, you can use the following composer scripts.

🎨 Run code style analysis using PHP_CodeSniffer:

composer test:lint

🛠️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PHPUnit:

composer test:unit

🚀 Run the entire test suit

composer test

License

This project is licensed under the MIT license.

References