Skip to content

Commit e2963c8

Browse files
aagjalpankajaagjalpankaj
committed
create workflow
1 parent ef79b22 commit e2963c8

File tree

13 files changed

+202
-82
lines changed

13 files changed

+202
-82
lines changed

‎.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: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,17 @@
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 codebuddyphp/codebuddy --dev
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+
## Commands
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-
---
45-
46-
This package simplifies code quality enforcement, making it easier to maintain a high standard across your Laravel projects.
16+
php artisan codebuddy:configure
17+
```

‎composer.json‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,36 @@
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+
"license": "MIT",
56
"require": {
67
"php": "^8.2",
7-
"laravel/framework": "^11.0",
8-
"nunomaduro/termwind": "^2.3",
9-
"laravel/pint": "^1.20",
8+
"laravel/framework": "^11|^12",
9+
"laravel/pint": "^1.21",
10+
"driftingly/rector-laravel": "^2.0",
1011
"larastan/larastan": "^3.0",
11-
"rector/rector": "^2.0"
12+
"pestphp/pest": "^3.7"
13+
},
14+
"require-dev": {
1215
},
1316
"autoload": {
1417
"psr-4": {
1518
"Codebuddyphp\\Codebuddy\\": "src/"
1619
}
1720
},
1821
"scripts": {
22+
"lint": "pint --test",
23+
"lint.fix": "pint",
24+
"rector": "rector process --dry-run",
25+
"rector.fix": "rector process",
26+
"ci": [
27+
"@lint",
28+
"@rector"
29+
],
30+
"ci.fix": [
31+
"@rector.fix",
32+
"@lint.fix"
33+
]
1934
},
2035
"extra": {
2136
"laravel": {
@@ -27,7 +42,10 @@
2742
}
2843
},
2944
"config": {
30-
"preferred-install": "dist"
45+
"preferred-install": "dist",
46+
"allow-plugins": {
47+
"pestphp/pest-plugin": true
48+
}
3149
},
3250
"minimum-stability": "dev",
3351
"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: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,36 @@
77

88
class CodebuddyServiceProvider extends ServiceProvider
99
{
10-
public function register()
10+
public function register(): void
1111
{
1212
// Register bindings if any
1313
}
1414

15-
public function boot()
15+
public function boot(): void
1616
{
1717
if ($this->app->runningInConsole()) {
18-
$this->commands([
19-
Configure::class,
20-
]);
18+
19+
$this->commands(
20+
[
21+
Configure::class,
22+
]
23+
);
2124

2225
$this->publishes([
2326
__DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
2427
]);
2528
}
29+
30+
$this->loadViewsFrom(__DIR__.'/../resources/views', 'codebuddy');
2631
}
2732

28-
public function provides()
33+
/**
34+
* @return array<string>
35+
*/
36+
public function provides(): array
2937
{
3038
return [
3139
Configure::class,
3240
];
3341
}
34-
}
42+
}

‎src/Commands/Configure.php‎

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

55
use Illuminate\Console\Command;
6-
use Illuminate\Filesystem\Filesystem;
6+
use Illuminate\Support\Facades\File;
7+
8+
use function Laravel\Prompts\spin;
79
use function Termwind\render;
810

911
class Configure extends Command
1012
{
1113
protected $signature = 'codebuddy: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();
19+
render(view('codebuddy::banner'));
1820

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

25-
foreach ($configs as $file) {
26-
$sourceFile = __DIR__ . "/../../config/laravel/{$file}";
27-
$destinationFile = base_path($file);
28-
29-
if (!$filesystem->exists($sourceFile)) {
30-
$this->error("Source file not found: {$sourceFile}");
31-
continue;
32-
}
33-
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();
48+
foreach ($packages as $package) {
49+
$this->configurePackage($package);
4550
}
4651
}
4752

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

54-
return $this->ask('Overwrite?', false);
70+
$this->info(sprintf('%s: configured', $package['package_name']));
5571
}
5672
}

‎config/laravel/phpstan.neon‎ renamed to ‎stubs/phpstan.neon.stub‎

File renamed without changes.

0 commit comments

Comments
 (0)