Skip to content

Commit 2a4c2f7

Browse files
aagjalpankajaagjalpankaj
committed
create workflow
1 parent ef79b22 commit 2a4c2f7

15 files changed

Lines changed: 275 additions & 87 deletions

‎.gitattributes‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/tests export-ignore
2-
/config export-ignore
32
/.github export-ignore
43
.gitattributes export-ignore
54
.gitignore export-ignore
65
README.md export-ignore
6+
rector.php export-ignore
7+
phpstan.neon export-ignore

‎.github/workflows/ci.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches: [ "main" ]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
ci:
14+
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Cache Composer packages
21+
id: composer-cache
22+
uses: actions/cache@v3
23+
with:
24+
path: vendor
25+
key: ${{ runner.os }}-ci-${{ hashFiles('**/composer.json') }}
26+
restore-keys: |
27+
${{ runner.os }}-ci-
28+
29+
- name: Install dependencies
30+
run: composer install --prefer-dist --no-progress
31+
32+
- name: Run ci checks
33+
run: composer ci

‎README.md‎

Lines changed: 10 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,21 @@
11
# CodeBuddy
22

3-
## All-in-One Code Quality Tool for Laravel
3+
## All-in-one code quality tool for your codebase
44

5-
> **Note:** This package is currently compatible only with the Laravel framework.
5+
> **Note:** This package is currently compatible only with the Laravel framework 11 & 12.
66
7-
## About
8-
CodeBuddy is a wrapper around essential development tools that help maintain code quality in your Laravel projects. It integrates:
7+
## Installation
98

10-
- **Rector** (automated code refactoring)
11-
- **Pint** (code styling)
12-
- **PHPStan** (static analysis)
13-
- **PestPHP** (testing framework)
14-
15-
## Features
16-
- One command setup for essential tools.
17-
- CI/CD optimized validation.
18-
- Automated fixes for coding standards.
19-
- Code health reporting with email support.
20-
21-
## Commands
22-
23-
### Configure Code Quality Tools
24-
```sh
25-
php artisan codebuddy:configure
269
```
27-
This command sets up **Rector, PestPHP, Pint, and PHPStan** with standard configurations.
28-
29-
### Run CI Checks
30-
```sh
31-
php artisan codebuddy:ci [--fix]
10+
composer require --dev codebuddyphp/codebuddy
3211
```
33-
Runs tests, performs static analysis, and checks code style in a **dry-run mode** (does not modify files). Optimized for CI/CD pipelines.
3412

35-
- `--fix`: Automatically applies fixes for Rector and Pint where possible.
13+
## Usage
3614

