From 0cf1c4f0cb50495b5d1820c42b96b5a2c132eca6 Mon Sep 17 00:00:00 2001 From: kimchanhyung98 Date: Fri, 12 Jan 2024 23:09:27 +0900 Subject: [PATCH] Create v0.1.0 (#1) Co-authored-by: kimchanhyung98 --- .editorconfig | 15 + .gitattributes | 20 + .github/ISSUE_TEMPLATE/bug.yml | 66 ++++ .github/ISSUE_TEMPLATE/config.yml | 11 + .github/dependabot.yml | 19 + .github/workflows/dependabot-auto-merge.yml | 33 ++ .../workflows/fix-php-code-style-issues.yml | 28 ++ .github/workflows/phpstan.yml | 28 ++ .github/workflows/run-tests.yml | 55 +++ .github/workflows/update-changelog.yml | 32 ++ .gitignore | 48 ++- CHANGELOG.md | 3 + LICENSE.md | 21 + README.md | 59 ++- composer.json | 81 ++++ config/maker.php | 13 + configure.php | 366 ++++++++++++++++++ phpstan-baseline.neon | 0 phpstan.neon.dist | 13 + phpunit.xml.dist | 38 ++ src/Commands/ActionCommand.php | 27 ++ src/Commands/MakeCommand.php | 27 ++ src/Commands/ServiceCommand.php | 27 ++ src/MakerServiceProvider.php | 25 ++ src/Stubs/action.stub | 18 + src/Stubs/service.stub | 11 + tests/MakeTest.php | 28 ++ 27 files changed, 1089 insertions(+), 23 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes 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.yml create mode 100644 .github/workflows/phpstan.yml create mode 100644 .github/workflows/run-tests.yml create mode 100644 .github/workflows/update-changelog.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE.md create mode 100644 composer.json create mode 100644 config/maker.php create mode 100644 configure.php create mode 100644 phpstan-baseline.neon create mode 100644 phpstan.neon.dist create mode 100644 phpunit.xml.dist create mode 100644 src/Commands/ActionCommand.php create mode 100644 src/Commands/MakeCommand.php create mode 100644 src/Commands/ServiceCommand.php create mode 100644 src/MakerServiceProvider.php create mode 100644 src/Stubs/action.stub create mode 100644 src/Stubs/service.stub create mode 100644 tests/MakeTest.php diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..dd9a2b5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +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 0000000..c09f81e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,20 @@ +# 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 +/art export-ignore +/docs export-ignore +/tests export-ignore +/workbench export-ignore +/.editorconfig export-ignore +/.php_cs.dist.php export-ignore +/psalm.xml export-ignore +/psalm.xml.dist export-ignore +/testbench.yaml export-ignore +/UPGRADING.md export-ignore +/phpstan.neon.dist export-ignore +/phpstan-baseline.neon export-ignore diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..8fa85ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,66 @@ +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: input + id: laravel-version + attributes: + label: Laravel Version + description: What version of Laravel are you running? Please be as specific as possible + placeholder: 9.0.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 0000000..7ce2ac1 --- /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/kimchanhyung98/laravel-maker/discussions/new?category=q-a + about: Ask the community for help + - name: Request a feature + url: https://github.com/kimchanhyung98/laravel-maker/discussions/new?category=ideas + about: Share ideas for new features + - name: Report a security issue + url: https://github.com/kimchanhyung98/laravel-maker/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 0000000..39b1580 --- /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 0000000..70d8e7b --- /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.yml b/.github/workflows/fix-php-code-style-issues.yml new file mode 100644 index 0000000..cd4239c --- /dev/null +++ b/.github/workflows/fix-php-code-style-issues.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/phpstan.yml b/.github/workflows/phpstan.yml new file mode 100644 index 0000000..af21e45 --- /dev/null +++ b/.github/workflows/phpstan.yml @@ -0,0 +1,28 @@ +name: PHPStan + +on: + push: + paths: + - '**.php' + - 'phpstan.neon.dist' + - '.github/workflows/phpstan.yml' + +jobs: + phpstan: + name: phpstan + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '8.1' + coverage: none + + - name: Install composer dependencies + uses: ramsey/composer-install@v2 + + - name: Run PHPStan + run: ./vendor/bin/phpstan --error-format=github diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml new file mode 100644 index 0000000..f7492c5 --- /dev/null +++ b/.github/workflows/run-tests.yml @@ -0,0 +1,55 @@ +name: run-tests + +on: + push: + paths: + - '**.php' + - '.github/workflows/run-tests.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] + laravel: [10.*] + stability: [prefer-lowest, prefer-stable] + include: + - laravel: 10.* + testbench: 8.* + carbon: ^2.63 + + name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ 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 require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.carbon }}" --no-interaction --no-update + 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/update-changelog.yml b/.github/workflows/update-changelog.yml new file mode 100644 index 0000000..39de30d --- /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 index 297959a..6ac545f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,23 +1,29 @@ -/vendor/ -node_modules/ -npm-debug.log -yarn-error.log +# spatie/package-skeleton-laravel +.idea +.phpunit.cache +build +composer.lock +coverage +docs +phpunit.xml +phpstan.neon +testbench.yaml +vendor +node_modules -# Laravel 4 specific -bootstrap/compiled.php -app/storage/ +# IDEs and editors +/.idea +/.vscode +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace -# Laravel 5 & Lumen specific -public/storage -public/hot - -# Laravel 5 & Lumen specific with changed public path -public_html/storage -public_html/hot - -storage/*.key -.env -Homestead.yaml -Homestead.json -/.vagrant -.phpunit.result.cache +# OS generated files +.DS_Store +.DS_Store? +.Trashes +ehthumbs.db +Thumbs.db diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8281d6c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Changelog + +All notable changes to `laravel-maker` will be documented in this file. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3bfb686 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) kimchanhyung98 + +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 index 3de2ed1..3e1912a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ -# laravel-maker -A package that creates service&action with artisan command. +# kimchanhyung98/laravel-maker + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/kimchanhyung98/laravel-maker.svg?style=flat-square)](https://packagist.org/packages/kimchanhyung98/laravel-maker) +[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/kimchanhyung98/laravel-maker/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/kimchanhyung98/laravel-maker/actions?query=workflow%3Arun-tests+branch%3Amain) +[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/kimchanhyung98/laravel-maker/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/kimchanhyung98/laravel-maker/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/kimchanhyung98/laravel-maker.svg?style=flat-square)](https://packagist.org/packages/kimchanhyung98/laravel-maker) + +## Installation + +You can install the package via composer: + +```bash +composer require kimchanhyung98/laravel-maker +``` + + + +## Usage + +```bash +php artisan make:action SampleAction +php artisan make:service SampleService +``` + +## Testing + +```bash +composer test +``` + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Security Vulnerabilities + +Please review [our security policy](../../security/policy) on how to report security vulnerabilities. + +## Credits + +- [kimchanhyung98](https://github.com/kimchanhyung98) +- [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 0000000..98a70b8 --- /dev/null +++ b/composer.json @@ -0,0 +1,81 @@ +{ + "name": "kimchanhyung98/laravel-maker", + "description": ":package_description", + "keywords": [ + "kimchanhyung98", + "laravel", + "laravel-maker" + ], + "homepage": "https://github.com/kimchanhyung98/laravel-maker", + "license": "MIT", + "authors": [ + { + "name": "kimchanhyung98", + "email": "kimchanhyung98@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": "^8.1", + "spatie/laravel-package-tools": "^1.14.0", + "illuminate/contracts": "^10.0" + }, + "require-dev": { + "roave/security-advisories": "dev-latest", + "laravel/pint": "^1.0", + "nunomaduro/collision": "^7.8", + "larastan/larastan": "^2.0.1", + "orchestra/testbench": "^8.8", + "pestphp/pest": "^2.20", + "pestphp/pest-plugin-arch": "^2.0", + "pestphp/pest-plugin-laravel": "^2.0", + "phpstan/extension-installer": "^1.1", + "phpstan/phpstan-deprecation-rules": "^1.0", + "phpstan/phpstan-phpunit": "^1.0", + "spatie/laravel-ray": "^1.26" + }, + "autoload": { + "psr-4": { + "Kimchanhyung98\\LaravelMaker\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Kimchanhyung98\\LaravelMaker\\Tests\\": "tests/" + } + }, + "scripts": { + "post-autoload-dump": "@composer run prepare", + "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi", + "prepare": "@php vendor/bin/testbench package:discover --ansi", + "build": [ + "@composer run prepare", + "@php vendor/bin/testbench workbench:build --ansi" + ], + "start": [ + "Composer\\Config::disableProcessTimeout", + "@composer run build", + "@php vendor/bin/testbench serve" + ], + "analyse": "vendor/bin/phpstan analyse", + "test": "vendor/bin/pest", + "test-coverage": "vendor/bin/pest --coverage", + "format": "vendor/bin/pint" + }, + "config": { + "sort-packages": true, + "allow-plugins": { + "pestphp/pest-plugin": true, + "phpstan/extension-installer": true + } + }, + "extra": { + "laravel": { + "providers": [ + "Kimchanhyung98\\LaravelMaker\\MakerServiceProvider" + ] + } + }, + "minimum-stability": "dev", + "prefer-stable": true +} diff --git a/config/maker.php b/config/maker.php new file mode 100644 index 0000000..0c59eae --- /dev/null +++ b/config/maker.php @@ -0,0 +1,13 @@ + [ + 'namespace' => 'App\Actions', + 'stub' => __DIR__.'/../stubs/action.stub', + ], + 'service' => [ + 'namespace' => 'App\Services', + 'stub' => __DIR__.'/../stubs/service.stub', + ], +]; diff --git a/configure.php b/configure.php new file mode 100644 index 0000000..aaaf051 --- /dev/null +++ b/configure.php @@ -0,0 +1,366 @@ +#!/usr/bin/env php + $version) { + if (in_array($name, $names, true)) { + unset($data['require-dev'][$name]); + } + } + + file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); +} + +function remove_composer_script($scriptName) +{ + $data = json_decode(file_get_contents(__DIR__.'/composer.json'), true); + + foreach ($data['scripts'] as $name => $script) { + if ($scriptName === $name) { + unset($data['scripts'][$name]); + break; + } + } + + file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); +} + +function remove_readme_paragraphs(string $file): void +{ + $contents = file_get_contents($file); + + file_put_contents( + $file, + preg_replace('/.*/s', '', $contents) ?: $contents + ); +} + +function safeUnlink(string $filename) +{ + if (file_exists($filename) && is_file($filename)) { + unlink($filename); + } +} + +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 migration_table_name 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|migration_table_name|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v '.basename(__FILE__))); +} + +function getGitHubApiEndpoint(string $endpoint): ?stdClass +{ + try { + $curl = curl_init("https://api.github.com/{$endpoint}"); + curl_setopt_array($curl, [ + CURLOPT_RETURNTRANSFER => true, + CURLOPT_FOLLOWLOCATION => true, + CURLOPT_HTTPGET => true, + CURLOPT_HTTPHEADER => [ + 'User-Agent: spatie-configure-script/1.0', + ], + ]); + + $response = curl_exec($curl); + $statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); + + curl_close($curl); + + if ($statusCode === 200) { + return json_decode($response); + } + } catch (Exception $e) { + // ignore + } + + return null; +} + +function searchCommitsForGitHubUsername(): string +{ + $authorName = strtolower(trim(shell_exec('git config user.name'))); + + $committersRaw = shell_exec("git log --author='@users.noreply.github.com' --pretty='%an:%ae' --reverse"); + $committersLines = explode("\n", $committersRaw); + $committers = array_filter(array_map(function ($line) use ($authorName) { + $line = trim($line); + [$name, $email] = explode(':', $line) + [null, null]; + + return [ + 'name' => $name, + 'email' => $email, + 'isMatch' => strtolower($name) === $authorName && ! str_contains($name, '[bot]'), + ]; + }, $committersLines), fn ($item) => $item['isMatch']); + + if (empty($committers)) { + return ''; + } + + $firstCommitter = reset($committers); + + return explode('@', $firstCommitter['email'])[0] ?? ''; +} + +function guessGitHubUsernameUsingCli() +{ + try { + if (preg_match('/ogged in to github\.com as ([a-zA-Z-_]+).+/', shell_exec('gh auth status -h github.com 2>&1'), $matches)) { + return $matches[1]; + } + } catch (Exception $e) { + // ignore + } + + return ''; +} + +function guessGitHubUsername(): string +{ + $username = searchCommitsForGitHubUsername(); + if (! empty($username)) { + return $username; + } + + $username = guessGitHubUsernameUsingCli(); + if (! empty($username)) { + return $username; + } + + // fall back to using the username from the git remote + $remoteUrl = shell_exec('git config remote.origin.url'); + $remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl))); + + return $remoteUrlParts[1] ?? ''; +} + +function guessGitHubVendorInfo($authorName, $username): array +{ + $remoteUrl = shell_exec('git config remote.origin.url'); + $remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl))); + + $response = getGitHubApiEndpoint("orgs/{$remoteUrlParts[1]}"); + + if ($response === null) { + return [$authorName, $username]; + } + + return [$response->name ?? $authorName, $response->login ?? $username]; +} + +$gitName = run('git config user.name'); +$authorName = ask('Author name', $gitName); + +$gitEmail = run('git config user.email'); +$authorEmail = ask('Author email', $gitEmail); +$authorUsername = ask('Author username', guessGitHubUsername()); + +$guessGitHubVendorInfo = guessGitHubVendorInfo($authorName, $authorUsername); + +$vendorName = ask('Vendor name', $guessGitHubVendorInfo[0]); +$vendorUsername = ask('Vendor username', $guessGitHubVendorInfo[1] ?? slugify($vendorName)); +$vendorSlug = slugify($vendorUsername); + +$vendorNamespace = str_replace('-', '', ucwords($vendorName)); +$vendorNamespace = ask('Vendor namespace', $vendorNamespace); + +$currentDirectory = getcwd(); +$folderName = basename($currentDirectory); + +$packageName = ask('Package name', $folderName); +$packageSlug = slugify($packageName); +$packageSlugWithoutPrefix = remove_prefix('laravel-', $packageSlug); + +$className = title_case($packageName); +$className = ask('Class name', $className); +$variableName = lcfirst($className); +$description = ask('Package description', "This is my package {$packageSlug}"); + +$usePhpStan = confirm('Enable PhpStan?', true); +$useLaravelPint = confirm('Enable Laravel Pint?', true); +$useDependabot = confirm('Enable Dependabot?', true); +$useLaravelRay = confirm('Use Ray for debugging?', true); +$useUpdateChangelogWorkflow = confirm('Use automatic changelog updater workflow?', true); + +writeln('------'); +writeln("Author : {$authorName} ({$authorUsername}, {$authorEmail})"); +writeln("Vendor : {$vendorName} ({$vendorSlug})"); +writeln("Package : {$packageSlug} <{$description}>"); +writeln("Namespace : {$vendorNamespace}\\{$className}"); +writeln("Class name : {$className}"); +writeln('---'); +writeln('Packages & Utilities'); +writeln('Use Laravel/Pint : '.($useLaravelPint ? 'yes' : 'no')); +writeln('Use Larastan/PhpStan : '.($usePhpStan ? 'yes' : 'no')); +writeln('Use Dependabot : '.($useDependabot ? 'yes' : 'no')); +writeln('Use Ray App : '.($useLaravelRay ? 'yes' : 'no')); +writeln('Use Auto-Changelog : '.($useUpdateChangelogWorkflow ? 'yes' : 'no')); +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, + ':package_slug_without_prefix' => $packageSlugWithoutPrefix, + 'Skeleton' => $className, + 'skeleton' => $packageSlug, + 'migration_table_name' => title_snake($packageSlug), + 'variable' => $variableName, + ':package_description' => $description, + ]); + + match (true) { + str_contains($file, determineSeparator('src/Skeleton.php')) => rename($file, determineSeparator('./src/'.$className.'.php')), + str_contains($file, determineSeparator('src/SkeletonServiceProvider.php')) => rename($file, determineSeparator('./src/'.$className.'ServiceProvider.php')), + str_contains($file, determineSeparator('src/Facades/Skeleton.php')) => rename($file, determineSeparator('./src/Facades/'.$className.'.php')), + str_contains($file, determineSeparator('src/Commands/SkeletonCommand.php')) => rename($file, determineSeparator('./src/Commands/'.$className.'Command.php')), + str_contains($file, determineSeparator('database/migrations/create_skeleton_table.php.stub')) => rename($file, determineSeparator('./database/migrations/create_'.title_snake($packageSlugWithoutPrefix).'_table.php.stub')), + str_contains($file, determineSeparator('config/skeleton.php')) => rename($file, determineSeparator('./config/'.$packageSlugWithoutPrefix.'.php')), + str_contains($file, 'README.md') => remove_readme_paragraphs($file), + default => [], + }; +} + +if (! $useLaravelPint) { + safeUnlink(__DIR__.'/.github/workflows/fix-php-code-style-issues.yml'); + safeUnlink(__DIR__.'/pint.json'); +} + +if (! $usePhpStan) { + safeUnlink(__DIR__.'/phpstan.neon.dist'); + safeUnlink(__DIR__.'/phpstan-baseline.neon'); + safeUnlink(__DIR__.'/.github/workflows/phpstan.yml'); + + remove_composer_deps([ + 'phpstan/extension-installer', + 'phpstan/phpstan-deprecation-rules', + 'phpstan/phpstan-phpunit', + 'larastan/larastan', + ]); + + remove_composer_script('phpstan'); +} + +if (! $useDependabot) { + safeUnlink(__DIR__.'/.github/dependabot.yml'); + safeUnlink(__DIR__.'/.github/workflows/dependabot-auto-merge.yml'); +} + +if (! $useLaravelRay) { + remove_composer_deps(['spatie/laravel-ray']); +} + +if (! $useUpdateChangelogWorkflow) { + safeUnlink(__DIR__.'/.github/workflows/update-changelog.yml'); +} + +confirm('Execute `composer install` and run tests?') && run('composer install && composer test'); + +confirm('Let this script delete itself?', true) && unlink(__FILE__); diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon new file mode 100644 index 0000000..e69de29 diff --git a/phpstan.neon.dist b/phpstan.neon.dist new file mode 100644 index 0000000..b4508a2 --- /dev/null +++ b/phpstan.neon.dist @@ -0,0 +1,13 @@ +includes: + - phpstan-baseline.neon + +parameters: + level: 5 + paths: + - src + - config + - database + tmpDir: build/phpstan + checkOctaneCompatibility: true + checkModelProperties: true + checkMissingIterableValueType: false diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..0c2fb32 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,38 @@ + + + + + tests + + + + + + + + + + + + + + + ./src + + + diff --git a/src/Commands/ActionCommand.php b/src/Commands/ActionCommand.php new file mode 100644 index 0000000..60d4978 --- /dev/null +++ b/src/Commands/ActionCommand.php @@ -0,0 +1,27 @@ +type).'.stub'); + } + + /** + * Get the default namespace for the class. + * + * @param string $rootNamespace + */ + protected function getDefaultNamespace($rootNamespace): string + { + return config('maker.'.Str::lower($this->type).'.namespace'); + } +} diff --git a/src/Commands/ServiceCommand.php b/src/Commands/ServiceCommand.php new file mode 100644 index 0000000..fd821f4 --- /dev/null +++ b/src/Commands/ServiceCommand.php @@ -0,0 +1,27 @@ +name('laravel-maker') + ->hasConfigFile('maker') + ->hasCommand(ActionCommand::class) + ->hasCommand(ServiceCommand::class); + } +} diff --git a/src/Stubs/action.stub b/src/Stubs/action.stub new file mode 100644 index 0000000..62d35cb --- /dev/null +++ b/src/Stubs/action.stub @@ -0,0 +1,18 @@ +artisan('make:action SampleAction')->assertSuccessful(); + $this->assertFileExists(app_path('Actions/SampleAction.php')); + } + + public function test_artisan_make_service_command(): void + { + $this->artisan('make:service SampleService')->assertSuccessful(); + $this->assertFileExists(app_path('Services/SampleService.php')); + } +}