Merge pull request datamweb#8 from datamweb/add-cs-fixer

chore: add the code quality tools of `cs-fixer`

Author: datamweb

.gitignore

@@ -0,0 +1,8 @@
+vendor/
+build/
+phpunit*.xml
+phpunit
+*.cache
+composer.lock
+.DS_Store
+.idea/

.php-cs-fixer.dist.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Shield OAuth.
+ *
+ * (c) Datamweb <pooya_parsa_dadashi@yahoo.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+use CodeIgniter\CodingStandard\CodeIgniter4;
+use Nexus\CsConfig\Factory;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
+    ->files()
+    ->in([
+        __DIR__ . '/src/',
+        // __DIR__ . '/tests/',
+    ])
+    ->exclude('build')
+    ->append([__FILE__]);
+
+$overrides = [
+    'declare_strict_types' => true,
+    'void_return'          => true,
+];
+
+$options = [
+    'finder'    => $finder,
+    'cacheFile' => '.php-cs-fixer.cache',
+];
+
+return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(
+    'Shield OAuth',
+    'Datamweb',
+    'pooya_parsa_dadashi@yahoo.com'
+);

admin/pre-commit

@@ -0,0 +1,17 @@
+#!/bin/sh
+if [ "$FILES" != "" ]; then
+    echo "Running PHP CS Fixer..."
+
+    if [ -d /proc/cygdrive ]; then
+        ./vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
+    else
+        php ./vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
+    fi
+
+    if [ $? != 0 ]; then
+        echo "Some files are not following the coding standards. Please fix them before commit (try 'composer style')."
+        exit 1
+    fi
+fi
+
+exit $?

admin/setup.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# Install a pre-commit hook that
+# automatically runs phpcs to fix styles
+cp admin/pre-commit .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit

composer.json

@@ -20,6 +20,8 @@
         }
     ],
     "homepage": "https://github.com/datamweb/shield-oauth",
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "require": {
         "php": "^7.4.3 || ^8.0 || ^8.1",
         "codeigniter4/shield": "dev-develop"
@@ -43,6 +45,18 @@
             "Tests\\Support\\": "tests/_support"
         }
     },
+    "scripts": {
+        "post-update-cmd": [
+            "bash admin/setup.sh"
+        ],
+        "ci": [
+            "Composer\\Config::disableProcessTimeout",
+            "@cs"
+        ],
+        "cs": "php-cs-fixer fix --ansi --verbose --dry-run --diff",
+        "cs-fix": "php-cs-fixer fix --ansi --verbose --diff",
+        "style": "@cs-fix"
+    },
     "support": {
         "forum": "https://github.com/datamweb/shield-oauth/discussions",
         "source": "https://github.com/datamweb/shield-oauth",