37-
### Generate Code Quality Report
38-
```sh
39-
php artisan codebuddy:report [--show|--send-to=<email>]
4015
```
41-
- `--show`: Displays the overall code health report in the console.
42-
- `--send-to=<email>`: Sends the report to the specified email address.
43-
44-
---
16+
php artisan cb:setup
17+
```
4518

46-
This package simplifies code quality enforcement, making it easier to maintain a high standard across your Laravel projects.
19+
```
20+
php artisan cb:scan
21+
```

‎composer.json‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
11
{
22
"name": "codebuddyphp/codebuddy",
3-
"description": "All-in-one tool for your codebase",
3+
"description": "All-in-one code quality tool for your codebase",
44
"type": "library",
5+
"keywords": ["testing", "development", "tool"],
6+
"license": "MIT",
57
"require": {
68
"php": "^8.2",
7-
"laravel/framework": "^11.0",
8-
"nunomaduro/termwind": "^2.3",
9-
"laravel/pint": "^1.20",
9+
"laravel/framework": "^11|^12",
10+
"laravel/pint": "^1.21",
11+
"driftingly/rector-laravel": "^2.0",
1012
"larastan/larastan": "^3.0",
11-
"rector/rector": "^2.0"
13+
"pestphp/pest": "^3.7"
14+
},
15+
"require-dev": {
1216
},
1317
"autoload": {
1418
"psr-4": {
1519
"Codebuddyphp\\Codebuddy\\": "src/"
1620
}
1721
},
1822
"scripts": {
23+
"lint": "pint --test",
24+
"lint.fix": "pint",
25+
"rector": "rector process --dry-run",
26+
"rector.fix": "rector process",
27+
"ci": [
28+
"@lint",
29+
"@rector"
30+
],
31+
"ci.fix": [
32+
"@rector.fix",
33+
"@lint.fix"
34+
]
1935
},
2036
"extra": {
2137
"laravel": {
@@ -27,7 +43,10 @@
2743
}
2844
},
2945
"config": {
30-
"preferred-install": "dist"
46+
"preferred-install": "dist",
47+
"allow-plugins": {
48+
"pestphp/pest-plugin": true
49+
}
3150
},
3251
"minimum-stability": "dev",
3352
"prefer-stable": true

‎phpstan.neon‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
includes:
2+
- vendor/larastan/larastan/extension.neon
3+
- vendor/nesbot/carbon/extension.neon
4+
5+
parameters:
6+
7+
paths:
8+
- src/
9+
10+
level: max

‎rector.php‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
7+
return RectorConfig::configure()
8+
->withPaths([
9+
__DIR__.'/config',
10+
__DIR__.'/src',
11+
__DIR__.'/tests',
12+
])
13+
->withPhpSets()
14+
->withPreparedSets(
15+
deadCode: true,
16+
codeQuality: true,
17+
typeDeclarations: true,
18+
privatization: true,
19+
earlyReturn: true,
20+
strictBooleans: true,
21+
);

‎resources/views/banner.blade.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div class="m-1">
2+
<div class="px-1 bg-sky-600">CodeBuddy</div>
3+
<em class="ml-1 underline">
4+
All-in-one code quality tool for your codebase
5+
</em>
6+
</div>

‎src/CodebuddyServiceProvider.php‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,40 @@
33
namespace Codebuddyphp\Codebuddy;
44

55
use Codebuddyphp\Codebuddy\Commands\Configure;
6+
use Codebuddyphp\Codebuddy\Commands\Review;
67
use Illuminate\Support\ServiceProvider;
78

8-
class CodebuddyServiceProvider extends ServiceProvider
9+
final class CodebuddyServiceProvider extends ServiceProvider
910
{
10-
public function register()
11-
{
12-
// Register bindings if any
13-
}
11+
public function register(): void {}
1412

15-
public function boot()
13+
public function boot(): void
1614
{
1715
if ($this->app->runningInConsole()) {
18-
$this->commands([
19-
Configure::class,
20-
]);
16+
17+
$this->commands(
18+
[
19+
Configure::class,
20+
Review::class,
21+
]
22+
);
2123

2224
$this->publishes([
2325
__DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
2426
]);
2527
}
28+
29+
$this->loadViewsFrom(__DIR__.'/../resources/views', 'codebuddy');
2630
}
2731

28-
public function provides()
32+
/**
33+
* @return array<string>
34+
*/
35+
public function provides(): array
2936
{
3037
return [
3138
Configure::class,
39+
Review::class,
3240
];
3341
}
34-
}
42+
}

‎src/Commands/Configure.php‎

Lines changed: 56 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,76 @@
33
namespace Codebuddyphp\Codebuddy\Commands;
44

55
use Illuminate\Console\Command;
6-
use Illuminate\Filesystem\Filesystem;
7-
use function Termwind\render;
6+
use Illuminate\Support\Facades\File;
87

9-
class Configure extends Command
8+
use function Laravel\Prompts\confirm;
9+
use function Laravel\Prompts\spin;
10+
11+
final class Configure extends Command
1012
{
11-
protected $signature = 'codebuddy:configure';
13+
protected $signature = 'cb:configure';
1214

13-
protected $description = 'Configure Rector, Larastan (PHPStan) & Pint';
15+
protected $description = 'Configures essential packages for your project';
1416

1517
public function handle(): void
1618
{
17-
$filesystem = new Filesystem();
18-
19-
$configs = [
20-
'rector.php',
21-
'phpstan.neon',
22-
'pint.json',
19+
$packages = [
20+
[
21+
'package_name' => 'driftingly/rector-laravel',
22+
'stub_file' => 'rector.php.stub',
23+
'config_file' => 'rector.php',
24+
'description' => 'Rector makes upgrading and maintaining code easier.',
25+
],
26+
[
27+
'package_name' => 'larastan/larastan',
28+
'stub_file' => 'phpstan.neon.stub',
29+
'config_file' => 'phpstan.neon',
30+
'description' => 'PHPStan helps detect errors at compile time instead of runtime.',
31+
],
32+
[
33+
'package_name' => 'laravel/pint',
34+
'stub_file' => 'pint.json.stub',
35+
'config_file' => 'pint.json',
36+
'description' => 'Pint ensures your code follows consistent formatting rules.',
37+
],
38+
[
39+
'package_name' => 'pestphp/pest',
40+
'stub_file' => 'phpunit.xml.stub',
41+
'config_file' => 'phpunit.xml',
42+
'description' => 'Elegant testing framework.',
43+
],
2344
];
2445

25-
foreach ($configs as $file) {
26-
$sourceFile = __DIR__ . "/../../config/laravel/{$file}";
27-
$destinationFile = base_path($file);
46+
foreach ($packages as $package) {
47+
$this->configurePackage($package);
48+
}
2849

29-
if (!$filesystem->exists($sourceFile)) {
30-
$this->error("Source file not found: {$sourceFile}");
31-
continue;
32-
}
50+
$confirmed = confirm('Setup completed. Do you want to scan codebase?');
3351

34-
if ($filesystem->exists($destinationFile)) {
35-
$overwrite = $this->confirmOverwrite($destinationFile);
36-
if (!$overwrite) {
37-
$this->warn("Skipped: {$destinationFile} already exists");
38-
continue;
39-
}
40-
}
41-
42-
$filesystem->copy($sourceFile, $destinationFile);
43-
$this->info("Copied: {$file} to project root");
44-
$this->newLine();
52+
if ($confirmed) {
53+
$this->call(Review::class);
4554
}
4655
}
4756

48-
private function confirmOverwrite(string $file): bool
57+
private function configurePackage(array $package): void
4958
{
50-
$this->info(
51-
sprintf('%s already exists. Do you want to overwrite it?', $file)
52-
);
59+
$this->newLine();
60+
61+
spin(
62+
callback: function () use ($package): void {
63+
sleep(1);
64+
$result = File::copy(
65+
__DIR__.'/../../stubs/'.$package['stub_file'],
66+
base_path($package['config_file'])
67+
);
68+
if (! $result) {
69+
self::fail(
70+
sprintf('%s: failed to configure', $package['package_name'])
71+
);
72+
}
73+
},
74+
message: sprintf('🚀 Configuring %s...', $package['package_name']));
5375

54-
return $this->ask('Overwrite?', false);
76+
$this->info(sprintf('✅ %s: configured', $package['package_name']));
5577
}
5678
}

0 commit comments

Comments
 (0)