create workflow

Author: aagjalpankaj

.gitattributes

@@ -1,6 +1,7 @@
 /tests                  export-ignore
-/config                 export-ignore
 /.github                export-ignore
 .gitattributes          export-ignore
 .gitignore              export-ignore
 README.md               export-ignore
+rector.php              export-ignore
+phpstan.neon            export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: ci
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-ci-${{ hashFiles('**/composer.json') }}
+        restore-keys: |
+          ${{ runner.os }}-ci-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run ci checks
+      run: composer ci

README.md

@@ -1,46 +1,36 @@
 # CodeBuddy
 
-## All-in-One Code Quality Tool for Laravel
+## All-in-one code quality tool for your codebase
 
-> **Note:** This package is currently compatible only with the Laravel framework.
+> **Note:** This package is currently compatible only with the Laravel framework 11 & 12.
 
-## About
-CodeBuddy is a wrapper around essential development tools that help maintain code quality in your Laravel projects. It integrates:
 
-- **Rector** (automated code refactoring)
-- **Pint** (code styling)
-- **PHPStan** (static analysis)
-- **PestPHP** (testing framework)
+## Installation
 
-## Features
-- One command setup for essential tools.
-- CI/CD optimized validation.
-- Automated fixes for coding standards.
-- Code health reporting with email support.
-
-## Commands
-
-### Configure Code Quality Tools
-```sh
-php artisan codebuddy:configure
+Install the package as dev dependency:
+```
+composer require --dev codebuddyphp/codebuddy
 ```
-This command sets up **Rector, PestPHP, Pint, and PHPStan** with standard configurations.
 
-### Run CI Checks
-```sh
-php artisan codebuddy:ci [--fix]
+Publish the configuration:
 ```
-Runs tests, performs static analysis, and checks code style in a **dry-run mode** (does not modify files). Optimized for CI/CD pipelines.
+php artisan vendor:publish --provider="Codebuddyphp\Codebuddy\CodebuddyServiceProvider" --tag="codebuddy-config" --force
+```
+
 
-- `--fix`: Automatically applies fixes for Rector and Pint where possible.
+## Usage
 
