feat: #32 pint

Author: shaunthegeek

.github/workflows/laravel-11.yml

@@ -30,6 +30,7 @@ jobs:
         run: |
           ./vendor/bin/phpcs --standard=PSR12 src/ tests/
           ./vendor/bin/phpmd . text src/stubs/phpmd.xml
+          ./vendor/bin/pint --test --config src/stubs/pint.json
       -
         name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4

README.md

@@ -17,7 +17,7 @@ composer require --dev laravel-fans/lint
 php artisan lint:publish
 ```
 
-You will find `phpcs.xml` and `phpmd.xml` in your project, feel free to change it.
+You will find `pint.json`, `phpcs.xml` and `phpmd.xml` in your project, feel free to change it.
 
 ## usage
 
@@ -35,15 +35,16 @@ php artisan lint:code
 php artisan lint:code --fix
 php artisan lint:code app/ tests/
 php artisan lint:code app/ tests/ --fix
+php artisan lint:pint
 php artisan lint:phpcs
 php artisan lint:pmd
 php artisan lint:staged
 ```
 
-### lint route URI
+### lint route
 
 ```shell
 php artisan lint:route
 ```
 
-Slug(kebab-case) standard: lowercase ASCII letters, digits, and hyphens (a-z, 0–9, -)
+Slug(kebab-case) URI standard: lowercase ASCII letters, digits, and hyphens (a-z, 0–9, -)

composer.json

@@ -31,6 +31,7 @@
     "require": {
         "ext-json": "*",
         "illuminate/support": ">=v9",
+        "laravel/pint": ">=v1",
         "phpmd/phpmd": ">=2.10",
         "squizlabs/php_codesniffer": ">=3.5"
     },

src/LintCodeCommand.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\File;
 
 class LintCodeCommand extends Command
 {

src/LintCommand.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\File;
 
 class LintCommand extends Command
 {
@@ -34,7 +32,15 @@ public function handle()
         $code = $this->call('lint:phpcs', [
             'files' => $this->argument('files'), '--fix' => $this->option('fix')
         ]);
+        if ($this->option('fix')) {
+            $code = $this->call('lint:pint', [
+                'files' => $this->argument('files'), '--repair' => true
+            ]);
+        }
         if (!$this->option('fix')) {
+            $code = $this->call('lint:pint', [
+                'files' => $this->argument('files'), '--test' => true
+            ]);
             $code += $this->call('lint:pmd', [
                 'files' => $this->argument('files')
             ]);

src/LintPhpcsCommand.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\File;
 
 class LintPhpcsCommand extends Command
 {

src/LintPintCommand.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use Illuminate\Console\Command;
+
+class LintPintCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'lint:pint
+        {--test}
+        {--repair}
+        {--config=pint.json}
+        {files?*}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Lint by pint';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $files = empty($this->argument('files')) ? ['.'] : $this->argument('files');
+        $command = "vendor" . DIRECTORY_SEPARATOR . "bin" . DIRECTORY_SEPARATOR . "pint";
+        $command .= " --config=" . $this->option('config');
+        if ($this->option('test')) {
+            $command .= ' --test';
+        }
+        if ($this->option('repair')) {
+            $command .= ' --repair';
+        }
+        exec(
+            $command . ' ' . implode(' ', $files),
+            $output,
+            $code
+        );
+        foreach ($output as $line) {
+            $this->line($line);
+        }
+        return $code;
+    }
+}

src/LintPmdCommand.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\File;
 
 class LintPmdCommand extends Command
 {

src/LintPublishCommand.php

@@ -30,6 +30,9 @@ public function handle()
     {
         $basePath = $this->laravel->basePath();
 
+        if (!File::exists($basePath . '/pint.json')) {
+            File::copy(__DIR__ . '/stubs/pint.json', $basePath . '/pint.json');
+        }
         if (!File::exists($basePath . '/phpcs.xml')) {
             File::copy(__DIR__ . '/stubs/phpcs.xml', $basePath . '/phpcs.xml');
         }

src/LintServiceProvider.php

@@ -17,6 +17,7 @@ public function boot()
             $this->commands([
                 LintCommand::class,
                 LintCodeCommand::class,
+                LintPintCommand::class,
                 LintPmdCommand::class,
                 LintPhpcsCommand::class,
                 LintPublishCommand::class,

src/LintStagedCommand.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\File;
 
 class LintStagedCommand extends Command
 {

src/stubs/git-pre-commit

@@ -2,6 +2,8 @@
 
 FILES=$(git diff --diff-filter=d --name-only HEAD | { grep '.php$' || true; })
 for file in $FILES; do
+  ./vendor/bin/phpcs --config=pint.json --repair "$file"
+  ./vendor/bin/phpcbf --extensions=php --standard=phpcs.xml "$file"
   ./vendor/bin/phpcs --extensions=php --standard=phpcs.xml "$file"
   ./vendor/bin/phpmd "$file" text phpmd.xml
 done

src/stubs/pint.json

@@ -0,0 +1,3 @@
+{
+    "preset": "psr12"
+}

tests/LintPhpcsCommandTest.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint\Tests;
 
-use Illuminate\Support\Facades\File;
 use phpmock\MockBuilder;
-use phpmock\functions\FixedValueFunction;
 
 class LintPhpcsCommandTest extends TestCase
 {

tests/LintPintCommandTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace LaravelFans\Lint\Tests;
+
+use phpmock\MockBuilder;
+
+class LintPintCommandTest extends TestCase
+{
+    public function testLintPintWithoutArgs()
+    {
+        $builder = new MockBuilder();
+        $builder->setNamespace('\\LaravelFans\\Lint')
+            ->setName("exec")
+            ->setFunction(
+                function ($command, &$output, &$code) {
+                    $this->assertEquals("vendor/bin/pint --config=pint.json .", $command);
+                    $output = [];
+                    $code = 0;
+                }
+            );
+        $mock = $builder->build();
+        $mock->enable();
+        $this->artisan('lint:pint')->assertExitCode(0);
+        $mock->disable();
+    }
+}

tests/LintPmdCommandTest.php

@@ -2,9 +2,7 @@
 
 namespace LaravelFans\Lint\Tests;
 
-use Illuminate\Support\Facades\File;
 use phpmock\MockBuilder;
-use phpmock\functions\FixedValueFunction;
 
 class LintPmdCommandTest extends TestCase
 {

tests/LintPublishCommandTest.php

@@ -21,6 +21,7 @@ public function testGitExists()
         $laravelPath = __DIR__ . '/../vendor/orchestra/testbench-core/laravel';
         File::makeDirectory($laravelPath . '/.git/hooks/', 0755, true);
         $this->artisan('lint:publish')->run();
+        $this->assertFileExists($laravelPath . '/pint.json');
         $this->assertFileExists($laravelPath . '/phpcs.xml');
         $this->assertFileExists($laravelPath . '/phpmd.xml');
         $this->assertFileExists($laravelPath . '/.git/hooks/pre-commit');