create workflow

Author: aagjalpankaj

.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,8 +1,8 @@
 # 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.
 
 ## About
 CodeBuddy is a wrapper around essential development tools that help maintain code quality in your Laravel projects. It integrates:
@@ -18,6 +18,12 @@ CodeBuddy is a wrapper around essential development tools that help maintain cod
 - Automated fixes for coding standards.
 - Code health reporting with email support.
 
+## Installation
+
+```
+composer require codebuddyphp/codebuddy --dev
+```
+
 ## Commands
 
 ### Configure Code Quality Tools

composer.json

@@ -16,6 +16,22 @@
         }
     },
     "scripts": {
+        "lint": "XDEBUG_MODE=off pint --test",
+        "lint.fix": "XDEBUG_MODE=off pint",
+        "stan": "XDEBUG_MODE=off phpstan analyse --ansi --memory-limit=-1",
+        "test.arch": "XDEBUG_MODE=off pest --testsuite=Architecture",
+        "test.unit": "XDEBUG_MODE=off pest --testsuite=Unit",
+        "test.feature": "XDEBUG_MODE=coverage pest --testsuite=Feature --coverage --min=90",
+        "rector": "XDEBUG_MODE=off rector process --dry-run",
+        "rector.fix": "XDEBUG_MODE=off rector process",
+        "ci": [
+            "@lint",
+            "@rector"
+        ],
+        "ci.fix": [
+            "@rector.fix",
+            "@lint.fix"
+        ]
     },
     "extra": {
         "laravel": {

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,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/config',
+        __DIR__.'/src',
+    ])
+    // uncomment to reach your current PHP version
+    // ->withPhpSets()
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0);

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 tool for your codebase quality
+    </em>
+</div>

src/CodebuddyServiceProvider.php

@@ -2,7 +2,9 @@
 
 namespace Codebuddyphp\Codebuddy;
 
+use Codebuddyphp\Codebuddy\Commands\Check;
 use Codebuddyphp\Codebuddy\Commands\Configure;
+use Codebuddyphp\Codebuddy\Commands\Score;
 use Illuminate\Support\ServiceProvider;
 
 class CodebuddyServiceProvider extends ServiceProvider
@@ -17,18 +19,27 @@ public function boot()
         if ($this->app->runningInConsole()) {
             $this->commands([
                 Configure::class,
+                Check::class,
+                Score::class,
             ]);
 
             $this->publishes([
                 __DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
             ]);
         }
+
+        $this->loadViewsFrom(__DIR__.'/../resources/views', 'codebuddy');
     }
 
-    public function provides()
+    /**
+     * @return array<string>
+     */
+    public function provides(): array
     {
         return [
             Configure::class,
+            Check::class,
+            Score::class,
         ];
     }
-}
+}

src/Commands/Check.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Codebuddyphp\Codebuddy\Commands;
+
+use Illuminate\Console\Command;
+
+use function Termwind\render;
+
+class Check extends Command
+{
+    protected $signature = 'codebuddy:check';
+
+    protected $description = 'Run ci checks';
+
+    public function handle(): void
+    {
+        $checks = [
+            'vendor/bin/pint --test',
+            'vendor/bin/rector --dry-run',
+            'vendor/bin/phpstan analyse',
+        ];
+
+        // @phpstan-ignore-next-line
+        render(view('codebuddy::banner'));
+
+        $this->info('Running CI checks...');
+        $this->newLine();
+
+        $failed = false;
+
+        foreach ($checks as $check) {
+            $this->info("Running: $check");
+            $process = proc_open($check, [
+                0 => ['pipe', 'r'],
+                1 => ['pipe', 'w'],
+                2 => ['pipe', 'w'],
+            ], $pipes);
+
+            $output = stream_get_contents($pipes[1]);
+            $errors = stream_get_contents($pipes[2]);
+            fclose($pipes[0]);
+            fclose($pipes[1]);
+            fclose($pipes[2]);
+
+            $exitCode = proc_close($process);
+
+            if ($exitCode !== 0) {
+                $this->error("Failed: $check");
+                $this->line($output);
+                $this->error($errors);
+                $failed = true;
+            } else {
+                $this->info("Passed: $check");
+            }
+
+            $this->newLine();
+        }
+
+        if ($failed) {
+            $this->error('CI checks failed.');
+            exit(1);
+        } else {
+            $this->info('All CI checks passed successfully!');
+        }
+    }
+}

src/Commands/Configure.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Filesystem\Filesystem;
+
 use function Termwind\render;
 
 class Configure extends Command
