README

A starter kit for creating PHP libraries with PHPUnit testing and modern development tools.

Requirements

PHP 8.3 or higher (the CI matrix currently covers PHP 8.3, 8.4, and 8.5)
Composer 2.0 or higher

Features

✅ Pest Testing: Pre-configured Pest 4.x support with example tests
✅ Code Linting: Laravel Pint for automatic code style enforcement
✅ CI/CD Ready: GitHub Actions workflows for testing and code style
✅ Auto CHANGELOG: Automatic changelog updates on GitHub releases
✅ Modern PHP: PHP 8.3+ with strict types and PSR-4 autoloading
✅ EditorConfig: Consistent coding styles across editors
✅ Complete Documentation: README, CHANGELOG, and MIT License included

Installation

As a Template (Recommended)

Create a new project from this starter kit:

composer create-project cable8mm/phpunit-start-kit <package_name>
cd <package_name>

As a Dependency (example library only)

This package is primarily a project template. Its StartKit class is a placeholder example, so installing it as a dependency is only useful if you specifically want to use that example class.

composer require cable8mm/phpunit-start-kit

Quick Start

Update package information in composer.json:
- Change name to your package name (e.g., your-vendor/your-package)
- Update authors information
- Add your package dependencies
Update the package namespace in composer.json and your PHP files. Keep the PSR-4 namespace and src/ directory mapping in sync, then run:
```
composer dump-autoload
```
Customize the source code:
- Modify src/StartKit.php with your implementation
- Update namespace to match your package
Write tests:
- Update tests/StartKitTest.php with your test cases
- Add more test files as needed
Update documentation:
- Edit README.md with your project description
- Update CHANGELOG.md with your release notes
- Remove or replace the starter-kit badges and repository links

Available Commands

# Run tests
composer test

# Check code style
composer inspect

# Fix code style automatically
composer lint

# Generate API documentation (requires doctum.phar)
composer apidoc

Project Structure

.
├── src/
│   └── StartKit.php          # Main source code
├── tests/
│   └── StartKitTest.php      # Test files
├── .github/
│   └── workflows/
│       ├── run-tests.yml     # Automated testing
│       ├── code-style.yml    # Code linting
│       └── update-changelog.yml  # Auto CHANGELOG updates
├── composer.json             # Package configuration
├── phpunit.xml               # PHPUnit configuration
├── .editorconfig             # Editor configuration
├── CHANGELOG.md              # Change log
└── README.md                 # Project documentation

GitHub Actions Workflows

This starter kit includes three pre-configured GitHub Actions:

run-tests.yml: Runs tests on PHP 8.3, 8.4, and 8.5
code-style.yml: Checks code style with Laravel Pint and fails when files need formatting. Run composer lint locally to apply fixes.
update-changelog.yml: Updates CHANGELOG.md when a GitHub release is published, then commits the generated entry to the release target branch

Testing

The kit includes a small Pest example in tests/StartKitTest.php. Replace it with tests for your package. The empty Feature and Unit placeholder tests are intentionally omitted; add those directories when your project needs them.

test('it can be instantiated', function () {
    $startKit = new StartKit;

    expect($startKit)->toBeInstanceOf(StartKit::class);
});

Code Style

This project uses Laravel Pint for code styling. Run composer inspect to check formatting and composer lint to apply fixes.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

The PHPUnit Start Kit is open-sourced software licensed under the MIT license.

cable8mm / phpunit-start-kit

Package info

Security

Statistics