Skip to content

Commit d96faa6

Browse files
aagjalpankajaagjalpankaj
committed
create workflow
1 parent ef79b22 commit d96faa6

File tree

16 files changed

+438
-91
lines changed

16 files changed

+438
-91
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: 23 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,37 @@
11
# CodeBuddy
22

3-
## All-in-One Code Quality Tool for Laravel
3+
## All-in-one code quality tool for your codebase
4+
Supercharge your codebase with a single package that brings together the best code quality tools - Rector, Pint, PHPStan, PestPHP, and more. Write cleaner, more maintainable code with minimal setup.
45

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

10-
- **Rector** (automated code refactoring)
11-
- **Pint** (code styling)
12-
- **PHPStan** (static analysis)
13-
- **PestPHP** (testing framework)
9+
## Installation
1410

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
11+
Install the package as dev dependency:
12+
```
13+
composer require --dev codebuddyphp/codebuddy
2614
```
27-
This command sets up **Rector, PestPHP, Pint, and PHPStan** with standard configurations.
2815

29-
### Run CI Checks
30-
```sh
31-
php artisan codebuddy:ci [--fix]
16+
Publish the assets:
3217
```
33-
Runs tests, performs static analysis, and checks code style in a **dry-run mode** (does not modify files). Optimized for CI/CD pipelines.
18+
php artisan vendor:publish --provider="Codebuddyphp\Codebuddy\CodebuddyServiceProvider" --tag="codebuddy-config" --force
19+
```
20+
3421

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

37-
### Generate Code Quality Report
38-
```sh
39-
php artisan codebuddy:report [--show|--send-to=<email>]
24+
Configure essential tools (like Rector, Pint, Phpstan, Pest, etc):
25+
```
26+
php artisan cb:configure
4027
```
41-
- `--show`: Displays the overall code health report in the console.
42-
- `--send-to=<email>`: Sends the report to the specified email address.
4328

44-
---
29+
Find or fix codebase issues:
30+
```
31+
php artisan cb:review [--fix]
32+
```
4533

46-
This package simplifies code quality enforcement, making it easier to maintain a high standard across your Laravel projects.
34+
Get quick codebase insights:
35+
```
36+
php artisan cb:insights
37+
```

‎composer.json

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,43 @@
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",
10-
"larastan/larastan": "^3.0",
11-
"rector/rector": "^2.0"
9+
"laravel/framework": "^11|^12",
10+
"laravel/pint": "^1",
11+
"driftingly/rector-laravel": "^2",
12+
"larastan/larastan": "^3",
13+
"pestphp/pest": "^3"
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+
],
35+
"post-install-cmd": [
36+
"@php artisan vendor:publish --provider=\"Codebuddyphp\\Codebuddy\\CodebuddyServiceProvider\" --tag=\"codebuddy-config\" --force"
37+
],
38+
"post-update-cmd": [
39+
"@php artisan vendor:publish --provider=\"Codebuddyphp\\Codebuddy\\CodebuddyServiceProvider\" --tag=\"codebuddy-config\" --force"
40+
]
1941
},
2042
"extra": {
2143
"laravel": {
@@ -27,7 +49,10 @@
2749
}
2850
},
2951
"config": {
30-
"preferred-install": "dist"
52+
"preferred-install": "dist",
53+
"allow-plugins": {
54+
"pestphp/pest-plugin": true
55+
}
3156
},
3257
"minimum-stability": "dev",
3358
"prefer-stable": true

‎config/codebuddy.php

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
11
<?php
2+
3+
declare(strict_types=1);
4+
5+
return [
6+
'checks' => [
7+
'rector' => [
8+
'package' => 'driftingly/rector-laravel',
9+
'stub_file' => 'rector.php.stub',
10+
'config_file' => 'rector.php',
11+
'dry_run' => 'vendor/bin/rector process --dry-run --memory-limit=-1',
12+
'auto_fix' => 'vendor/bin/rector process --memory-limit=-1',
13+
'tags' => ['code-quality', 'auto-upgrades'],
14+
],
15+
'pint' => [
16+
'package' => 'laravel/pint',
17+
'stub_file' => 'pint.json.stub',
18+
'config_file' => 'pint.json',
19+
'dry_run' => 'vendor/bin/pint --test',
20+
'auto_fix' => 'vendor/bin/pint',
21+
'tags' => ['code-styling'],
22+
],
23+
'phpstan' => [
24+
'package' => 'larastan/larastan',
25+
'stub_file' => 'phpstan.neon.stub',
26+
'config_file' => 'phpstan.neon',
27+
'dry_run' => 'vendor/bin/phpstan analyse --memory-limit=-1',
28+
'auto_fix' => null,
29+
'tags' => ['static-analysis'],
30+
],
31+
'pest' => [
32+
'package' => 'pestphp/pest',
33+
'stub_file' => 'phpunit.xml.stub',
34+
'config_file' => 'phpunit.xml',
35+
'dry_run' => 'vendor/bin/pest --compact',
36+
'auto_fix' => null,
37+
'tags' => ['testing', 'unit-testing', 'feature-testing', 'mutation-testing'],
38+
],
39+
],
40+
'alerts' => [
41+
'slack' => [
42+
'webhook_url' => env('CODEBUDDY_SLACK_WEBHOOK_URL', ''),
43+
'channel' => '',
44+
'username' => null,
45+
'icon' => null,
46+
],
47+
],
48+
];

‎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: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,46 @@
33
namespace Codebuddyphp\Codebuddy;
44

55
use Codebuddyphp\Codebuddy\Commands\Configure;
6+
use Codebuddyphp\Codebuddy\Commands\Insights;
7+
use Codebuddyphp\Codebuddy\Commands\Review;
68
use Illuminate\Support\ServiceProvider;
79

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

15-
public function boot()
14+
public function boot(): void
1615
{
1716
if ($this->app->runningInConsole()) {
18-
$this->commands([
19-
Configure::class,
20-
]);
2117

22-
$this->publishes([
23-
__DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
24-
]);
18+
$this->commands(
19+
[
20+
Configure::class,
21+
Review::class,
22+
Insights::class,
23+
]
24+
);
25+
26+
$this->publishes(
27+
[
28+
__DIR__.'/../config/codebuddy.php' => config_path('codebuddy.php'),
29+
],
30+
'codebuddy-config'
31+
);
2532
}
33+
34+
$this->loadViewsFrom(__DIR__.'/../resources/views', 'codebuddy');
2635
}
2736

28-
public function provides()
37+
/**
38+
* @return array<string>
39+
*/
40+
public function provides(): array
2941
{
3042
return [
3143
Configure::class,
44+
Review::class,
45+
Insights::class,
3246
];
3347
}
34-
}
48+
}

0 commit comments

Comments
 (0)