From a3db5a530e587cbf1e03584ad7d19f050cf01a04 Mon Sep 17 00:00:00 2001 From: Niels Vanpachtenbeke <10651054+Nielsvanpach@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:14:30 +0100 Subject: [PATCH] Initial commit --- .editorconfig | 15 + .gitattributes | 15 + .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug.yml | 58 ++++ .github/ISSUE_TEMPLATE/config.yml | 11 + .github/dependabot.yml | 19 ++ .github/workflows/dependabot-auto-merge.yml | 33 ++ .../fix-php-code-style-issues-cs-fixer.yml | 30 ++ .../fix-php-code-style-issues-pint.yml | 28 ++ .github/workflows/run-tests-pest.yml | 48 +++ .github/workflows/run-tests-phpunit.yml | 48 +++ .github/workflows/update-changelog.yml | 32 ++ .gitignore | 13 + .php-cs-fixer.dist.php | 39 +++ CHANGELOG.md | 4 + LICENSE.md | 21 ++ README.md | 66 ++++ composer.json | 48 +++ configure.php | 288 ++++++++++++++++++ phpunit.xml.dist | 38 +++ src/SkeletonClass.php | 7 + tests/ArchTest.php | 5 + tests/ExampleTestPest.php | 5 + tests/ExampleTestPhpunit.php | 9 + tests/Pest.php | 1 + 25 files changed, 882 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/dependabot-auto-merge.yml create mode 100644 .github/workflows/fix-php-code-style-issues-cs-fixer.yml create mode 100644 .github/workflows/fix-php-code-style-issues-pint.yml create mode 100644 .github/workflows/run-tests-pest.yml create mode 100644 .github/workflows/run-tests-phpunit.yml create mode 100644 .github/workflows/update-changelog.yml create mode 100644 .gitignore create mode 100644 .php-cs-fixer.dist.php create mode 100644 CHANGELOG.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 configure.php create mode 100644 phpunit.xml.dist create mode 100755 src/SkeletonClass.php create mode 100644 tests/ArchTest.php create mode 100644 tests/ExampleTestPest.php create mode 100644 tests/ExampleTestPhpunit.php create mode 100644 tests/Pest.php diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..a7c44ddb1 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.{yml,yaml}] +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..aa8ebc7f8 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,15 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.github export-ignore +/.gitattributes export-ignore +/.gitignore export-ignore +/phpunit.xml.dist export-ignore +/psalm.xml.dist export-ignore +/tests export-ignore +/.editorconfig export-ignore +/.php-cs-fixer.dist.php export-ignore +/art export-ignore +/docs export-ignore +/UPGRADING.md export-ignore diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..c68765b06 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: :vendor_name diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..a9933e195 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,58 @@ +name: Bug Report +description: Report an Issue or Bug with the Package +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + We're sorry to hear you have a problem. Can you help us solve it by providing the following details. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What did you expect to happen? + placeholder: I cannot currently do X thing because when I do, it breaks X thing. + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: How to reproduce the bug + description: How did this occur, please add any config values used and provide a set of reliable steps if possible. + placeholder: When I do X I see Y. + validations: + required: true + - type: input + id: package-version + attributes: + label: Package Version + description: What version of our Package are you running? Please be as specific as possible + placeholder: 2.0.0 + validations: + required: true + - type: input + id: php-version + attributes: + label: PHP Version + description: What version of PHP are you running? Please be as specific as possible + placeholder: 8.2.0 + validations: + required: true + - type: dropdown + id: operating-systems + attributes: + label: Which operating systems does with happen with? + description: You may select more than one. + multiple: true + options: + - macOS + - Windows + - Linux + - type: textarea + id: notes + attributes: + label: Notes + description: Use this field to provide any other notes that you feel might be relevant to the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..96701be9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a + about: Ask the community for help + - name: Request a feature + url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas + about: Share ideas for new features + - name: Report a security issue + url: https://github.com/:vendor_name/:package_name/security/policy + about: Learn how to notify us for sensitive bugs diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..39b158074 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,19 @@ +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + labels: + - "dependencies" + + - package-ecosystem: "composer" + directory: "/" + schedule: + interval: "weekly" + labels: + - "dependencies" diff --git a/.github/workflows/dependabot-auto-merge.yml b/.github/workflows/dependabot-auto-merge.yml new file mode 100644 index 000000000..70d8e7bda --- /dev/null +++ b/.github/workflows/dependabot-auto-merge.yml @@ -0,0 +1,33 @@ +name: dependabot-auto-merge +on: pull_request_target + +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + runs-on: ubuntu-latest + timeout-minutes: 5 + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1.6.0 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + + - name: Auto-merge Dependabot PRs for semver-minor updates + if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + + - name: Auto-merge Dependabot PRs for semver-patch updates + if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}} + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.github/workflows/fix-php-code-style-issues-cs-fixer.yml b/.github/workflows/fix-php-code-style-issues-cs-fixer.yml new file mode 100644 index 000000000..8e61c6471 --- /dev/null +++ b/.github/workflows/fix-php-code-style-issues-cs-fixer.yml @@ -0,0 +1,30 @@ +name: Check & fix styling + +on: + push: + paths: + - '**.php' + +permissions: + contents: write + +jobs: + php-cs-fixer: + runs-on: ubuntu-latest + timeout-minutes: 5 + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: ${{ github.head_ref }} + + - name: Run PHP CS Fixer + uses: docker://oskarstark/php-cs-fixer-ga + with: + args: --config=.php-cs-fixer.dist.php --allow-risky=yes + + - name: Commit changes + uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: Fix styling diff --git a/.github/workflows/fix-php-code-style-issues-pint.yml b/.github/workflows/fix-php-code-style-issues-pint.yml new file mode 100644 index 000000000..cd4239c24 --- /dev/null +++ b/.github/workflows/fix-php-code-style-issues-pint.yml @@ -0,0 +1,28 @@ +name: Fix PHP code style issues + +on: + push: + paths: + - '**.php' + +permissions: + contents: write + +jobs: + php-code-styling: + runs-on: ubuntu-latest + timeout-minutes: 5 + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: ${{ github.head_ref }} + + - name: Fix PHP code style issues + uses: aglipanci/laravel-pint-action@2.3.1 + + - name: Commit changes + uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: Fix styling diff --git a/.github/workflows/run-tests-pest.yml b/.github/workflows/run-tests-pest.yml new file mode 100644 index 000000000..14315473c --- /dev/null +++ b/.github/workflows/run-tests-pest.yml @@ -0,0 +1,48 @@ +name: Tests + +on: + push: + paths: + - '**.php' + - '.github/workflows/run-tests-pest.yml' + - 'phpunit.xml.dist' + - 'composer.json' + - 'composer.lock' + +jobs: + test: + runs-on: ${{ matrix.os }} + timeout-minutes: 5 + strategy: + fail-fast: true + matrix: + os: [ubuntu-latest, windows-latest] + php: [8.3, 8.2, 8.1] + stability: [prefer-lowest, prefer-stable] + + name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo + coverage: none + + - name: Setup problem matchers + run: | + echo "::add-matcher::${{ runner.tool_cache }}/php.json" + echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Install dependencies + run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction + + - name: List Installed Dependencies + run: composer show -D + + - name: Execute tests + run: vendor/bin/pest --ci diff --git a/.github/workflows/run-tests-phpunit.yml b/.github/workflows/run-tests-phpunit.yml new file mode 100644 index 000000000..cf9f034ed --- /dev/null +++ b/.github/workflows/run-tests-phpunit.yml @@ -0,0 +1,48 @@ +name: Tests + +on: + push: + paths: + - '**.php' + - '.github/workflows/run-tests-phpunit.yml' + - 'phpunit.xml.dist' + - 'composer.json' + - 'composer.lock' + +jobs: + test: + runs-on: ${{ matrix.os }} + timeout-minutes: 5 + strategy: + fail-fast: true + matrix: + os: [ubuntu-latest, windows-latest] + php: [8.3, 8.2, 8.1] + stability: [prefer-lowest, prefer-stable] + + name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo + coverage: none + + - name: Setup problem matchers + run: | + echo "::add-matcher::${{ runner.tool_cache }}/php.json" + echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Install dependencies + run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction + + - name: List Installed Dependencies + run: composer show -D + + - name: Execute tests + run: vendor/bin/phpunit diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml new file mode 100644 index 000000000..39de30d6e --- /dev/null +++ b/.github/workflows/update-changelog.yml @@ -0,0 +1,32 @@ +name: "Update Changelog" + +on: + release: + types: [released] + +permissions: + contents: write + +jobs: + update: + runs-on: ubuntu-latest + timeout-minutes: 5 + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: main + + - name: Update Changelog + uses: stefanzweifel/changelog-updater-action@v1 + with: + latest-version: ${{ github.event.release.name }} + release-notes: ${{ github.event.release.body }} + + - name: Commit updated CHANGELOG + uses: stefanzweifel/git-auto-commit-action@v5 + with: + branch: main + commit_message: Update CHANGELOG + file_pattern: CHANGELOG.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..ff8bfd7e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +.idea +.php_cs +.php_cs.cache +.phpunit.cache +build +composer.lock +coverage +docs +phpunit.xml +psalm.xml +vendor +.php-cs-fixer.cache + diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 000000000..7ee4ffa7c --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,39 @@ +in([ + __DIR__ . '/src', + __DIR__ . '/tests', + ]) + ->name('*.php') + ->ignoreDotFiles(true) + ->ignoreVCS(true); + +return (new PhpCsFixer\Config()) + ->setRules([ + '@PSR12' => true, + 'array_syntax' => ['syntax' => 'short'], + 'ordered_imports' => ['sort_algorithm' => 'alpha'], + 'no_unused_imports' => true, + 'not_operator_with_successor_space' => true, + 'trailing_comma_in_multiline' => true, + 'phpdoc_scalar' => true, + 'unary_operator_spaces' => true, + 'binary_operator_spaces' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_var_without_name' => true, + 'class_attributes_separation' => [ + 'elements' => [ + 'method' => 'one', + ], + ], + 'method_argument_space' => [ + 'on_multiline' => 'ensure_fully_multiline', + 'keep_multiple_spaces_after_comma' => true, + ], + 'single_trait_insert_per_statement' => true, + ]) + ->setFinder($finder); diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..8d01146d7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Changelog + +All notable changes to `:package_name` will be documented in this file. + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..58c9ad42f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) :vendor_name + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 000000000..da3e83182 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# :package_description + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) +[![Tests](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions/workflows/run-tests.yml) +[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) + +--- +This package can be used as to scaffold a framework agnostic package. Follow these steps to get started: + +1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton +2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files +3. Have fun creating your package. +4. If you need help creating a package, consider picking up our Laravel Package Training video course. +--- + +This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example. + +## Support us + +[](https://spatie.be/github-ad-click/:package_name) + +We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). + +We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). + +## Installation + +You can install the package via composer: + +```bash +composer require :vendor_slug/:package_slug +``` + +## Usage + +```php +$skeleton = new VendorName\Skeleton(); +echo $skeleton->echoPhrase('Hello, VendorName!'); +``` + +## Testing + +```bash +composer test +``` + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. + +## Security Vulnerabilities + +Please review [our security policy](../../security/policy) on how to report security vulnerabilities. + +## Credits + +- [:author_name](https://github.com/:author_username) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/composer.json b/composer.json new file mode 100644 index 000000000..98297a179 --- /dev/null +++ b/composer.json @@ -0,0 +1,48 @@ +{ + "name": ":vendor_slug/:package_slug", + "description": ":package_description", + "keywords": [ + ":vendor_name", + ":package_slug" + ], + "homepage": "https://github.com/:vendor_slug/:package_slug", + "license": "MIT", + "authors": [ + { + "name": ":author_name", + "email": "author@domain.com", + "role": "Developer" + } + ], + "require": { + "php": "^8.1" + }, + "require-dev": { + :require_dev_testing, + :require_dev_codestyle, + "spatie/ray": "^1.28" + }, + "autoload": { + "psr-4": { + "VendorName\\Skeleton\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "VendorName\\Skeleton\\Tests\\": "tests" + } + }, + "scripts": { + :scripts_testing, + :scripts_codestyle + }, + "config": { + "sort-packages": true, + "allow-plugins": { + :plugins_testing, + "phpstan/extension-installer": true + } + }, + "minimum-stability": "dev", + "prefer-stable": true +} diff --git a/configure.php b/configure.php new file mode 100644 index 000000000..dcff87ec4 --- /dev/null +++ b/configure.php @@ -0,0 +1,288 @@ +#!/usr/bin/env php + $option === $default ? strtoupper($option) : $option, + $options, + )); + + $answer = ask("{$question} ({$suggestions})"); + + $validOptions = implode(', ', $options); + + while (! in_array($answer, $options)) { + if ($default && $answer === '') { + $answer = $default; + + break; + } + + writeln(PHP_EOL."Please pick one of the following options: {$validOptions}"); + + $answer = ask("{$question} ({$suggestions})"); + } + + if (! $answer) { + $answer = $default; + } + + return $answer; +} + +function confirm(string $question, bool $default = false): bool +{ + $answer = ask($question.' ('.($default ? 'Y/n' : 'y/N').')'); + + if (! $answer) { + return $default; + } + + return strtolower($answer) === 'y'; +} + +function writeln(string $line): void +{ + echo $line.PHP_EOL; +} + +function run(string $command): string +{ + return trim(shell_exec($command)); +} + +function str_after(string $subject, string $search): string +{ + $pos = strrpos($subject, $search); + + if ($pos === false) { + return $subject; + } + + return substr($subject, $pos + strlen($search)); +} + +function slugify(string $subject): string +{ + return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $subject), '-')); +} + +function title_case(string $subject): string +{ + return str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $subject))); +} + +function replace_in_file(string $file, array $replacements): void +{ + $contents = file_get_contents($file); + + file_put_contents( + $file, + str_replace( + array_keys($replacements), + array_values($replacements), + $contents + ) + ); +} + +function removeReadmeParagraphs(string $file): void +{ + $contents = file_get_contents($file); + + file_put_contents( + $file, + preg_replace('/.*/s', '', $contents) ?: $contents + ); +} + +function determineSeparator(string $path): string +{ + return str_replace('/', DIRECTORY_SEPARATOR, $path); +} + +function replaceForWindows(): array +{ + return preg_split('/\\r\\n|\\r|\\n/', run('dir /S /B * | findstr /v /i .git\ | findstr /v /i vendor | findstr /v /i '.basename(__FILE__).' | findstr /r /i /M /F:/ ":author :vendor :package VendorName skeleton vendor_name vendor_slug author@domain.com"')); +} + +function replaceForAllOtherOSes(): array +{ + return explode(PHP_EOL, run('grep -E -r -l -i ":author|:vendor|:package|VendorName|skeleton|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v '.basename(__FILE__))); +} + +function setupTestingLibrary(string $testingLibrary): void +{ + if ($testingLibrary === 'pest') { + unlink(__DIR__.'/tests/ExampleTestPhpunit.php'); + unlink(__DIR__.'/.github/workflows/run-tests-phpunit.yml'); + + rename( + from: __DIR__.'/tests/ExampleTestPest.php', + to: __DIR__.'/tests/ExampleTest.php' + ); + + rename( + from: __DIR__.'/.github/workflows/run-tests-pest.yml', + to: __DIR__.'/.github/workflows/run-tests.yml' + ); + + replace_in_file(__DIR__.'/composer.json', [ + ':require_dev_testing' => '"pestphp/pest": "^2.15"', + ':scripts_testing' => '"test": "vendor/bin/pest", + "test-coverage": "vendor/bin/pest --coverage"', + ':plugins_testing' => '"pestphp/pest-plugin": true', + ]); + } elseif ($testingLibrary === 'phpunit') { + unlink(__DIR__.'/tests/ExampleTestPest.php'); + unlink(__DIR__.'/tests/ArchTest.php'); + unlink(__DIR__.'/tests/Pest.php'); + unlink(__DIR__.'/.github/workflows/run-tests-pest.yml'); + + rename( + from: __DIR__.'/tests/ExampleTestPhpunit.php', + to: __DIR__.'/tests/ExampleTest.php' + ); + + rename( + from: __DIR__.'/.github/workflows/run-tests-phpunit.yml', + to: __DIR__.'/.github/workflows/run-tests.yml' + ); + + replace_in_file(__DIR__.'/composer.json', [ + ':require_dev_testing' => '"phpunit/phpunit": "^10.3.2"', + ':scripts_testing' => '"test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage"', + ':plugins_testing,' => '', // We need to remove the comma here as well, since there's nothing to add + ]); + } +} + +function setupCodeStyleLibrary(string $codeStyleLibrary): void +{ + if ($codeStyleLibrary === 'pint') { + unlink(__DIR__.'/.github/workflows/fix-php-code-style-issues-cs-fixer.yml'); + + rename( + from: __DIR__.'/.github/workflows/fix-php-code-style-issues-pint.yml', + to: __DIR__.'/.github/workflows/fix-php-code-style-issues.yml' + ); + + replace_in_file(__DIR__.'/composer.json', [ + ':require_dev_codestyle' => '"laravel/pint": "^1.0"', + ':scripts_codestyle' => '"format": "vendor/bin/pint"', + ':plugins_testing' => '', + ]); + + unlink(__DIR__.'/.php-cs-fixer.dist.php'); + } elseif ($codeStyleLibrary === 'cs fixer') { + unlink(__DIR__.'/.github/workflows/fix-php-code-style-issues-pint.yml'); + + rename( + from: __DIR__.'/.github/workflows/fix-php-code-style-issues-cs-fixer.yml', + to: __DIR__.'/.github/workflows/fix-php-code-style-issues.yml' + ); + + replace_in_file(__DIR__.'/composer.json', [ + ':require_dev_codestyle' => '"friendsofphp/php-cs-fixer": "^3.21.1"', + ':scripts_codestyle' => '"format": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes"', + ':plugins_testing' => '', + ]); + } +} + +$gitName = run('git config user.name'); +$authorName = ask('Author name', $gitName); + +$gitEmail = run('git config user.email'); +$authorEmail = ask('Author email', $gitEmail); + +$usernameGuess = explode(':', run('git config remote.origin.url'))[1]; +$usernameGuess = dirname($usernameGuess); +$usernameGuess = basename($usernameGuess); +$authorUsername = ask('Author username', $usernameGuess); + +$vendorName = ask('Vendor name', $authorUsername); +$vendorSlug = slugify($vendorName); +$vendorNamespace = ucwords($vendorName); +$vendorNamespace = ask('Vendor namespace', $vendorNamespace); + +$currentDirectory = getcwd(); +$folderName = basename($currentDirectory); + +$packageName = ask('Package name', $folderName); +$packageSlug = slugify($packageName); + +$className = title_case($packageName); +$className = ask('Class name', $className); +$description = ask('Package description', "This is my package {$packageSlug}"); + +$testingLibrary = askWithOptions( + 'Which testing library do you want to use?', + ['pest', 'phpunit'], + 'pest', +); + +$codeStyleLibrary = askWithOptions( + 'Which code style library do you want to use?', + ['pint', 'cs fixer'], + 'pint', +); + +writeln('------'); +writeln("Author : {$authorName} ({$authorUsername}, {$authorEmail})"); +writeln("Vendor : {$vendorName} ({$vendorSlug})"); +writeln("Package : {$packageSlug} <{$description}>"); +writeln("Namespace : {$vendorNamespace}\\{$className}"); +writeln("Class name : {$className}"); +writeln("Testing library : {$testingLibrary}"); +writeln("Code style library : {$codeStyleLibrary}"); +writeln('------'); + +writeln('This script will replace the above values in all relevant files in the project directory.'); + +if (! confirm('Modify files?', true)) { + exit(1); +} + +$files = (str_starts_with(strtoupper(PHP_OS), 'WIN') ? replaceForWindows() : replaceForAllOtherOSes()); + +foreach ($files as $file) { + replace_in_file($file, [ + ':author_name' => $authorName, + ':author_username' => $authorUsername, + 'author@domain.com' => $authorEmail, + ':vendor_name' => $vendorName, + ':vendor_slug' => $vendorSlug, + 'VendorName' => $vendorNamespace, + ':package_name' => $packageName, + ':package_slug' => $packageSlug, + 'Skeleton' => $className, + ':package_description' => $description, + ]); + + match (true) { + str_contains($file, determineSeparator('src/SkeletonClass.php')) => rename($file, determineSeparator('./src/'.$className.'Class.php')), + str_contains($file, 'README.md') => removeReadmeParagraphs($file), + default => [], + }; +} + +setupTestingLibrary($testingLibrary); +setupCodeStyleLibrary($codeStyleLibrary); + +confirm('Execute `composer install` and run tests?') && run('composer install && composer test'); + +confirm('Let this script delete itself?', true) && unlink(__FILE__); diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 000000000..4c6104224 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,38 @@ + + + + + tests + + + + + + + + + + + + + + + ./src + + + diff --git a/src/SkeletonClass.php b/src/SkeletonClass.php new file mode 100755 index 000000000..dcf362cc7 --- /dev/null +++ b/src/SkeletonClass.php @@ -0,0 +1,7 @@ +expect(['dd', 'dump', 'ray']) + ->not->toBeUsed(); diff --git a/tests/ExampleTestPest.php b/tests/ExampleTestPest.php new file mode 100644 index 000000000..5d3632189 --- /dev/null +++ b/tests/ExampleTestPest.php @@ -0,0 +1,5 @@ +toBeTrue(); +}); diff --git a/tests/ExampleTestPhpunit.php b/tests/ExampleTestPhpunit.php new file mode 100644 index 000000000..fa301e084 --- /dev/null +++ b/tests/ExampleTestPhpunit.php @@ -0,0 +1,9 @@ +