Upgrading phpro/grumphp 0.17 to 0.18
Breakingv0.17.2 → v0.18.1Breaking1New3Changed4Fixed4Other6
BreakingUpgrade verdict
1 breaking change.
In plain terms
- Custom tasks must be updated: make getConfigurableOptions() static and change the service tag from config to task.
Must act 1 item needs code or config changes
What you must change
Breaking1
Improves the tasks system, requiring custom tasks to make getConfigurableOptions() static and use the task tag.
getConfigurableOptions()getConfiguration()getConfig()withConfig()EmptyTaskConfigTaskInterfaceAPI changes
Generated by DepDelta from published PHP source. Not mixed with prose notes.
- changed:
method TasksCollection.sortByPriority(GrumPHP $grumPHP): self → method TasksCollection.sortByPriority(): self
- added:
method GrumPHPPlugin.deactivate(Composer $composer, IOInterface $io) - added:
method GrumPHPPlugin.uninstall(Composer $composer, IOInterface $io)
- removed:
method GrumPHP.getRegisteredTasks(): array - removed:
method GrumPHP.getTaskConfiguration(string $taskName): array - removed:
method GrumPHP.getTaskMetadata($taskName): array - removed:
method GrumPHP.isBlockingTask(string $taskName): bool
- removed:
const TaskCompilerPass.TAG_GRUMPHP_TASK
- added:
class TaskConfigurator - added:
method TaskConfigurator.__invoke(TaskInterface $task, TaskConfigInterface $config): TaskInterface
- added:
class TaskConfigResolver - added:
constructor TaskConfigResolver(array $taskMap) - added:
method TaskConfigResolver.fetchByName(string $taskName): OptionsResolver - added:
method TaskConfigResolver.listAvailableTaskNames(): array - added:
method TaskConfigResolver.resolve(string $taskName, array $config): array
- removed:
protected property ConfigureCommand.config - changed:
constructor ConfigureCommand(GrumPHP $config, Filesystem $filesystem, Paths $paths) → constructor ConfigureCommand(TaskConfigResolver $taskConfigResolver, Filesystem $filesystem, Paths $paths)
- added:
class TaskConfigResolverException extends RuntimeException - added:
static method TaskConfigResolverException.deprectatedTask(string $taskName): self - added:
static method TaskConfigResolverException.unknownClass(string $class): self - added:
static method TaskConfigResolverException.unknownTask(string $task): self
- removed:
method TaskRunner.addTask(TaskInterface $task): void - removed:
method TaskRunner.getTasks() - changed:
constructor TaskRunner(GrumPHP $grumPHP, EventDispatcherInterface $eventDispatcher) → constructor TaskRunner(TasksCollection $tasks, GrumPHP $grumPHP, EventDispatcherInterface $eventDispatcher)
- removed:
method AbstractExternalTask.getConfiguration(): array - removed:
method AbstractLinterTask.getConfiguration(): array - removed:
method AbstractParserTask.getConfiguration(): array - removed:
method AbstractPhpCsFixerTask.getConfiguration(): array - removed:
method Ant.getName(): string - removed:
method Atoum.getName(): string - removed:
method Behat.getName(): string - removed:
method Brunch.getName(): string - removed:
method CloverCoverage.getConfiguration(): array - removed:
method CloverCoverage.getName(): string - removed:
method Codeception.getName(): string - removed:
method Composer.getName(): string - removed:
method ComposerNormalize.getName(): string - removed:
method ComposerRequireChecker.getName(): string - removed:
method ComposerScript.getName(): string - removed:
method Deptrac.getName(): string - removed:
method DoctrineOrm.getName(): string - removed:
method Ecs.getName(): string - removed:
method FileSize.getConfiguration(): array - removed:
method FileSize.getName(): string - removed:
method Gherkin.getName(): string - removed:
method Grunt.getName(): string - removed:
method Gulp.getName(): string - removed:
method Infection.getName(): string - removed:
method JsonLint.getName(): string - removed:
method Kahlan.getName(): string - removed:
method Make.getName(): string - removed:
method NpmScript.getName(): string - removed:
method Paratest.getName(): string - removed:
method Phan.getName(): string - removed:
method Phing.getName(): string - removed:
method Php7cc.getName(): string - removed:
method PhpCpd.getName(): string - removed:
method PhpCsFixer.getName(): string - removed:
method PhpCsFixerV2.getName(): string - removed:
method PhpLint.getName(): string - removed:
method PhpMd.getName(): string - removed:
method PhpMnd.getName(): string - removed:
method PhpParser.getName(): string - removed:
method PhpStan.getName(): string - removed:
method PhpVersion.getConfiguration(): array - removed:
method PhpVersion.getName(): string - removed:
method Phpcs.getName(): string - removed:
method Phpspec.getName(): string - removed:
method Phpunit.getName(): string - removed:
method PhpunitBridge.getName(): string - removed:
method Progpilot.getName(): string - removed:
method Psalm.getName(): string - removed:
method Robo.getName(): string - removed:
method SecurityChecker.getName(): string - removed:
method Shell.getName(): string - removed:
method TaskInterface.getConfiguration(): array - removed:
method TaskInterface.getName(): string - removed:
method TwigCs.getName(): string - removed:
method XmlLint.getName(): string - removed:
method YamlLint.getName(): string - removed:
protected property AbstractExternalTask.grumPHP - removed:
protected property AbstractLinterTask.grumPHP - removed:
protected property AbstractParserTask.grumPHP - removed:
protected property AbstractPhpCsFixerTask.grumPHP - removed:
protected property CloverCoverage.filesystem - removed:
protected property CloverCoverage.grumPHP - removed:
protected property FileSize.grumPHP - changed:
constructor AbstractExternalTask(GrumPHP $grumPHP, ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter) → constructor AbstractExternalTask(ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter) - changed:
constructor AbstractLinterTask(GrumPHP $grumPHP, LinterInterface $linter) → constructor AbstractLinterTask(LinterInterface $linter) - changed:
constructor AbstractParserTask(GrumPHP $grumPHP, ParserInterface $parser) → constructor AbstractParserTask(ParserInterface $parser) - changed:
constructor AbstractPhpCsFixerTask(GrumPHP $grumPHP, ProcessBuilder $processBuilder, AsyncProcessRunner $processRunner, PhpCsFixerFormatter $formatter) → constructor AbstractPhpCsFixerTask(ProcessBuilder $processBuilder, AsyncProcessRunner $processRunner, PhpCsFixerFormatter $formatter) - changed:
constructor CloverCoverage(GrumPHP $grumPHP, Filesystem $filesystem) → constructor CloverCoverage(Filesystem $filesystem) - changed:
constructor Composer(GrumPHP $grumPHP, ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter, Filesystem $filesystem) → constructor Composer(ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter, Filesystem $filesystem) - changed:
constructor FileSize(GrumPHP $grumPHP) → constructor FileSize() - changed:
constructor PhpVersion(GrumPHP $grumPHP, PhpVersionUtility $phpVersionUtility) → constructor PhpVersion(PhpVersionUtility $phpVersionUtility) - changed:
method AbstractLinterTask.getConfigurableOptions(): OptionsResolver → static method AbstractLinterTask.getConfigurableOptions(): OptionsResolver - changed:
method AbstractParserTask.getConfigurableOptions(): OptionsResolver → static method AbstractParserTask.getConfigurableOptions(): OptionsResolver - changed:
method Ant.getConfigurableOptions(): OptionsResolver → static method Ant.getConfigurableOptions(): OptionsResolver - changed:
method Atoum.getConfigurableOptions(): OptionsResolver → static method Atoum.getConfigurableOptions(): OptionsResolver - changed:
method Behat.getConfigurableOptions(): OptionsResolver → static method Behat.getConfigurableOptions(): OptionsResolver - changed:
method Brunch.getConfigurableOptions(): OptionsResolver → static method Brunch.getConfigurableOptions(): OptionsResolver - changed:
method CloverCoverage.getConfigurableOptions(): OptionsResolver → static method CloverCoverage.getConfigurableOptions(): OptionsResolver - changed:
method Codeception.getConfigurableOptions(): OptionsResolver → static method Codeception.getConfigurableOptions(): OptionsResolver - changed:
method Composer.getConfigurableOptions(): OptionsResolver → static method Composer.getConfigurableOptions(): OptionsResolver - changed:
method ComposerNormalize.getConfigurableOptions(): OptionsResolver → static method ComposerNormalize.getConfigurableOptions(): OptionsResolver - changed:
method ComposerRequireChecker.getConfigurableOptions(): OptionsResolver → static method ComposerRequireChecker.getConfigurableOptions(): OptionsResolver - changed:
method ComposerScript.getConfigurableOptions(): OptionsResolver → static method ComposerScript.getConfigurableOptions(): OptionsResolver - changed:
method Deptrac.getConfigurableOptions(): OptionsResolver → static method Deptrac.getConfigurableOptions(): OptionsResolver - changed:
method DoctrineOrm.getConfigurableOptions(): OptionsResolver → static method DoctrineOrm.getConfigurableOptions(): OptionsResolver - changed:
method Ecs.getConfigurableOptions(): OptionsResolver → static method Ecs.getConfigurableOptions(): OptionsResolver - changed:
method FileSize.getConfigurableOptions(): OptionsResolver → static method FileSize.getConfigurableOptions(): OptionsResolver - changed:
method Gherkin.getConfigurableOptions(): OptionsResolver → static method Gherkin.getConfigurableOptions(): OptionsResolver - changed:
method Grunt.getConfigurableOptions(): OptionsResolver → static method Grunt.getConfigurableOptions(): OptionsResolver - changed:
method Gulp.getConfigurableOptions(): OptionsResolver → static method Gulp.getConfigurableOptions(): OptionsResolver - changed:
method Infection.getConfigurableOptions(): OptionsResolver → static method Infection.getConfigurableOptions(): OptionsResolver - changed:
method JsonLint.getConfigurableOptions(): OptionsResolver → static method JsonLint.getConfigurableOptions(): OptionsResolver - changed:
method Kahlan.getConfigurableOptions(): OptionsResolver → static method Kahlan.getConfigurableOptions(): OptionsResolver - changed:
method Make.getConfigurableOptions(): OptionsResolver → static method Make.getConfigurableOptions(): OptionsResolver - changed:
method NpmScript.getConfigurableOptions(): OptionsResolver → static method NpmScript.getConfigurableOptions(): OptionsResolver - changed:
method Paratest.getConfigurableOptions(): OptionsResolver → static method Paratest.getConfigurableOptions(): OptionsResolver - changed:
method Phan.getConfigurableOptions(): OptionsResolver → static method Phan.getConfigurableOptions(): OptionsResolver - changed:
method Phing.getConfigurableOptions(): OptionsResolver → static method Phing.getConfigurableOptions(): OptionsResolver - changed:
method Php7cc.getConfigurableOptions(): OptionsResolver → static method Php7cc.getConfigurableOptions(): OptionsResolver - changed:
method PhpCpd.getConfigurableOptions(): OptionsResolver → static method PhpCpd.getConfigurableOptions(): OptionsResolver - changed:
method PhpCsFixer.getConfigurableOptions(): OptionsResolver → static method PhpCsFixer.getConfigurableOptions(): OptionsResolver - changed:
method PhpCsFixerV2.getConfigurableOptions(): OptionsResolver → static method PhpCsFixerV2.getConfigurableOptions(): OptionsResolver - changed:
method PhpLint.getConfigurableOptions(): OptionsResolver → static method PhpLint.getConfigurableOptions(): OptionsResolver - changed:
method PhpMd.getConfigurableOptions(): OptionsResolver → static method PhpMd.getConfigurableOptions(): OptionsResolver - changed:
method PhpMnd.getConfigurableOptions(): OptionsResolver → static method PhpMnd.getConfigurableOptions(): OptionsResolver - changed:
method PhpParser.getConfigurableOptions(): OptionsResolver → static method PhpParser.getConfigurableOptions(): OptionsResolver - changed:
method PhpStan.getConfigurableOptions(): OptionsResolver → static method PhpStan.getConfigurableOptions(): OptionsResolver - changed:
method PhpVersion.getConfigurableOptions(): OptionsResolver → static method PhpVersion.getConfigurableOptions(): OptionsResolver - changed:
method Phpcs.getConfigurableOptions(): OptionsResolver → static method Phpcs.getConfigurableOptions(): OptionsResolver - changed:
method Phpspec.getConfigurableOptions(): OptionsResolver → static method Phpspec.getConfigurableOptions(): OptionsResolver - changed:
method Phpunit.getConfigurableOptions(): OptionsResolver → static method Phpunit.getConfigurableOptions(): OptionsResolver - changed:
method PhpunitBridge.getConfigurableOptions(): OptionsResolver → static method PhpunitBridge.getConfigurableOptions(): OptionsResolver - changed:
method Progpilot.getConfigurableOptions(): OptionsResolver → static method Progpilot.getConfigurableOptions(): OptionsResolver - changed:
method Psalm.getConfigurableOptions(): OptionsResolver → static method Psalm.getConfigurableOptions(): OptionsResolver - changed:
method Robo.getConfigurableOptions(): OptionsResolver → static method Robo.getConfigurableOptions(): OptionsResolver - changed:
method SecurityChecker.getConfigurableOptions(): OptionsResolver → static method SecurityChecker.getConfigurableOptions(): OptionsResolver - changed:
method Shell.getConfigurableOptions(): OptionsResolver → static method Shell.getConfigurableOptions(): OptionsResolver - changed:
method TaskInterface.getConfigurableOptions(): OptionsResolver → static method TaskInterface.getConfigurableOptions(): OptionsResolver - changed:
method TwigCs.getConfigurableOptions(): OptionsResolver → static method TwigCs.getConfigurableOptions(): OptionsResolver - changed:
method XmlLint.getConfigurableOptions(): OptionsResolver → static method XmlLint.getConfigurableOptions(): OptionsResolver - changed:
method YamlLint.getConfigurableOptions(): OptionsResolver → static method YamlLint.getConfigurableOptions(): OptionsResolver - added:
method AbstractExternalTask.getConfig(): TaskConfigInterface - added:
method AbstractExternalTask.withConfig(TaskConfigInterface $config): TaskInterface - added:
method AbstractLinterTask.getConfig(): TaskConfigInterface - added:
method AbstractLinterTask.withConfig(TaskConfigInterface $config): TaskInterface - added:
method AbstractParserTask.getConfig(): TaskConfigInterface - added:
method AbstractParserTask.withConfig(TaskConfigInterface $config): TaskInterface - added:
method AbstractPhpCsFixerTask.getConfig(): TaskConfigInterface - added:
method AbstractPhpCsFixerTask.withConfig(TaskConfigInterface $config): TaskInterface - added:
method CloverCoverage.getConfig(): TaskConfigInterface - added:
method CloverCoverage.withConfig(TaskConfigInterface $config): TaskInterface - added:
method FileSize.getConfig(): TaskConfigInterface - added:
method FileSize.withConfig(TaskConfigInterface $config): TaskInterface - added:
method PhpVersion.getConfig(): TaskConfigInterface - added:
method PhpVersion.withConfig(TaskConfigInterface $config): TaskInterface - added:
method TaskInterface.getConfig(): TaskConfigInterface - added:
method TaskInterface.withConfig(TaskConfigInterface $config): TaskInterface - added:
protected property AbstractExternalTask.config - added:
protected property AbstractLinterTask.config - added:
protected property AbstractParserTask.configuration - added:
protected property AbstractPhpCsFixerTask.config
- added:
class EmptyTaskConfig implements TaskConfigInterface - added:
class LazyTaskConfig implements TaskConfigInterface - added:
class Metadata - added:
class TaskConfig implements TaskConfigInterface - added:
constructor LazyTaskConfig(callable $configFactory) - added:
constructor Metadata(array $metadata) - added:
constructor TaskConfig(string $name, array $options, Metadata $metadata) - added:
interface TaskConfigInterface - added:
method EmptyTaskConfig.getMetadata(): Metadata - added:
method EmptyTaskConfig.getName(): string - added:
method EmptyTaskConfig.getOptions(): array - added:
method LazyTaskConfig.getMetadata(): Metadata - added:
method LazyTaskConfig.getName(): string - added:
method LazyTaskConfig.getOptions(): array - added:
method Metadata.isBlocking(): bool - added:
method Metadata.label(): string - added:
method Metadata.priority(): int - added:
method Metadata.task(): string - added:
method Metadata.toArray(): array - added:
method TaskConfig.getMetadata(): Metadata - added:
method TaskConfig.getName(): string - added:
method TaskConfig.getOptions(): array - added:
method TaskConfigInterface.getMetadata(): Metadata - added:
method TaskConfigInterface.getName(): string - added:
method TaskConfigInterface.getOptions(): array - added:
static method Metadata.getConfigurableOptions(): OptionsResolver
- removed:
method Blacklist.getName(): string - removed:
method BranchName.getConfiguration(): array - removed:
method BranchName.getName(): string - removed:
method CommitMessage.getConfiguration(): array - removed:
method CommitMessage.getName(): string - removed:
protected property BranchName.grumPHP - removed:
protected property BranchName.repository - changed:
constructor Blacklist(GrumPHP $grumPHP, ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter, IOInterface $IO) → constructor Blacklist(ProcessBuilder $processBuilder, ProcessFormatterInterface $formatter, IOInterface $IO) - changed:
constructor BranchName(GrumPHP $grumPHP, GitRepository $repository) → constructor BranchName(GitRepository $repository) - changed:
constructor CommitMessage(GrumPHP $grumPHP) → constructor CommitMessage() - changed:
method Blacklist.getConfigurableOptions(): OptionsResolver → static method Blacklist.getConfigurableOptions(): OptionsResolver - changed:
method BranchName.getConfigurableOptions(): OptionsResolver → static method BranchName.getConfigurableOptions(): OptionsResolver - changed:
method CommitMessage.getConfigurableOptions(): OptionsResolver → static method CommitMessage.getConfigurableOptions(): OptionsResolver - added:
method BranchName.getConfig(): TaskConfigInterface - added:
method BranchName.withConfig(TaskConfigInterface $config): TaskInterface - added:
method CommitMessage.getConfig(): TaskConfigInterface - added:
method CommitMessage.withConfig(TaskConfigInterface $config): TaskInterface