-### Generate Code Quality Report
-```sh
-php artisan codebuddy:report [--show|--send-to=<email>]
+Configure essential tools (like Rector, Pint, Phpstan, Pest, etc):
+```
+php artisan cb:configure
 ```
-- `--show`: Displays the overall code health report in the console.
-- `--send-to=<email>`: Sends the report to the specified email address.
 
----
+Find or fix codebase issues:
+```
+php artisan cb:review [--fix]
+```
 
-This package simplifies code quality enforcement, making it easier to maintain a high standard across your Laravel projects.
+Get quick codebase insights:
+```
+php artisan cb:insights
+```

composer.json

@@ -1,21 +1,37 @@
 {
     "name": "codebuddyphp/codebuddy",
-    "description": "All-in-one tool for your codebase",
+    "description": "All-in-one code quality tool for your codebase",
     "type": "library",
+    "keywords": ["testing", "development", "tool"],
+    "license": "MIT",
     "require": {
         "php": "^8.2",
-        "laravel/framework": "^11.0",
-        "nunomaduro/termwind": "^2.3",
-        "laravel/pint": "^1.20",
+        "laravel/framework": "^11|^12",
+        "laravel/pint": "^1.21",
+        "driftingly/rector-laravel": "^2.0",
         "larastan/larastan": "^3.0",
-        "rector/rector": "^2.0"
+        "pestphp/pest": "^3.7"
+    },
+    "require-dev": {
     },
     "autoload": {
         "psr-4": {
             "Codebuddyphp\\Codebuddy\\": "src/"
         }
     },
     "scripts": {
+        "lint": "pint --test",
+        "lint.fix": "pint",
+        "rector": "rector process --dry-run",
+        "rector.fix": "rector process",
+        "ci": [
+            "@lint",
+            "@rector"
+        ],
+        "ci.fix": [
+            "@rector.fix",
+            "@lint.fix"
+        ]
     },
     "extra": {
         "laravel": {
@@ -27,7 +43,10 @@
         }
     },
     "config": {
-        "preferred-install": "dist"
+        "preferred-install": "dist",
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "minimum-stability": "dev",
     "prefer-stable": true

config/codebuddy.php

@@ -1 +1,38 @@
 <?php
+
+return [
+    'checks' => [
+        'rector' => [
+            'package' => 'driftingly/rector-laravel',
+            'stub_file' => 'rector.php.stub',
+            'config_file' => 'rector.php',
+            'dry_run' => 'vendor/bin/rector process --dry-run',
+            'auto_fix' => 'vendor/bin/rector process',
+            'tags' => ['code-quality', 'auto-upgrades'],
+        ],
+        'pint' => [
+            'package' => 'laravel/pint',
+            'stub_file' => 'pint.json.stub',
+            'config_file' => 'pint.json',
+            'dry_run' => 'vendor/bin/pint --test',
+            'auto_fix' => 'vendor/bin/pint',
+            'tags' => ['code-styling'],
+        ],
+        'phpstan' => [
+            'package' => 'larastan/larastan',
+            'stub_file' => 'phpstan.neon.stub',
+            'config_file' => 'phpstan.neon',
+            'dry_run' => 'vendor/bin/phpstan analyse',
+            'auto_fix' => null,
+            'tags' => ['static-analysis'],
+        ],
+        'pest' => [
+            'package' => 'pestphp/pest',
+            'stub_file' => 'phpunit.xml.stub',
+            'config_file' => 'phpunit.xml',
+            'dry_run' => 'vendor/bin/pest --compact',
+            'auto_fix' => null,
+            'tags' => ['testing', 'unit-testing', 'feature-testing', 'mutation-testing'],
+        ],
+    ],
+];

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+    - vendor/nesbot/carbon/extension.neon
+
+parameters:
+
+    paths:
+        - src/
+
+    level: max

rector.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/config',
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+    ->withPhpSets()
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        typeDeclarations: true,
+        privatization: true,
+        earlyReturn: true,
+        strictBooleans: true,
+    );

resources/views/banner.blade.php

@@ -0,0 +1,6 @@
+<div class="m-1">
+    <div class="px-1 bg-sky-600">CodeBuddy</div>
+    <em class="ml-1 underline">
+        All-in-one code quality tool for your codebase
+    </em>
+</div>

src/CodebuddyServiceProvider.php

@@ -3,32 +3,46 @@
 namespace Codebuddyphp\Codebuddy;
 
 use Codebuddyphp\Codebuddy\Commands\Configure;
+use Codebuddyphp\Codebuddy\Commands\Insights;
+use Codebuddyphp\Codebuddy\Commands\Review;
 use Illuminate\Support\ServiceProvider;
 
-class CodebuddyServiceProvider extends ServiceProvider
+final class CodebuddyServiceProvider extends ServiceProvider
 {
-    public function register()
-    {
-        // Register bindings if any
-    }
+    public function register(): void {}
 
-    public function boot()
+    public function boot(): void
     {
         if ($this->app->runningInConsole()) {
-            $this->commands([
-                Configure::class,
-            ]);
 
-            $this->publishes([
-                __DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
-            ]);
+            $this->commands(
+                [
+                    Configure::class,
+                    Review::class,
+                    Insights::class,
+                ]
+            );
+
+            $this->publishes(
+                [
+                    __DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
+                ],
+                'codebuddy-config'
+            );
         }
+
+        $this->loadViewsFrom(__DIR__.'/../resources/views', 'codebuddy');
     }
 
-    public function provides()
+    /**
+     * @return array<string>
+     */
+    public function provides(): array
     {
         return [
             Configure::class,
+            Review::class,
+            Insights::class,
         ];
     }
-}
+}

src/Commands/Configure.php

@@ -3,54 +3,52 @@
 namespace Codebuddyphp\Codebuddy\Commands;
 
 use Illuminate\Console\Command;
-use Illuminate\Filesystem\Filesystem;
-use function Termwind\render;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\File;
 
-class Configure extends Command
+use function Laravel\Prompts\confirm;
+use function Laravel\Prompts\spin;
+
+final class Configure extends Command
 {
-    protected $signature = 'codebuddy:configure';
+    protected $signature = 'cb:configure';
 
-    protected $description = 'Configure Rector, Larastan (PHPStan) & Pint';
+    protected $description = 'Configures essential packages for your project';
 
     public function handle(): void
     {
-        $filesystem = new Filesystem();
-
-        $configs = [
-            'rector.php',
-            'phpstan.neon',
-            'pint.json',
-        ];
-
-        foreach ($configs as $file) {
-            $sourceFile = __DIR__ . "/../../config/laravel/{$file}";
-            $destinationFile = base_path($file);
-
-            if (!$filesystem->exists($sourceFile)) {
-                $this->error("Source file not found: {$sourceFile}");
-                continue;
-            }
-
-            if ($filesystem->exists($destinationFile)) {
-                $overwrite = $this->confirmOverwrite($destinationFile);
-                if (!$overwrite) {
-                    $this->warn("Skipped: {$destinationFile} already exists");
-                    continue;
-                }
-            }
+        $packages = Config::get('codebuddy.checks');
+
+        foreach ($packages as $package) {
+            $this->configurePackage($package);
+        }
+
+        $confirmed = confirm('Setup completed. Do you want to review codebase?');
 
-            $filesystem->copy($sourceFile, $destinationFile);
-            $this->info("Copied: {$file} to project root");
-            $this->newLine();
+        if ($confirmed) {
+            $this->call(Review::class);
         }
     }
 
-    private function confirmOverwrite(string $file): bool
+    private function configurePackage(array $package): void
     {
-        $this->info(
-            sprintf('%s already exists. Do you want to overwrite it?', $file)
-        );
+        $this->newLine();
+
+        spin(
+            callback: function () use ($package): void {
+                sleep(1);
+                $result = File::copy(
+                    __DIR__.'/../../stubs/'.$package['stub_file'],
+                    base_path($package['config_file'])
+                );
+                if (! $result) {
+                    self::fail(
+                        sprintf('%s: failed to configure', $package['package'])
+                    );
+                }
+            },
+            message: sprintf('🚀 Configuring %s...', $package['package']));
 
-        return $this->ask('Overwrite?', false);
+        $this->info(sprintf('✅ %s: configured', $package['package']));
     }
 }