Filament Modules for Laravel

To use the module management features, register the ModulesPlugin within your Filament Panel provider using the plugin() method.

public function panel(Panel $panel): Panel
{
    return $panel
        ->default()
        ->id('app')
        // ... other configuration
        ->plugin(\Coolsam\Modules\ModulesPlugin::make());
}

$panel->plugin(\Coolsam\Modules\ModulesPlugin::make());

The installation behavior (specifically whether a default Filament Plugin is created) is controlled by the filament-modules.mode configuration setting.

This setting uses the Coolsam\Modules\Enums\ConfigMode enum. The command checks this value to determine if it should call module:filament:plugin automatically.

To find all Filament Cluster namespaces within a module, use getModuleClusters(string $moduleName).

This method scans the module's Filament/Clusters directory for files matching the pattern */*Cluster.php and returns an array of their fully qualified class namespaces.

$clusterNamespaces = $modules->getModuleClusters('my-module');

The execCommand(string $command, ?Command $artisan = null) method allows you to run shell commands. If an Artisan command instance is provided, the output is piped to $artisan->info(); otherwise, it is echoed directly to the standard output.

$modules->execCommand('php artisan module:make Blog');

If you have a file path and need to know which module it belongs to, use findModuleNameForPath(string $path).

The method traverses up the directory tree from the provided path until it finds a module.json file. It returns the name defined in that JSON file, or falls back to the directory name if the JSON is not an array.

$moduleName = $modules->findModuleNameForPath('/path/to/Modules/Blog/src/Models/Post.php');
// returns 'blog' or the name from module.json

The getMode() method retrieves the current configuration mode from the filament-modules.mode config key. It returns an instance of Coolsam\Modules\Enums\ConfigMode (or null if not set).

$mode = $modules->getMode(); // Returns ConfigMode enum

The FilamentModules facade provides a convenient proxy to the underlying Coolsam\Modules\Modules class. You can use this facade to interact with the core module management logic within your Laravel application without needing to resolve the Modules class manually from the service container.

use Coolsam\Modules\Facades\FilamentModules;

// Example usage (actual methods depend on the Modules class implementation)
$modules = FilamentModules::someMethod();

You can retrieve all Filament Panel instances belonging to a specific module using getModulePanels(string $moduleName).

The method scans the module's Providers/Filament directory for classes ending in *PanelProvider.php. It then filters the application's registered Filament panels to return only those whose IDs match the generated kebab-case pattern: {module-kebab-name}-{panel-provider-name}.

/** @return Panel[] */
$panels = $modules->getModulePanels('my-module');

The module:make:filament-theme command accepts the following arguments and options:

Example usage with Yarn:

php artisan module:make:filament-theme Blog --pm=yarn

# Using npm (default)
php artisan module:make:filament-theme Blog

# Using yarn
php artisan module:make:filament-theme Blog --pm=yarn

# Overwriting existing files
php artisan module:make:filament-theme Blog --force