diff --git a/CHANGELOG.md b/CHANGELOG.md index 15dd6ee..95717c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] + - Adds first version diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2ceb41..167f93e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,28 +20,35 @@ Please review these guidelines before submitting any pull requests. ## Setup Clone your fork, then install the dev dependencies: + ```bash composer install ``` + ## Lint Lint your code: + ```bash composer lint ``` + ## Tests Run all tests: + ```bash composer test ``` Check types: + ```bash composer test:types ``` Unit tests: + ```bash composer test:unit ``` diff --git a/README.md b/README.md index c0d2169..2a59f45 100644 --- a/README.md +++ b/README.md @@ -20,26 +20,31 @@ composer create-project nunomaduro/skeleton-php --prefer-source PackageName ``` ๐Ÿงน Keep a modern codebase with **Pint**: + ```bash composer lint ``` โœ… Run refactors using **Rector** + ```bash composer refacto ``` โš—๏ธ Run static analysis using **PHPStan**: + ```bash composer test:types ``` โœ… Run unit tests using **PEST** + ```bash composer test:unit ``` ๐Ÿš€ Run the entire test suite: + ```bash composer test ``` diff --git a/composer.json b/composer.json index 5e036dd..f4d11da 100644 --- a/composer.json +++ b/composer.json @@ -16,7 +16,7 @@ "laravel/pint": "^1.13.7", "pestphp/pest": "^2.28.1", "phpstan/phpstan": "^1.10.50", - "rector/rector": "^0.18.13", + "rector/rector": "^0.19.5", "symfony/var-dumper": "^6.4.0|^7.0.0" }, "autoload": { diff --git a/tests/ArchTest.php b/tests/ArchTest.php new file mode 100644 index 0000000..1e6444e --- /dev/null +++ b/tests/ArchTest.php @@ -0,0 +1,9 @@ +expect(['dd', 'ddd', 'dump', 'var_dump', 'print_r', 'ray']) + ->each->not->toBeUsed(); + +arch('it uses Strict Types') + ->expect('NunoMaduro\SkeletonPhp') + ->toUseStrictTypes();