wayofdev/laravel-package-tpl

🚀 Jump-start your Laravel package development with our pre-configured Composer template, designed for seamless integration. This template includes essential tools such as PHPUnit, PHPStan, GitHub Actions, and Docker to streamline your workflow and enhance productivity.

v2.7.2 2024-04-28 23:41 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^10.48 || ^11.0
• illuminate/support: ^10.48 || ^11.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• ergebnis/phpunit-slow-test-detector: ^2.14
• fakerphp/faker: ^1.23
• larastan/larastan: ^2.9
• orchestra/testbench: ^8.5 || ^9.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^10.5 || ^11.0
• psalm/plugin-laravel: ^2.11
• psalm/plugin-phpunit: ~0.19.0
• rector/rector: ^1.0
• roave/infection-static-analysis-plugin: ^1.35
• roave/security-advisories: dev-latest
• vimeo/psalm: ^5.23.1
• wayofdev/cs-fixer-config: ^1.2

MIT

• lotyp

README

Laravel Package Template

This is a template repository designed to kick-start the development of Laravel packages with essential tools and setups pre-configured.

If you like/use this package, please consider ⭐️ starring it. Thanks!

🚀 Features

This template repository includes several features to streamline the development of Laravel packages:

→ Testing

• Configured PHPUnit for unit testing.
• Integrated Pest PHP for elegant testing.
• Orchestra Testbench for Laravel package testing.
• PHPStan extensions for PHPUnit and Laravel.
• Infection for mutation testing to ensure quality.
• Mutation test reports are uploaded Stryker Mutator Dashboard.

→ Static Analysis

• PHPStan for static analysis, ensuring code quality and robustness.
• Larastan for Laravel-specific static analysis.
• PHPStan strict rules for enforcing strict type checks and standards.
• Psalm for finding errors in PHP applications through static analysis.
• PHP Rector for automated code upgrades and refactoring, maintaining modern code standards.

→ Coding Standards

• PHP CS Fixer with custom configuration for consistent code style.
• Composer Normalize to ensure a consistent composer.json format.

→ Continuous Integration

• Automated testing with code coverage report generation using PHPUnit and Xdebug, uploaded to Codecov.
• Automated linting of YAML files using ibiqlik/action-yamllint.
• Automated PHP code linting to ensure code quality and standards using wayofdev/php-cs-fixer-config.
• Markdown linting using DavidAnson/markdownlint-cli2.
• Checks for outdated or insecure dependencies using Composer.
• Mutation testing with Infection and Stryker Mutator to assess the quality of the test suite.
• Security checks to identify vulnerabilities in dependencies.
• Comprehensive static analysis with PHPStan and Psalm.
• Extensive testing across different setups to ensure compatibility and stability.

→ Development Environment

• Docker support for consistent development environments.
• Pre-commit hooks setup to ensure code quality before commits.

→ Issue Templates

• This package is equipped with a set of ready-to-use issue templates to streamline contributions and issue reporting.

  You can find these templates organized in the .github/ISSUE_TEMPLATE directory.

→ Miscellaneous

• Support for PHP 8.2+ and Laravel 10.x/11.x.
• Configured autoload and autoload-dev for optimal namespace management.

💿 Installation

To use this template, clone the repository and install the dependencies:

$ git clone https://github.com/wayofdev/laravel-package-tpl.git
$ cd laravel-package-tpl

$ make env install

### full list of available commands:
$ make help

🧪 Running Tests

→ PHPUnit tests

To run tests, run the following command:

make test

→ Mutation tests

To run mutation tests, using infection/infection:

make infect

→ Static Analysis

Code quality using PHPStan:

make lint-stan

and using Psalm:

make lint-psalm

→ Coding Standards Fixing

Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:

make lint-php

→ Lint Yaml files

Lint all yaml files in project:

make lint-yaml

→ Lint Markdown files

Lint all yaml files in project:

make lint-md

→ Lint GitHub Actions

Lint all yaml files in project:

make lint-actions

🔒 Security Policy

This project has a security policy.

🙌 Want to Contribute?

Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:

• 🤔 Suggest a feature
• 🐛 Report an issue
• 📖 Improve documentation
• 👨‍💻 Contribute to the code

You are more than welcome. Before contributing, kindly check our contribution guidelines.

🫡 Contributors

🌐 Social Links

• Twitter: Follow our organization @wayofdev and the author @wlotyp.
• Discord: Join our community on Discord.

⚖️ License