preparing package

Author: aagjalpankaj

.gitattributes

@@ -0,0 +1,6 @@
+/tests                  export-ignore
+/config                 export-ignore
+/.github                export-ignore
+.gitattributes          export-ignore
+.gitignore              export-ignore
+README.md               export-ignore

.gitignore

@@ -1,6 +1,3 @@
 composer.phar
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+.idea

README.md

@@ -1 +1,46 @@
-# codebuddy
+# CodeBuddy
+
+## All-in-One Code Quality Tool for Laravel
+
+> **Note:** This package is currently compatible only with the Laravel framework.
+
+## 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)
+
+## 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
+```
+This command sets up **Rector, PestPHP, Pint, and PHPStan** with standard configurations.
+
+### Run CI Checks
+```sh
+php artisan codebuddy:ci [--fix]
+```
+Runs tests, performs static analysis, and checks code style in a **dry-run mode** (does not modify files). Optimized for CI/CD pipelines.
+
+- `--fix`: Automatically applies fixes for Rector and Pint where possible.
+
+### Generate Code Quality Report
+```sh
+php artisan codebuddy:report [--show|--send-to=<email>]
+```
+- `--show`: Displays the overall code health report in the console.
+- `--send-to=<email>`: Sends the report to the specified email address.
+
+---
+
+This package simplifies code quality enforcement, making it easier to maintain a high standard across your Laravel projects.

composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "codebuddyphp/codebuddy",
+    "description": "All-in-one tool for your codebase",
+    "type": "library",
+    "require": {
+        "php": "^8.2",
+        "laravel/framework": "^11.0",
+        "nunomaduro/termwind": "^2.3",
+        "laravel/pint": "^1.20",
+        "larastan/larastan": "^3.0",
+        "rector/rector": "^2.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Codebuddyphp\\Codebuddy\\": "src/"
+        }
+    },
+    "scripts": {
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Codebuddyphp\\Codebuddy\\CodebuddyServiceProvider"
+            ],
+            "aliases": {
+            }
+        }
+    },
+    "config": {
+        "preferred-install": "dist"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

config/codebuddy.php

@@ -0,0 +1 @@
+<?php

config/laravel/phpstan.neon

@@ -0,0 +1,9 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - app/
+
+    level: max

config/laravel/pint.json

@@ -0,0 +1,7 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "declare_strict_types": true,
+        "strict_comparison": true
+    }
+}

config/laravel/rector.php

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

src/CodebuddyServiceProvider.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Codebuddyphp\Codebuddy;
+
+use Codebuddyphp\Codebuddy\Commands\Configure;
+use Illuminate\Support\ServiceProvider;
+
+class CodebuddyServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        // Register bindings if any
+    }
+
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                Configure::class,
+            ]);
+
+            $this->publishes([
+                __DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
+            ]);
+        }
+    }
+
+    public function provides()
+    {
+        return [
+            Configure::class,
+        ];
+    }
+}

src/Commands/Configure.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Codebuddyphp\Codebuddy\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+use function Termwind\render;
+
+class Configure extends Command
+{
+    protected $signature = 'codebuddy:configure';
+
+    protected $description = 'Configure Rector, Larastan (PHPStan) & Pint';
+
+    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;
+                }
+            }
+
+            $filesystem->copy($sourceFile, $destinationFile);
+            $this->info("Copied: {$file} to project root");
+            $this->newLine();
+        }
+    }
+
+    private function confirmOverwrite(string $file): bool
+    {
+        $this->info(
+            sprintf('%s already exists. Do you want to overwrite it?', $file)
+        );
+
+        return $this->ask('Overwrite?', false);
+    }
+}