Change php-cs-fixer to laravel pint (#219)

Author: ucan-lab

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,15 @@
+name: Laravel Pint
+
+on: [pull_request]
+
+jobs:
+  pint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --prefer-dist --working-dir=tools/pint
+
+      - name: Laravel Pint Dry Run
+        run: ./tools/pint/vendor/bin/pint -v --test

.github/workflows/pint.yml

@@ -1,15 +1,9 @@
 composer-install-tools:
-	composer install --working-dir=tools/php-cs-fixer
+	composer install --working-dir=tools/pint
 	composer install --working-dir=tools/phpstan
-php-cs-version:
-	./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --version
-php-cs-dry:
-	./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --verbose --dry-run
-php-cs-dry-diff:
-	./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --verbose --diff --dry-run
-php-cs-fix:
-	./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --verbose
-phpstan:
+pint:
+	./tools/pint/vendor/bin/pint -v
+stan:
 	./tools/phpstan/vendor/bin/phpstan analyse -c phpstan.neon
 test:
 	./vendor/bin/phpunit

.php-cs-fixer.dist.php

@@ -0,0 +1,30 @@
+{
+    "preset": "laravel",
+    "exclude": [
+        "tests/Console/DacapoCommandTest"
+    ],
+    "rules": {
+        "concat_space": false,
+        "date_time_immutable": true,
+        "declare_parentheses": true,
+        "declare_strict_types": true,
+        "final_class": true,
+        "global_namespace_import": {
+            "import_classes": true,
+            "import_constants": true,
+            "import_functions": true
+        },
+        "mb_str_functions": true,
+        "no_superfluous_phpdoc_tags": true,
+        "not_operator_with_successor_space": true,
+        "phpdoc_align": {
+            "align": "left"
+        },
+        "phpdoc_separation": false,
+        "php_unit_test_case_static_method_calls": {
+            "call_type": "this"
+        },
+        "simplified_if_return": true,
+        "simplified_null_return": true
+    }
+}

Makefile

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace UcanLab\LaravelDacapo\Dacapo\Application\UseCase;
 
@@ -13,13 +15,6 @@
 
 final class DacapoCommandUseCase
 {
-    /**
-     * @param DatabaseSchemasStorage $databaseSchemasStorage
-     * @param DatabaseMigrationsStorage $databaseMigrationsStorage
-     * @param DatabaseDriver $databaseBuilder
-     * @param MigrationCreateStub $migrationCreateStub
-     * @param MigrationUpdateStub $migrationUpdateStub
-     */
     public function __construct(
         private DatabaseSchemasStorage $databaseSchemasStorage,
         private DatabaseMigrationsStorage $databaseMigrationsStorage,
@@ -29,9 +24,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return DacapoCommandUseCaseOutput
-     */
     public function handle(): DacapoCommandUseCaseOutput
     {
         $schemaList = $this->databaseSchemasStorage->getSchemaList();
@@ -46,7 +38,6 @@ public function handle(): DacapoCommandUseCaseOutput
     }
 
     /**
-     * @param SchemaList $schemaList
      * @return array<int, string>
      */
     private function generateCreateTableMigrationFile(SchemaList $schemaList): array
@@ -64,7 +55,6 @@ private function generateCreateTableMigrationFile(SchemaList $schemaList): array
     }
 
     /**
-     * @param SchemaList $schemaList
      * @return array<int, string>
      */
     private function generateCreateIndexMigrationFile(SchemaList $schemaList): array
@@ -84,7 +74,6 @@ private function generateCreateIndexMigrationFile(SchemaList $schemaList): array
     }
 
     /**
-     * @param SchemaList $schemaList
      * @return array<int, string>
      */
     private function generateConstraintForeignKeyMigrationFile(SchemaList $schemaList): array

pint.json

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace UcanLab\LaravelDacapo\Dacapo\Application\UseCase\Input;
 

src/Dacapo/Application/UseCase/DacapoCommandUseCase.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace UcanLab\LaravelDacapo\Dacapo\Application\UseCase\Output;
 

src/Dacapo/Application/UseCase/Input/DacapoCommandUseCaseInput.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace UcanLab\LaravelDacapo\Dacapo\Console;
 
@@ -30,9 +32,6 @@ final class DacapoClearCommand extends Command
      */
     protected $description = 'Clear migration directory.';
 
-    /**
-     * @param Filesystem $filesystem
-     */
     public function handle(Filesystem $filesystem): void
     {
         $this->newLine();

src/Dacapo/Application/UseCase/Output/DacapoCommandUseCaseOutput.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace UcanLab\LaravelDacapo\Dacapo\Console;
 
@@ -32,16 +34,13 @@ final class DacapoCommand extends Command
      */
     protected $description = 'Generate migrations from schemas and migrate:fresh command.';
 
-    /**
-     * @param DacapoCommandUseCase $useCase
-     */
     public function handle(
         DacapoCommandUseCase $useCase,
     ): void {
         $this->call('dacapo:clear', ['--force' => true]);
 
         $this->newLine();
-        $this->components->info( 'Generating migration files.');
+        $this->components->info('Generating migration files.');
 
         $output = $useCase->handle();