feat: add Laravel pint & prettier

.github/workflows/laravel.yml

@@ -2,62 +2,62 @@ name: Laravel
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   laravel-tests:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: '8.1'
-        coverage: pcov
-
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    - name: Copy .env
-      run: php -r "file_exists('.env') || copy('.env.example', '.env');"
-
-    - name: Install Dependencies
-      run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
-
-    - name: Generate key
-      run: php artisan key:generate
-
-    - name: Directory Permissions
-      run: chmod -R 777 storage bootstrap/cache
-
-    - name: Create Database
-      run: |
-        mkdir -p database
-        touch database/database.sqlite
-
-    - name: Execute tests (Unit and Feature tests) via PHPUnit
-      env:
-        DB_CONNECTION: sqlite
-        DB_DATABASE: database/database.sqlite
-      run: vendor/bin/phpunit --verbose --coverage-clover coverage.xml
-
-    - name: Upload Logs
-      if: failure()
-      uses: actions/upload-artifact@v3
-      with:
-        name: logs
-        path: storage/logs
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v2
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        file: ./coverage.xml
-        flags: tests
-        verbose: true
-        fail_ci_if_error: true
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          coverage: pcov
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Copy .env
+        run: php -r "file_exists('.env') || copy('.env.example', '.env');"
+
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: Generate key
+        run: php artisan key:generate
+
+      - name: Directory Permissions
+        run: chmod -R 777 storage bootstrap/cache
+
+      - name: Create Database
+        run: |
+          mkdir -p database
+          touch database/database.sqlite
+
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        env:
+          DB_CONNECTION: sqlite
+          DB_DATABASE: database/database.sqlite
+        run: vendor/bin/phpunit --verbose --coverage-clover coverage.xml
+
+      - name: Upload Logs
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: logs
+          path: storage/logs
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: tests
+          verbose: true
+          fail_ci_if_error: true
 
   build:
     runs-on: ubuntu-latest

.github/workflows/phpstan.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/pint.yml

@@ -0,0 +1,32 @@
+name: Laravel Pint
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - '**.php'
+
+permissions:
+  contents: write
+
+jobs:
+  laravel-pint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Fix PHP code style issues
+        uses: aglipanci/[email protected]
+        with:
+          useComposer: true
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: >
+            chore: styling
+

.prettierignore

@@ -0,0 +1,4 @@
+public
+vendor
+storage
+node_modules

.prettierrc

@@ -0,0 +1,19 @@
+{
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "sortTailwindcssClasses": true,
+    "sortHtmlAttributes": "code-guide",
+    "plugins": ["@shufo/prettier-plugin-blade"],
+    "overrides": [
+        {
+            "files": [
+                "*.blade.php"
+            ],
+            "options": {
+                "tabWidth": 4,
+                "parser": "blade"
+            }
+        }
+    ]
+}

app/Actions/Fortify/CreateNewUser.php

@@ -15,7 +15,6 @@ class CreateNewUser implements CreatesNewUsers
     /**
      * Validate and create a newly registered user.
      *
-     * @param  array  $input
      * @return \App\Models\User
      */
     public function create(array $input)

app/Actions/Fortify/ResetUserPassword.php

@@ -14,7 +14,6 @@ class ResetUserPassword implements ResetsUserPasswords
      * Validate and reset the user's forgotten password.
      *
      * @param  mixed  $user
-     * @param  array  $input
      * @return void
      */
     public function reset($user, array $input)

app/Actions/Fortify/UpdateUserPassword.php

@@ -14,7 +14,6 @@ class UpdateUserPassword implements UpdatesUserPasswords
      * Validate and update the user's password.
      *
      * @param  mixed  $user
-     * @param  array  $input
      * @return void
      */
     public function update($user, array $input)

app/Actions/Fortify/UpdateUserProfileInformation.php

@@ -13,7 +13,6 @@ class UpdateUserProfileInformation implements UpdatesUserProfileInformation
      * Validate and update the given user's profile information.
      *
      * @param  mixed  $user
-     * @param  array  $input
      * @return void
      */
     public function update($user, array $input)
@@ -43,7 +42,6 @@ public function update($user, array $input)
      * Update the given verified user's profile information.
      *
      * @param  mixed  $user
-     * @param  array  $input
      * @return void
      */
     protected function updateVerifiedUser($user, array $input)

app/Actions/Socialstream/CreateConnectedAccount.php

@@ -6,18 +6,12 @@
 use JoelButcher\Socialstream\ConnectedAccount;
 use JoelButcher\Socialstream\Contracts\CreatesConnectedAccounts;
 use JoelButcher\Socialstream\Socialstream;
