Add PHPstan badge

Code docs improvements
alexeygeno · Aug 8, 2023 · 59a2635 · 59a2635
1 parent 0b5272f
commit 59a2635
Show file tree

Hide file tree

Showing 14 changed files with 19 additions and 18 deletions.
diff --git a/.github/workflows/php-stan.yml b/.github/workflows/php-stan.yml
@@ -1,4 +1,4 @@
-name: phpstan
+name: PHPStan
 
 on:
   push:

diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml
@@ -1,4 +1,4 @@
-name: pint
+name: Pint
 
 on:
   push:

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,4 +1,4 @@
-name: tests
+name: Tests
 
 on:
   push:

diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # Phone Verification via [Laravel Notification Channels](https://laravel-notification-channels.com/)
 
-[![Build Status](https://github.com/alexeygeno/phone-verification-laravel/workflows/tests/badge.svg)](https://github.com/alexeygeno/phone-verification-laravel/actions)
-[![Build Status](https://github.com/alexeygeno/phone-verification-laravel/workflows/pint/badge.svg)](https://github.com/alexeygeno/phone-verification-php/actions)
+[![Build Status](https://github.com/alexeygeno/phone-verification-laravel/workflows/Tests/badge.svg)](https://github.com/alexeygeno/phone-verification-laravel/actions)
+[![Build Status](https://github.com/alexeygeno/phone-verification-laravel/workflows/Pint/badge.svg)](https://github.com/alexeygeno/phone-verification-php/actions)
+[![Build Status](https://github.com/alexeygeno/phone-verification-laravel/workflows/PHPStan/badge.svg)](https://github.com/alexeygeno/phone-verification-php/actions)
 [![Coverage Status](https://coveralls.io/repos/github/alexeygeno/phone-verification-laravel/badge.svg)](https://coveralls.io/github/alexeygeno/phone-verification-laravel)
 
 

diff --git a/database/migrations/2023_07_31_101443_create_session_collection.php b/database/migrations/2023_07_31_101443_create_session_collection.php
@@ -7,7 +7,7 @@
 return new class extends Migration
 {
     /**
-     * Only mongodb migration.
+     * The name of the database connection to use.
      *
      * @var string
      */

diff --git a/database/migrations/2023_07_31_101508_create_session_index.php b/database/migrations/2023_07_31_101508_create_session_index.php
@@ -7,7 +7,7 @@
 return new class extends Migration
 {
     /**
-     * Only mongodb migration.
+     * The name of the database connection to use.
      *
      * @var string
      */

diff --git a/database/migrations/2023_07_31_142719_create_session_counter_collection.php b/database/migrations/2023_07_31_142719_create_session_counter_collection.php
@@ -7,7 +7,7 @@
 return new class extends Migration
 {
     /**
-     * Only mongodb migration.
+     * The name of the database connection to use.
      *
      * @var string
      */

diff --git a/database/migrations/2023_07_31_148301_create_session_counter_index.php b/database/migrations/2023_07_31_148301_create_session_counter_index.php
@@ -21,7 +21,7 @@ public function __construct()
     }
 
     /**
-     * Run the migrations.
+     * The name of the database connection to use.
      *
      * @return void
      */

diff --git a/src/Facades/PhoneVerification.php b/src/Facades/PhoneVerification.php
@@ -5,7 +5,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static mixed initiate(string $to)
+ * @method static \AlexGeno\PhoneVerification\Manager initiate(string $to)
  * @method static \AlexGeno\PhoneVerification\Manager complete(string $to, int $otp)
  */
 class PhoneVerification extends Facade

diff --git a/tests/Feature/CustomSenderTest.php b/tests/Feature/CustomSenderTest.php
@@ -10,7 +10,7 @@ class CustomSenderTest extends FeatureTestCase
     protected string $serviceProvider = CustomSenderServiceProvider::class;
 
     /**
-     * Tests if custom sender is resolved properly for the sender interface
+     * If a custom sender is resolved properly for the sender interface
      *
      * @return void
      */

diff --git a/tests/Feature/CustomStorageTest.php b/tests/Feature/CustomStorageTest.php
@@ -10,7 +10,7 @@ class CustomStorageTest extends FeatureTestCase
     protected string $serviceProvider = CustomStorageServiceProvider::class;
 
     /**
-     * Tests if custom storage is resolved properly for the storage interface
+     * If a custom storage is resolved properly for the storage interface
      *
      * @return void
      */

diff --git a/tests/Feature/IgnoreRoutesTest.php b/tests/Feature/IgnoreRoutesTest.php
@@ -14,7 +14,7 @@ protected function getEnvironmentSetUp($app)
     }
 
     /**
-     * Tests that the route phone-verification/initiate is not available
+     * If the route phone-verification/initiate is not available
      *
      * @return void
      */
@@ -25,7 +25,7 @@ public function test_initiation_not_available()
     }
 
     /**
-     * Tests that the route phone-verification/complete is not available
+     * If the route phone-verification/complete is not available
      *
      * @return void
      */

diff --git a/tests/Feature/UseRoutesTest.php b/tests/Feature/UseRoutesTest.php
@@ -11,7 +11,7 @@ class UseRoutesTest extends FeatureTestCase
     protected const LANG_MESSAGES = 'phone-verification::messages.';
 
     /**
-     * Tests the route phone-verification/initiate
+     * Test the route phone-verification/initiate
      *
      * @return void
      */
@@ -25,7 +25,7 @@ public function test_initiation_ok()
     }
 
     /**
-     * Tests the initiation rate limit
+     * Test the initiation rate limit
      *
      * @return void
      */
@@ -69,7 +69,7 @@ public function test_process_ok()
     }
 
     /**
-     * Tests the completion rate limit
+     * Test the completion rate limit
      *
      * @return void
      */

diff --git a/tests/Unit/SendersTest.php b/tests/Unit/SendersTest.php
@@ -22,7 +22,7 @@ public function channels()
     }
 
     /**
-     * Test if notification facade was called properly for different channels
+     * If notification facade was called properly for different channels
      *
      * @see https://laravel.com/docs/9.x/mocking#on-demand-notifications
      *