[13.x] Consolidate Artisan command $name/getArguments()/getOptions() into $signature

[lucasmichot]

Summary

• Adds characterization tests f681028 that record every Artisan command's name, aliases, arguments, and options. These tests pass both before and after the refactor commit, so the conversion does not change behavior.
• Converts commands from the separate $name + getArguments()/getOptions() style to the single $signature string.

Excluded commands

These commands keep the old array-based style, because each has an option whose value is required, and the $signature DSL can only make option values optional. Supporting required values would need a ! marker in the signature DSL, which was proposed but not merged in #60888:

• migrate:rollback (--batch)
• make:component (--path)
• dev:list (--filter)
• make:controller (--type)

[github-actions]

Thanks for submitting a PR!

Note that draft PRs are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface.

Pull requests that are abandoned in draft may be closed due to inactivity.

[stancl]

FWIW this might be a breaking change, see archtechx/tenancy#1474

I'm not sure if extending a Laravel command and overriding just $name is sanctioned by Laravel's backwards compatibility guarantees, it might just be too low level and something userland code and packages have to carry the responsibility for, however I wouldn't be surprised if our this did break things in more packages and applications than just our Tenancy package.

Assuming we can migrate to $signature and support both Laravel <13.24.0 and >=13.24.0, the fix shouldn't be too difficult in classes that extend Laravel commands. If for any reason that wouldn't work though we'd have to perhaps have separate command classes for different Laravel versions. Will post an update.

Update: Managed to do just a conditional if (version_compare(...)) $this->signature = ...; else $this->name = ... in a constructor.

[lucasmichot]

Isn't Command::configure done especially for that ?
cf. archtechx/tenancy#1478

[fgibaux]

it looks like this change breaks the migrate command when using the schema loader.

I'm used to call artisan db:wipe --env=testing && artisan migrate --seed -v --env=testing and it's failing in 13.24.0

EDIT: it's actually because we're using https://github.com/jlorente/laravel-data-migrations which extends Illuminate\Database\Console\Migrations\InstallCommand while overriding $name and not $signature. it makes it register itself as the migrate:install command instead of the Laravel one.

sorry for the noise

[noefleury]

Breaking change if we extend one of these command and override getOptions().

Custom options will just be ignored as we now use $signature instead of $name.

Solution : move custom options inside $signature declaration.

[lucasmichot]

If you're extending one of these commands, the proper way is overriding configure() and adding the option there with $this->getDefinition()->addOption(...) - that runs after the parent's definition is built regardless of whether the parent uses $name/getOptions() or $signature, so it survives refactors like this one either way. Editing $signature only works if you own the whole command. Example: archtechx/tenancy#1478