-use Laravel\Socialite\AbstractUser;
 use Laravel\Socialite\Contracts\User as ProviderUser;
 
 class CreateConnectedAccount implements CreatesConnectedAccounts
 {
     /**
      * Create a connected account for a given user.
-     *
-     * @param Authenticatable $user
-     * @param string $provider
-     * @param ProviderUser $providerUser
-     * @return ConnectedAccount
      */
     public function create(Authenticatable $user, string $provider, ProviderUser $providerUser): ConnectedAccount
     {

app/Actions/Socialstream/CreateUserFromProvider.php

@@ -21,8 +21,6 @@ class CreateUserFromProvider implements CreatesUserFromProvider
 
     /**
      * Create a new action instance.
-     *
-     * @param  \JoelButcher\Socialstream\Contracts\CreatesConnectedAccounts  $createsConnectedAccounts
      */
     public function __construct(CreatesConnectedAccounts $createsConnectedAccounts)
     {
@@ -32,8 +30,6 @@ public function __construct(CreatesConnectedAccounts $createsConnectedAccounts)
     /**
      * Create a new user from a social provider user.
      *
-     * @param  string  $provider
-     * @param  \Laravel\Socialite\Contracts\User  $providerUser
      * @return \App\Models\User
      */
     public function create(string $provider, ProviderUser $providerUser)

app/Actions/Socialstream/HandleInvalidState.php

@@ -9,10 +9,6 @@ class HandleInvalidState implements HandlesInvalidState
 {
     /**
      * Handle an invalid state exception from a Socialite provider.
-     *
-     * @param  \Laravel\Socialite\Two\InvalidStateException  $exception
-     * @param  callable  $callback
-     * @return mixed
      */
     public function handle(InvalidStateException $exception, callable $callback = null): mixed
     {

app/Actions/Socialstream/ResolveSocialiteUser.php

@@ -19,7 +19,7 @@
         $user = Socialite::driver($provider)->user();
 
         if (Socialstream::generatesMissingEmails()) {
-            $user->email = $user->getEmail() ?? ("{$user->id}@{$provider}".config('app.domain'));
+            $user->email = $user->getEmail() ?? ("{$user->id}@{$provider}" . config('app.domain'));
         }
 
         return $user;

app/Actions/Socialstream/SetUserPassword.php

@@ -13,7 +13,6 @@ class SetUserPassword implements SetsUserPasswords
      * Validate and update the user's password.
      *
      * @param  mixed  $user
-     * @param  array  $input
      * @return void
      */
     public function set($user, array $input)

app/Actions/Socialstream/UpdateConnectedAccount.php

@@ -13,9 +13,6 @@ class UpdateConnectedAccount implements UpdatesConnectedAccounts
      * Update a given connected account.
      *
      * @param  mixed  $user
-     * @param  \JoelButcher\Socialstream\ConnectedAccount  $connectedAccount
-     * @param  string  $provider
-     * @param  \Laravel\Socialite\Contracts\User  $providerUser
      * @return \JoelButcher\Socialstream\ConnectedAccount
      */
     public function update($user, ConnectedAccount $connectedAccount, string $provider, User $providerUser)

app/Casts/Socials.php

@@ -15,11 +15,12 @@ class Socials implements CastsAttributes, SerializesCastableAttributes
     /**
      * Cast the given value.
      *
-     * @param Model $model
-     * @param string $key
-     * @param mixed $value
-     * @param array $attributes
+     * @param  Model  $model
+     * @param  string  $key
+     * @param  mixed  $value
+     * @param  array  $attributes
      * @return array<int, Social>
+     *
      * @throws \Spatie\DataTransferObject\Exceptions\UnknownProperties
      */
     public function get($model, $key, $value, $attributes)
@@ -31,7 +32,7 @@ public function get($model, $key, $value, $attributes)
                 $socials[] = new Social($social);
             }
         }
-        
+
         return $socials;
     }
 
@@ -40,7 +41,7 @@ public function get($model, $key, $value, $attributes)
      *
      * @param  Model  $model
      * @param  string  $key
-     * @param  Collection<int, Social>|array<int, Social> $value
+     * @param  Collection<int, Social>|array<int, Social>  $value
      * @param  array  $attributes
      * @return false|string
      */
@@ -63,10 +64,7 @@ public function set($model, $key, $value, $attributes)
      * Get the serialized representation of the value.
      *
      * @param  Model  $model
-     * @param  string  $key
      * @param  mixed  $value
-     * @param  array  $attributes
-     * @return mixed
      */
     public function serialize($model, string $key, $value, array $attributes): mixed
     {