Refactor DocBlocks for clarity

composer.json

@@ -1,78 +1,78 @@
 {
-  "name": "nwidart/laravel-modules",
-  "description": "Laravel Module management",
-  "keywords": [
-    "modules",
-    "laravel",
-    "nwidart",
-    "module",
-    "rad"
-  ],
-  "license": "MIT",
-  "authors": [
-    {
-      "name": "Nicolas Widart",
-      "email": "[email protected]",
-      "homepage": "https://nicolaswidart.com",
-      "role": "Developer"
-    }
-  ],
-  "require": {
-    "php": ">=8.2",
-    "ext-dom": "*",
-    "ext-json": "*",
-    "ext-simplexml": "*",
-    "wikimedia/composer-merge-plugin": "^2.1"
-  },
-  "require-dev": {
-    "phpunit/phpunit": "^11.0",
-    "mockery/mockery": "^1.6",
-    "orchestra/testbench": "^v9.0",
-    "friendsofphp/php-cs-fixer": "^v3.52",
-    "laravel/framework": "^v11.33",
-    "laravel/pint": "^1.16",
-    "spatie/phpunit-snapshot-assertions": "^5.0",
-    "phpstan/phpstan": "^1.4"
-  },
-  "autoload": {
-    "psr-4": {
-      "Nwidart\\Modules\\": "src"
+    "name": "nwidart/laravel-modules",
+    "description": "Laravel Module management",
+    "keywords": [
+        "modules",
+        "laravel",
+        "nwidart",
+        "module",
+        "rad"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Nicolas Widart",
+            "email": "[email protected]",
+            "homepage": "https://nicolaswidart.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "ext-dom": "*",
+        "ext-json": "*",
+        "ext-simplexml": "*",
+        "wikimedia/composer-merge-plugin": "^2.1"
     },
-    "files": [
-      "src/helpers.php"
-    ]
-  },
-  "autoload-dev": {
-    "psr-4": {
-      "Nwidart\\Modules\\Tests\\": "tests",
-      "Modules\\Recipe\\": "tests/stubs/valid/Recipe"
-    }
-  },
-  "extra": {
-    "laravel": {
-      "providers": [
-        "Nwidart\\Modules\\LaravelModulesServiceProvider"
-      ],
-      "aliases": {
-        "Module": "Nwidart\\Modules\\Facades\\Module"
-      }
+    "require-dev": {
+        "phpunit/phpunit": "^11.0",
+        "mockery/mockery": "^1.6",
+        "orchestra/testbench": "^v9.0",
+        "friendsofphp/php-cs-fixer": "^v3.52",
+        "laravel/framework": "^v11.33",
+        "laravel/pint": "^1.16",
+        "spatie/phpunit-snapshot-assertions": "^5.0",
+        "phpstan/phpstan": "^1.4"
     },
-    "branch-alias": {
-      "dev-master": "11.0-dev"
-    }
-  },
-  "config": {
-    "allow-plugins": {
-      "wikimedia/composer-merge-plugin": true
-    }
-  },
-  "scripts": {
-    "update-snapshots": "./phpunit --no-coverage -d --update-snapshots",
-    "lint": "pint",
-    "test": "phpunit",
-    "test-coverage": "phpunit --coverage-html coverage",
-    "pcf": "vendor/bin/php-cs-fixer fix --verbose"
-  },
-  "minimum-stability": "dev",
-  "prefer-stable": true
+    "autoload": {
+        "psr-4": {
+            "Nwidart\\Modules\\": "src"
+        },
+        "files": [
+            "src/helpers.php"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Nwidart\\Modules\\Tests\\": "tests",
+            "Modules\\Recipe\\": "tests/stubs/valid/Recipe"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Nwidart\\Modules\\LaravelModulesServiceProvider"
+            ],
+            "aliases": {
+                "Module": "Nwidart\\Modules\\Facades\\Module"
+            }
+        },
+        "branch-alias": {
+            "dev-master": "11.0-dev"
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "wikimedia/composer-merge-plugin": true
+        }
+    },
+    "scripts": {
+        "update-snapshots": "phpunit --no-coverage -d --update-snapshots",
+        "lint": "pint",
+        "test": "phpunit",
+        "test-coverage": "phpunit --coverage-html coverage",
+        "pcf": "vendor/bin/php-cs-fixer fix --verbose"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

config/config.php

@@ -44,7 +44,7 @@
             'vite' => ['LOWER_NAME', 'STUDLY_NAME', 'KEBAB_NAME'],
             'json' => ['LOWER_NAME', 'STUDLY_NAME', 'KEBAB_NAME', 'MODULE_NAMESPACE', 'PROVIDER_NAMESPACE'],
             'views/index' => ['LOWER_NAME'],
-            'views/master' => ['LOWER_NAME', 'STUDLY_NAME', 'KEBAB_NAME',],
+            'views/master' => ['LOWER_NAME', 'STUDLY_NAME', 'KEBAB_NAME'],
             'scaffold/config' => ['STUDLY_NAME'],
             'composer' => [
                 'LOWER_NAME',

src/Activators/FileActivator.php

@@ -13,31 +13,23 @@ class FileActivator implements ActivatorInterface
 {
     /**
      * Laravel Filesystem instance
-     *
-     * @var Filesystem
      */
-    private $files;
+    private Filesystem $files;
 
     /**
      * Laravel config instance
-     *
-     * @var Config
      */
-    private $config;
+    private Config $config;
 
     /**
      * Array of modules activation statuses
-     *
-     * @var array
      */
-    private $modulesStatuses;
+    private array $modulesStatuses;
 
     /**
      * File used to store activation statuses
-     *
-     * @var string
      */
-    private $statusesFile;
+    private string $statusesFile;
 
     public function __construct(Container $app)
     {
@@ -149,8 +141,6 @@ private function readJson(): array
 
     /**
      * Reads a config parameter under the 'activators.file' key
-     *
-     * @return mixed
      */
     private function config(string $key, $default = null)
     {

src/Collection.php

@@ -9,20 +9,16 @@ class Collection extends BaseCollection
 {
     /**
      * Get items collections.
-     *
-     * @return array
      */
-    public function getItems()
+    public function getItems(): array
     {
         return $this->items;
     }
 
     /**
      * Get the collection of items as a plain array.
-     *
-     * @return array
      */
-    public function toArray()
+    public function toArray(): array
     {
         return array_map(function ($value) {
             if ($value instanceof Module) {

src/Commands/Actions/CheckLangCommand.php

@@ -98,7 +98,7 @@ private function getDirectories($module)
 
     private function checkMissingFiles(Collection $directories)
     {
-        //show missing files
+        // show missing files
         $missingFilesMessage = [];
 
         $uniqeLangFiles = $directories->pluck('files')->flatten()->unique()->values();
@@ -135,7 +135,7 @@ private function checkMissingFiles(Collection $directories)
 
     private function checkMissingKeys(Collection $directories)
     {
-        //show missing keys
+        // show missing keys
         $uniqeLangFiles = $directories->pluck('files')->flatten()->unique();
         $langDirectories = $directories->pluck('name');
 

src/Commands/Database/SeedCommand.php

@@ -102,14 +102,14 @@ public function moduleSeed(Module $module)
                 }
             }
         } else {
-            $class = $this->getSeederName($name); //legacy support
+            $class = $this->getSeederName($name); // legacy support
 
             $class = implode('\\', array_map('ucwords', explode('\\', $class)));
 
             if (class_exists($class)) {
                 $seeders[] = $class;
             } else {
-                //look at other namespaces
+                // look at other namespaces
                 $classes = $this->getSeederNames($name);
                 foreach ($classes as $class) {
                     if (class_exists($class)) {

src/Commands/UpdatePhpunitCoverage.php

@@ -23,30 +23,31 @@ class UpdatePhpunitCoverage extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return int
      */
     public function handle(): int
     {
         $appFolder = config('modules.paths.app_folder', 'app/');
-        $appFolder = rtrim($appFolder, '/') . '/';
+        $appFolder = rtrim($appFolder, '/').'/';
         $phpunitXmlPath = base_path('phpunit.xml');
         $modulesStatusPath = base_path('modules_statuses.json');
 
-        if (!file_exists($phpunitXmlPath)) {
+        if (! file_exists($phpunitXmlPath)) {
             $this->error("phpunit.xml file not found: {$phpunitXmlPath}");
+
             return 100;
         }
 
-        if (!file_exists($modulesStatusPath)) {
+        if (! file_exists($modulesStatusPath)) {
             $this->error("Modules statuses file not found: {$modulesStatusPath}");
+
             return 99;
         }
 
         $enabledModules = json_decode(file_get_contents($modulesStatusPath), true);
 
         if (json_last_error() !== JSON_ERROR_NONE) {
-            $this->error("Error decoding JSON from {$modulesStatusPath}: " . json_last_error_msg());
+            $this->error("Error decoding JSON from {$modulesStatusPath}: ".json_last_error_msg());
+
             return 98;
         }
 
@@ -55,15 +56,13 @@ public function handle(): int
 
         foreach ($enabledModules as $module => $status) {
             if ($status) { // Only add enabled modules
-                $moduleDir = $modulesPath . $module . '/' . $appFolder;
+                $moduleDir = $modulesPath.$module.'/'.$appFolder;
                 if (is_dir($moduleDir)) {
                     $moduleDirs[] = $moduleDir;
                 }
             }
         }
 
-
-
         $phpunitXml = simplexml_load_file($phpunitXmlPath);
 
         $sourceInclude = $phpunitXml->xpath('//source/include')[0];
@@ -77,13 +76,13 @@ public function handle(): int
             $directory->addAttribute('suffix', '.php');
         }
 
-        $dom = new DOMDocument();
+        $dom = new DOMDocument;
         $dom->preserveWhiteSpace = false;
         $dom->formatOutput = true;
         $dom->loadXML($phpunitXml->asXML());
         $dom->save($phpunitXmlPath);
 
-        $this->info("phpunit.xml updated with enabled module directories.");
+        $this->info('phpunit.xml updated with enabled module directories.');
 
         return 0;
     }

src/Contracts/ConfirmableCommand.php

@@ -2,6 +2,4 @@
 
 namespace Nwidart\Modules\Contracts;
 
-interface ConfirmableCommand
-{
-}
+interface ConfirmableCommand {}

src/Contracts/PublisherInterface.php

@@ -6,8 +6,6 @@ interface PublisherInterface
 {
     /**
      * Publish something.
-     *
-     * @return mixed
      */
     public function publish();
 }