opensource/filament
3
0
Fork 0
mirror of https://github.com/filamentphp/filament.git synced 2026-09-24 15:42:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

clean up

Browse Source
This commit is contained in:
Dan Harrin
2025-08-12 09:43:17 +01:00
parent 356fb45134
commit 94e031ad5f
3 changed files with 151 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/01-introduction/02-installation.md
-28
View File
@@ -38,20 +38,6 @@ Installation comes in two flavors, depending on whether you want to build an app
## Installing the panel builder
Since Filament v4 is in beta, you will need to set the `minimum-stability` in your `composer.json` file to be `beta` before installing any packages. Either adjust it manually or via CLI:
```bash
composer config minimum-stability beta
```
Your `composer.json` should look like this:
```json
{
"minimum-stability": "beta"
}
```
Install the Filament Panel Builder by running the following commands in your Laravel project directory:
```bash
@@ -94,20 +80,6 @@ Open `/admin` in your web browser, sign in, and [start building your app](../get
## Installing the individual components
Since Filament v4 is in beta, you will need to set the `minimum-stability` in your `composer.json` file to be `beta` before installing any packages. Either adjust it manually or via CLI:
```bash
composer config minimum-stability beta
```
Your `composer.json` should look like this:
```json
{
"minimum-stability": "beta"
}
```
Install the Filament components you want to use with Composer:
```bash
docs/14-upgrade-guide.md
+35 -19
View File
@@ -23,26 +23,20 @@ import Disclosure from "@components/Disclosure.astro"
The upgrade script is not a replacement for the upgrade guide. It handles many small changes that are not mentioned in the upgrade guide, but it does not handle all breaking changes. You should still read the [manual upgrade steps](#breaking-changes-that-must-be-handled-manually) to see what changes you need to make to your code.
</Aside>
The first step to upgrade your Filament app is to run the automated upgrade script. Since Filament v4 is in beta, you will need to set the `minimum-stability` in your `composer.json` file to be `beta` before installing any packages. Either adjust it manually or via CLI:
<Aside variant="info">
Some plugins you're using may not be available in v4 just yet. You could temporarily remove them from your `composer.json` file until they've been upgraded, replace them with a similar plugins that are v4-compatible, wait for the plugins to be upgraded before upgrading your app, or even write PRs to help the authors upgrade them.
</Aside>
```bash
composer config minimum-stability beta
```
Your `composer.json` should look like this:
```json
{
"minimum-stability": "beta"
}
```
This script will automatically upgrade your application to the latest version of Filament and make changes to your code, which handles most breaking changes:
The first step to upgrade your Filament app is to run the automated upgrade script. This script will automatically upgrade your application to the latest version of Filament and make changes to your code, which handles most breaking changes:
```bash
composer require filament/upgrade:"^4.0" -W --dev
vendor/bin/filament-v4
# Run the commands output by the upgrade script, they are unique to your app
composer require filament/filament:"^4.0" -W --no-update
composer update
```
<Aside variant="warning">
@@ -52,6 +46,10 @@ vendor/bin/filament-v4
composer require filament/upgrade:"~4.0" -W --dev
vendor/bin/filament-v4
# Run the commands output by the upgrade script, they are unique to your app
composer require filament/filament:"^4.0" -W --no-update
composer update
```
</Aside>
@@ -61,12 +59,18 @@ vendor/bin/filament-v4
Make sure to carefully follow the instructions, and review the changes made by the script. You may need to make some manual changes to your code afterwards, but the script should handle most of the repetitive work for you.
You can now `composer remove filament/upgrade` as you don't need it anymore.
Filament v4 introduces a new default directory structure for your Filament resources and clusters. If you are using Filament panels with resources and clusters, you can choose to keep the old directory structure, or migrate to the new one. If you want to migrate to the new directory structure, you can run the following command:
<Aside variant="info">
Some plugins you're using may not be available in v4 just yet. You could temporarily remove them from your `composer.json` file until they've been upgraded, replace them with a similar plugins that are v4-compatible, wait for the plugins to be upgraded before upgrading your app, or even write PRs to help the authors upgrade them.
```bash
php artisan filament:upgrade-directory-structure-to-v4
```
<Aside variant="warning">
This directory upgrade script is not able to perfectly update any references to classes in the same namespace that were present in resource and cluster files, and those references will need to be updated manually after the script has run. You should use tools like [PHPStan](https://phpstan.org) to identify references to classes that are broken after the upgrade.
</Aside>
You can now `composer remove filament/upgrade` as you don't need it anymore.
## Publishing the configuration file
Some changes in Filament v4 can be reverted using the configuration file. If you haven't published the configuration file yet, you can do so by running the following command:
@@ -102,8 +106,8 @@ return [
'flags' => [
FileGenerationFlag::EMBEDDED_PANEL_RESOURCE_SCHEMAS, // Define new forms and infolists inside the resource class instead of a separate schema class.
FileGenerationFlag::EMBEDDED_PANEL_RESOURCE_TABLES, // Define new tables inside the resource class instead of a separate table class.
FileGenerationFlag::PANEL_CLUSTER_CLASSES_OUTSIDE_DIRECTORIES, // Create new cluster classes outside of their directories.
FileGenerationFlag::PANEL_RESOURCE_CLASSES_OUTSIDE_DIRECTORIES, // Create new resource classes outside of their directories.
FileGenerationFlag::PANEL_CLUSTER_CLASSES_OUTSIDE_DIRECTORIES, // Create new cluster classes outside of their directories. Not required if you run `php artisan filament:upgrade-directory-structure-to-v4`.
FileGenerationFlag::PANEL_RESOURCE_CLASSES_OUTSIDE_DIRECTORIES, // Create new resource classes outside of their directories. Not required if you run `php artisan filament:upgrade-directory-structure-to-v4`.
FileGenerationFlag::PARTIAL_IMPORTS, // Partially import components such as form fields and table columns instead of importing each component explicitly.
],
],
@@ -113,6 +117,18 @@ return [
]
```
<Aside variant="tip">
The `filament/upgrade` package includes a command to help you move panel resources and clusters to the new directory structure, which is the default in v4:
```bash
php artisan filament:upgrade-directory-structure-to-v4
```
This directory upgrade script is not able to perfectly update any references to classes in the same namespace that were present in resource and cluster files, and those references will need to be updated manually after the script has run. You should use tools like [PHPStan](https://phpstan.org) to identify references to classes that are broken after the upgrade.
Once you have run the command, you do not need to keep the `FileGenerationFlag::PANEL_CLUSTER_CLASSES_OUTSIDE_DIRECTORIES` or `FileGenerationFlag::PANEL_RESOURCE_CLASSES_OUTSIDE_DIRECTORIES` flags in your configuration file, as the new directory structure is now the default. You can remove them from the `file_generation.flags` array.
</Aside>
## Breaking changes that must be handled manually
<div x-data="{ packages: ['panels', 'forms', 'infolists', 'tables', 'actions', 'notifications', 'widgets', 'support'] }">
packages/upgrade/src/Commands/UpgradeDirectoryStructureToV4Command.php
+116 -104
View File
@@ -2,10 +2,13 @@
namespace Filament\Upgrade\Commands;
use Exception;
use ReflectionClass;
use RuntimeException;
use Filament\Facades\Filament;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Process;
use Illuminate\Support\Str;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputOption;
@@ -19,6 +22,13 @@ class UpgradeDirectoryStructureToV4Command extends Command
protected string $phpactorPath;
/**
* @var array<string, array<string, string>>
*/
protected array $movedFiles = [];
protected ?string $currentResource = null;
/**
* @return array<InputOption>
*/
@@ -34,52 +44,71 @@ class UpgradeDirectoryStructureToV4Command extends Command
];
}
protected function formatPath(string $path): string
{
return str_replace(base_path() . '/', '', $path);
}
public function handle(): int
{
$isDryRun = $this->option('dry-run');
if ($isDryRun) {
$this->info('Running in dry-run mode. No changes will be made.');
// Ask for confirmation if not in dry-run mode
if (! $isDryRun && ! $this->components->confirm('This command will modify your Filament resources and clusters to match the new v4 directory structure. Please commit any changes you have made to your project before continuing. Do you want to continue?', default: true)) {
$this->components->info('Migration cancelled.');
return self::FAILURE;
}
$this->info('Starting migration from Filament v3 to v4...');
$this->components->info('Starting migration from Filament v3 to v4...');
if ($isDryRun) {
$this->newLine();
$this->components->info('Running in dry-run mode. No changes will be made.');
$this->newLine();
}
// Step 1: Download phpactor if it doesn't exist (skip in dry-run mode)
if (! $isDryRun) {
$this->downloadPhpactor();
} else {
$this->info('[DRY RUN] Would download phpactor to vendor/bin/phpactor.phar');
$this->phpactorPath = base_path('vendor/bin/phpactor.phar');
}
// Step 2: Get all panels
$panels = Filament::getPanels();
$this->info('Found ' . count($panels) . ' panel(s)');
foreach ($panels as $panel) {
$this->info('Processing panel: ' . $panel->getId());
// Step 3: Get all resources for this panel
$resources = $panel->getResources();
$this->info('Found ' . count($resources) . ' resource(s) in panel');
foreach ($resources as $resourceClass) {
$this->processResource($resourceClass, $isDryRun);
if (count($resources) > 0) {
$this->components->info('Processing resources in ' . $panel->getId() . ' panel');
foreach ($resources as $resourceClass) {
$this->processResource($resourceClass, $isDryRun);
}
$this->newLine();
}
// Step 4: Get all clusters for this panel
$clusters = $panel->getClusters();
$this->info('Found ' . count($clusters) . ' cluster(s) in panel');
foreach ($clusters as $clusterClass) {
$this->processCluster($clusterClass, $isDryRun);
if (count($clusters) > 0) {
$this->components->info('Processing resources in ' . $panel->getId() . ' panel');
foreach ($clusters as $clusterClass) {
$this->processCluster($clusterClass, $isDryRun);
}
$this->newLine();
}
}
if ($isDryRun) {
$this->info('Dry run completed. Run without --dry-run to apply changes.');
$this->components->info('Dry run completed. Run without --dry-run to apply changes.');
} else {
$this->info('Migration completed successfully!');
$this->components->info('Migration completed successfully!');
}
return self::SUCCESS;
@@ -90,26 +119,25 @@ class UpgradeDirectoryStructureToV4Command extends Command
$this->phpactorPath = base_path('vendor/bin/phpactor.phar');
if (File::exists($this->phpactorPath)) {
$this->info('Phpactor already exists at: ' . $this->phpactorPath);
$this->components->info('Phpactor already exists at: ' . $this->formatPath($this->phpactorPath));
return;
}
$this->info('Downloading phpactor...');
$process = Process::fromShellCommandline(
'curl -Lo ' . $this->phpactorPath . ' https://github.com/phpactor/phpactor/releases/latest/download/phpactor.phar'
);
$process->run();
$this->components->task('Downloading phpactor', function () {
$process = Process::command(
'curl -Lo ' . $this->phpactorPath . ' https://github.com/phpactor/phpactor/releases/latest/download/phpactor.phar'
);
$process = $process->run();
if (! $process->isSuccessful()) {
$this->error('Failed to download phpactor: ' . $process->getErrorOutput());
if (! $process->successful()) {
$this->error('Failed to download phpactor: ' . $process->errorOutput());
throw new RuntimeException('Failed to download phpactor');
}
throw new RuntimeException('Failed to download phpactor');
}
// Make phpactor executable
chmod($this->phpactorPath, 0755);
$this->info('Phpactor downloaded successfully to: ' . $this->phpactorPath);
// Make phpactor executable
chmod($this->phpactorPath, 0755);
return true;
});
}
/**
@@ -117,31 +145,27 @@ class UpgradeDirectoryStructureToV4Command extends Command
*/
protected function processResource(string $resourceClass, bool $isDryRun = false): void
{
$this->info('Processing resource: ' . $resourceClass);
// Get the base path for the resource
$resourceReflection = new ReflectionClass($resourceClass);
$resourcePath = $resourceReflection->getFileName();
if ($resourcePath === false) {
$this->warn("Could not get file path for resource: {$resourceClass}");
$this->components->warn("Could not get file path for resource: {$resourceClass}");
return;
}
// Skip if the resource is in vendor directory
if ($this->isVendorPath($resourcePath)) {
$this->warn("Skipping resource in vendor directory: {$resourcePath}");
$this->components->warn("Skipping resource in vendor directory");
return;
}
$resourceNamespace = $resourceReflection->getNamespaceName();
$resourceBaseName = class_basename($resourceClass);
// Extract directory information
$resourceDir = dirname($resourcePath);
// Set the current resource being processed
$this->currentResource = $resourceBaseName;
// Determine the new directory name (pluralized)
$resourceName = str_replace('Resource', '', $resourceBaseName);
$pluralizedName = Str::plural($resourceName);
@@ -151,13 +175,10 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Skip if the new resource directory would be in vendor
if ($this->isVendorPath($newResourceDir)) {
$this->warn("Skipping resource with destination in vendor directory: {$newResourceDir}");
$this->components->warn("Skipping resource with destination in vendor directory");
return;
}
$this->info("Resource will be moved from {$resourceDir} to {$newResourceDir}");
// Find all related classes
$this->findAndMoveRelatedClasses($resourceClass, $resourceDir, $newResourceDir, $resourceBaseName, $isDryRun);
@@ -171,31 +192,27 @@ class UpgradeDirectoryStructureToV4Command extends Command
*/
protected function processCluster(string $clusterClass, bool $isDryRun = false): void
{
$this->info('Processing cluster: ' . $clusterClass);
// Get the base path for the cluster
$clusterReflection = new ReflectionClass($clusterClass);
$clusterPath = $clusterReflection->getFileName();
if ($clusterPath === false) {
$this->warn("Could not get file path for cluster: {$clusterClass}");
$this->components->warn("Could not get file path for cluster: {$clusterClass}");
return;
}
// Skip if the cluster is in vendor directory
if ($this->isVendorPath($clusterPath)) {
$this->warn("Skipping cluster in vendor directory: {$clusterPath}");
$this->components->warn("Skipping cluster in vendor directory");
return;
}
$clusterNamespace = $clusterReflection->getNamespaceName();
$clusterBaseName = class_basename($clusterClass);
// Extract directory information
$clusterDir = dirname($clusterPath);
// Set the current resource being processed (in this case, a cluster)
$this->currentResource = $clusterBaseName;
// Determine if the cluster name ends with "Cluster"
$endsWithCluster = Str::endsWith($clusterBaseName, 'Cluster');
@@ -212,26 +229,14 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Skip if the new cluster directory would be in vendor
if ($this->isVendorPath($newClusterDir)) {
$this->warn("Skipping cluster with destination in vendor directory: {$newClusterDir}");
$this->components->warn("Skipping cluster with destination in vendor directory");
return;
}
$this->info("Cluster will be moved from {$clusterDir} to {$newClusterDir}");
// Create the new directory if it doesn't exist
if (! $isDryRun && ! File::exists($newClusterDir)) {
File::makeDirectory($newClusterDir, 0755, true);
} elseif ($isDryRun && ! File::exists($newClusterDir)) {
$this->info("[DRY RUN] Would create directory: {$newClusterDir}");
}
// Move the cluster class
$newClusterPath = $newClusterDir . '/' . $newClusterBaseName . '.php';
$this->moveClass($clusterPath, $newClusterPath, $isDryRun);
// Note: We don't process any other files for clusters as they are already in the correct place
$this->info('Cluster processed successfully. No other files were moved as they are already in the correct place.');
}
protected function findAndMoveRelatedClasses(string $resourceClass, string $resourceDir, string $newResourceDir, string $resourceBaseName, bool $isDryRun = false): void
@@ -239,8 +244,6 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Find all PHP files in the resource directory and subdirectories
$files = $this->findPhpFiles($resourceDir);
$this->info('Found ' . count($files) . ' file(s) in resource directory');
$relatedFiles = [];
foreach ($files as $file) {
// Skip the resource file itself, we'll handle it separately
@@ -251,16 +254,12 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Only process files that are related to this resource
// Check if the file path contains the resource basename directory
if (strpos($file, $resourceDir . '/' . $resourceBaseName) === false) {
$this->info("Skipping file not related to {$resourceBaseName}: {$file}");
continue;
}
$relatedFiles[] = $file;
}
$this->info('Found ' . count($relatedFiles) . ' related file(s) for resource ' . $resourceBaseName);
foreach ($relatedFiles as $file) {
// Determine the new path for this file
$relativePath = str_replace($resourceDir, '', $file);
@@ -276,13 +275,6 @@ class UpgradeDirectoryStructureToV4Command extends Command
$newPath = $newResourceDir . $relativePath;
// Ensure the directory exists
$newDir = dirname($newPath);
if (! $isDryRun && ! File::exists($newDir)) {
File::makeDirectory($newDir, 0755, true);
} elseif ($isDryRun && ! File::exists($newDir)) {
$this->info("[DRY RUN] Would create directory: {$newDir}");
}
// Move the class
$this->moveClass($file, $newPath, $isDryRun);
@@ -313,8 +305,6 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Skip if the directory is in vendor
if ($this->isVendorPath($directory)) {
$this->warn("Skipping vendor directory: {$directory}");
return $files;
}
@@ -325,8 +315,6 @@ class UpgradeDirectoryStructureToV4Command extends Command
// Skip files in vendor directory
if ($this->isVendorPath($pathname)) {
$this->info("Skipping vendor file: {$pathname}");
continue;
}
@@ -342,48 +330,72 @@ class UpgradeDirectoryStructureToV4Command extends Command
{
// Safety check: Never touch files in the vendor directory
if ($this->isVendorPath($sourcePath)) {
$this->warn("Skipping file in vendor directory: {$sourcePath}");
$this->components->warn("Skipping file in vendor directory");
return;
}
if ($this->isVendorPath($destinationPath)) {
$this->warn("Skipping move to vendor directory: {$destinationPath}");
$this->components->warn("Skipping move to vendor directory");
return;
}
// Ensure the destination directory exists
$destinationDir = dirname($destinationPath);
if (! $isDryRun && ! File::exists($destinationDir)) {
File::makeDirectory($destinationDir, 0755, true);
} elseif ($isDryRun && ! File::exists($destinationDir)) {
$this->info("[DRY RUN] Would create directory: {$destinationDir}");
}
if ($isDryRun) {
$this->info("[DRY RUN] Would move class from {$sourcePath} to {$destinationPath}");
// Display resource grouping information in real-time for dry runs
// If this is the first file for this resource, display the resource heading
if ($this->currentResource && (!isset($this->movedFiles[$this->currentResource]) || empty($this->movedFiles[$this->currentResource]))) {
$this->line(' <fg=yellow;options=bold>' . $this->currentResource . '</>');
$this->movedFiles[$this->currentResource] = [];
} elseif (!$this->currentResource && (!isset($this->movedFiles['Other']) || empty($this->movedFiles['Other']))) {
$this->line(' <fg=yellow;options=bold>Other</>');
$this->movedFiles['Other'] = [];
}
// Display the file move information with proper indentation
$this->line(' • ' . $this->formatPath($sourcePath) . ' → ' . $this->formatPath($destinationPath));
// Track the file for resource grouping
if ($this->currentResource) {
$this->movedFiles[$this->currentResource][$sourcePath] = $destinationPath;
} else {
$this->movedFiles['Other'][$sourcePath] = $destinationPath;
}
return;
}
$this->info("Moving class from {$sourcePath} to {$destinationPath}");
try {
// Use phpactor to move the class
$process = Process::fromShellCommandline(
$process = Process::command(
"php {$this->phpactorPath} class:move {$sourcePath} {$destinationPath}"
);
$process->setTimeout(60); // Give it a minute to complete
$process->run();
$process->timeout(60); // Give it a minute to complete
$process = $process->run();
if ($process->isSuccessful()) {
$this->info("Successfully moved class from {$sourcePath} to {$destinationPath}");
if ($process->successful()) {
// Display resource grouping information in real-time for actual moves
// If this is the first file for this resource, display the resource heading
if ($this->currentResource && (!isset($this->movedFiles[$this->currentResource]) || empty($this->movedFiles[$this->currentResource]))) {
$this->line(' <fg=yellow;options=bold>' . $this->currentResource . '</>');
$this->movedFiles[$this->currentResource] = [];
} elseif (!$this->currentResource && (!isset($this->movedFiles['Other']) || empty($this->movedFiles['Other']))) {
$this->line(' <fg=yellow;options=bold>Other</>');
$this->movedFiles['Other'] = [];
}
// Display the file move information with proper indentation
$this->line(' • ' . $this->formatPath($sourcePath) . ' → ' . $this->formatPath($destinationPath));
// Track the file for resource grouping
if ($this->currentResource) {
$this->movedFiles[$this->currentResource][$sourcePath] = $destinationPath;
} else {
$this->movedFiles['Other'][$sourcePath] = $destinationPath;
}
} else {
$this->error('Failed to move class: ' . $process->getErrorOutput());
$this->components->error('Failed to move class: ' . $process->errorOutput());
}
} catch (Exception $exception) {
$this->error('Exception occurred while moving class: ' . $exception->getMessage());
$this->components->error('Exception occurred while moving class: ' . $exception->getMessage());
}
}
}