@@ -14,43 +15,58 @@ class Configure extends Command
 
     public function handle(): void
     {
-        $filesystem = new Filesystem();
+        $filesystem = new Filesystem;
 
         $configs = [
-            'rector.php',
-            'phpstan.neon',
-            'pint.json',
+            'rector' => [
+                'stub_file' => __DIR__.'/../../stubs/rector.php.stub',
+                'config_file' => 'rector.php',
+                'description' => 'Rector makes upgrading and maintaining code easier.',
+            ],
+            'phpstan' => [
+                'stub_file' => __DIR__.'/../../stubs/phpstan.neon.stub',
+                'config_file' => 'phpstan.neon',
+                'description' => 'PHPStan helps detect errors at compile time instead of runtime.',
+            ],
+            'pint' => [
+                'stub_file' => __DIR__.'/../../stubs/pint.json.stub',
+                'config_file' => 'pint.json',
+                'description' => 'Pint ensures your code follows consistent formatting rules.',
+            ],
         ];
 
-        foreach ($configs as $file) {
-            $sourceFile = __DIR__ . "/../../config/laravel/{$file}";
-            $destinationFile = base_path($file);
+        render(view('codebuddy::banner'));
+
+        foreach ($configs as $key => $config) {
+            $this->newLine();
+            $this->info("Configuring {$key}...");
+
+            $stubFile = $config['stub_file'];
+            $destinationFile = base_path($config['config_file']);
 
-            if (!$filesystem->exists($sourceFile)) {
-                $this->error("Source file not found: {$sourceFile}");
+            if (! $filesystem->exists($stubFile)) {
+                $this->error("Stub file not found: {$stubFile}");
                 continue;
             }
 
             if ($filesystem->exists($destinationFile)) {
                 $overwrite = $this->confirmOverwrite($destinationFile);
-                if (!$overwrite) {
-                    $this->warn("Skipped: {$destinationFile} already exists");
+                if (! $overwrite) {
+                    $this->warn(sprintf('Skipped: %s already exists', basename($destinationFile)));
                     continue;
                 }
             }
 
-            $filesystem->copy($sourceFile, $destinationFile);
-            $this->info("Copied: {$file} to project root");
+            $content = file_get_contents($stubFile);
+
+            $filesystem->put($destinationFile, $content);
+            $this->info(sprintf('Created: %s in project root', $config['config_file']));
             $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);
+        return $this->confirm(sprintf('%s already exists. Overwrite?', basename($file)), true);
     }
 }

src/Commands/Score.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Codebuddyphp\Codebuddy\Commands;
+
+use Illuminate\Console\Command;
+use Symfony\Component\Process\Process;
+
+class Score extends Command
+{
+    protected $signature = 'codebuddy:score';
+
+    protected $description = 'Calculate the Codebuddy Score for your codebase';
+
+    public function handle()
+    {
+        $this->info('🔍 Running Codebuddy analysis...');
+
+        $scores = [
+            'formatting' => $this->runPint(),
+            'static_analysis' => $this->runPHPStan(),
+            'code_refactoring' => $this->runRector(),
+            'test_coverage' => $this->runPestCoverage(),
+        ];
+
+        $totalScore = round(array_sum($scores) / count($scores));
+
+        $this->line("\n🚀 <info>Codebuddy Score: {$totalScore}/100</info>");
+        $this->table(['Metric', 'Score (%)'], [
+            ['Code Formatting (Pint)', $scores['formatting']],
+            ['Static Analysis (PHPStan)', $scores['static_analysis']],
+            ['Code Refactoring (Rector)', $scores['code_refactoring']],
+            ['Test Coverage (PestPHP)', $scores['test_coverage']],
+        ]);
+
+        return Command::SUCCESS;
+    }
+
+    private function runPint(): int
+    {
+        return $this->executeCommand(['vendor/bin/pint', '--test']) ? 100 : 80;
+    }
+
+    private function runPHPStan(): int
+    {
+        return $this->executeCommand(['vendor/bin/phpstan', 'analyse', '--level=max']) ? 90 : 60;
+    }
+
+    private function runRector(): int
+    {
+        return $this->executeCommand(['vendor/bin/rector', 'process', '--dry-run']) ? 95 : 70;
+    }
+
+    private function runPestCoverage(): int
+    {
+        return $this->executeCommand(['vendor/bin/pest', '--coverage']) ? 85 : 50;
+    }
+
+    private function executeCommand(array $command): bool
+    {
+        $process = new Process($command);
+        $process->run();
+
+        return $process->isSuccessful();
+    }
+}