vaimo/composer-patches

Fix

• patches not applied when dealing with requires that use dev branches (even when version available in package config or when dev branch aliased as proper version)

Links: src diff

Feature

• added --brief to list command (skips over description, etc)
• when using --filter or targeting a specific package with 'redo', 'undo' or 'apply', show only those patches that match with the filter; other patches still applied, just not reported (all actions can still be made visible when using --explicit flag)
• show information about patches that are removed (when patches are re-applied, show which items were applied, but no longer listed/queued)

Fix

• rework on fix done in 3.37.1 for patches that applied half-way while 'patch' command still returned SUCCESS exit code; perform patch command dry-apply output analysis to detect edge-cases that should be considered as failures
• the command 'list' listing removals even when --filter used
• the command 'list' --excluded option not properly dealing with filter when --filter used
• the command 'list' not listing removals when every patch against some package gets removed
• the command 'list' always listing removed items, even when they do not match with used filter
• allow both 'undo' and 'redo' command to finish even when there are errors encountered while re-applying some patches (bundled patches might get re-applied; encountered when doing partial/targeted command call); suppress environment flags that tell otherwise (apply still stops on first failure when required)
• queue resolver re-introducing undo'd patches when patches targeting a package that had bundled patches defined against it
• show all applied patches when running 'redo' command without a filter (otherwise only matched patches are shown)
• hide NEW patches (that might be failing) when doing filtered redo/undo calls to avoid too much noise in output where it's pretty clear that developer is working with a sub-selection of patches (all shown when doing explicit call)
• composer lock still modified when applying patches (leaves empty EXTRA key behind where there previously wasn't one present)

Links: src diff

Feature

• hide all information on previously applied patches by default (when patches for certain package are re-applied) and only show the ones that changed, are new or got matches with a filter (--explicit flag added for commands to use old output that shows every patch that gets re-applied)

Fix

• rollback to fix in 3.37.1 (caused errors for patches that created new files, new solution needed)

Links: src diff

Fix

• some patches that patched multiple files applied only half-way through on certain OS's without returning with proper exit code on failure (or failed hunks considered as ignoreable junk)

Links: src diff

Feature

• new flag introduced for patch:list to allow including patches that have been ruled out due to mismatch with certain constraint: --excluded

Fix

• embedded targeting info for bundled patches that declares constrains not processed correctly (@depends,@version)

Links: src diff

Feature

• allow '@type bundle' to be used for bundle package instead of using somewhat cryptic '@package *'
• allow multiple types to be combined in embedded info (@type dev+bundle)

Fix

• multi-line description not presented properly when using composer patch:list command
• bundled patches not included as expected when using embedded patch target info

Links: src diff

Fix

• backwards compatibility problems with composer.lock contents for projects that upgraded to latest releases of the plugin and had patches previously applied (boolean values for patches_applied no longer tolerated)

Links: src diff

Fix

• lock management reworked (again) to make sure that under no circumstances does the plugin crash while sanitizing the lock

Links: src diff

Fix

• lock management reworked to use built-in methods for locating a package to avoid issues with potential aliases, etc

Links: src diff

Feature

• list command added (allows listing all registered patches and their state)

Fix

• bundled patch targets not properly reset when using patch:redo in case patches applied on packages, but installed.json reset to provide no information about applied patches
• patches for packages that are covered with certain bundle patch do not get re-applied when running patch:redo with filter (redo should not leave any patch uninstalled even when executed with a filter)

Links: src diff

Fix

• conflicting project applied patches state when doing a --no-dev call and a filtered undo/redo after that

Links: src diff

Feature

• allow patch path strip level to be defined in patch's embedded target-info declaration (@level <int>)

Fix

• patches queue generator sometimes generated lists that did not queue proper re-applying of patches when dealing with bundles and indirect targets so that 'patch:redo' == 'patch:undo' + 'patch:apply'
• make sure that the removal od 'dev' bundle (or any other type with indirect targets) patches cause proper re-patching of related targets when running with --no-dev

Links: src diff

Fix

• improved error reporting when encountering issues on composer lock cleanup

Links: src diff

Feature

• allow patch applied root to be configured per patch to allow patching of files that are mapped by other composer plugins to project root (see more at 'Patches: patch applier cwd options')

Fix

• switched away from using a class constant name that on older php versions is reserved (new)
• avoid reporting non-vcs package differences as reason for halting the patch applying (which requires package reset)
• full list of applied patches ended up in composer.lock (new: none added, not even 'true' flag)
• multiple dependencies on patches with embedded target info not respected

Links: src diff

Fix

• definition list validation command returning with false failures when using #skip on patch paths

Maintenance

• removing #skip flag from path when encountered (previously it remained in the path)

Links: src diff

Feature

• allow comments on any level and with any keyword as long as it starts with underscore (_)

Links: src diff

Feature

• halt applying patches when encountering package with local changes to avoid developer from losing their work (allow override with env flag or command --force flag)

Links: src diff

Fix

• patch apply failure on fresh projects under certain conditions when loading the 'patches-applied' from .lock file (which in-between the run is set to 'true')
• skip initiating the patches in case composer update is only targeting composer.lock (running update with --lock) and not really installing/updating any modules

Links: src diff

Feature

• allow @type tag in embedded target info to indicate that patch should only be applied when running composer without --no-dev

Fix

• patch:redo not re-applying patches correctly for targeted package when empty patch list provided (in situations where previously patches were applied)
• when testing bundled packages with --filter, consider all bundle patch targets as full reset candidates (used to produce inconsistent behaviour)

Links: src diff

Fix

• patch validation command failing on bundle patches when owned by non-root package

Links: src diff

Feature

• split the --undo and --redo options of main command into separate commands - 'patch:undo' and 'patch:redo' (the functionality will still also be accessible via flags of 'composer patch')
• create alias command for 'composer patch' to have all commands available under the keyword 'patch' - patch:apply ('composer patch' still works as well though)
• added 'patch:validate' to make sure that there are no patches in owner repo that miss proper target definition (has been a real issue when re-arranging code in some projects)
• allow one-line embedded definition via @package tag the same way it's possible with @version
• added aliases for @package - @target, @module
• added alias for @version - @constraint

Fix

• ticket info never displayed for patch with embedded info, even when @ticket set

Maintenance

• change towards not passing composer instance into functions and using it as dependency instead
• make it possible to manipulate composer loader work by toggling or replacing loader components

Links: src diff

Fix

• patch link/issue moved to be presented after the label/description

Links: src diff

Feature

• allow patches information to be extracted from the patch file (see: patch declaration with embedded meta-data)
• allow comments to be added to patch declaration files by using '_comment' prefix on main level of declaration
• show more detailed reason for re-applying a patch: NEW, when new; CHANGED, when file is not new, but contents changed

Fix

• using patches files on project level or for root repository did not resolve their paths correctly
• undo having confusing semantic meaning when used. targeting a specific package now always just targets the package, path filter gets negated on undo command
• work towards restoring compatibility with 5.3

Links: src diff

Feature

• allow multiple 'patches-depend' declarations for different kind of patches (bundle VS normal patch)
• allow wildcards to be used in target names when defining multiple patches-depends items

Links: src diff

Feature

• allow multiple patch-base's to be defined based on vendor or full package name

Links: src diff

Fix

• missing file added

Links: src diff

Fix

• array-based values ended up being treated as version constraints (issue with label-version exploder)

Links: src diff

Fix

• label-version definition exploder not handling a list of multiple versions correctly

Links: src diff

Feature

• new definition format that consists of description/filename and version restriction
• allow label to be used as file-name (defined in base-path pattern as {{label}} or {{label-value}})
• allow items without mutations (like {{label}}) to have strip-rules defined against them
• don't display label when file name is directly part of the label

Fix

• bad data type returned when base-path pattern defined and certain parts of the name did not match with any value-strip rule
• skip flag not correctly moved to the end of the path when using patches-base configuration
• don't append the base-path pattern with custom extras and expect users to take charge of making sure that the file name is part of the path
• trim whitespace, slash, colon when patch source starts with space

Links: src diff

Maintenance

• debug code removed (shame!)

Links: src diff

Feature

• allow patch base path variables to have partial value extractors defined against them
• use 0.0.0 version variable value when base-path definition includes version in it
• include new base path variable: {{file-name}} (name derived from label) and {{file}} (name used from source as is)
• allow file name to be resolved from patch label (when source not defined)

Fix

• wrong variable name used at patcher config normalizer component that caused a crash when 'config' used for patch definition

Maintenance

• composer lock removed; readme mic statistics badges added

Links: src diff

Fix

• wrong error message when bundle patch is not found from defined path

Links: src diff

Maintenance

• minor modifications to patch filtering logic

Links: src diff

Fix

• fix to a crash that happened when resetting targets that relate to bundle patches

Maintenance

• definition normalizer split into separate components
• patch applier partially split into smaller components

Links: src diff

Fix

• minor change to constant naming to make it match up with patch command. COMPOSER_PATCHES_PREFER_OWNER renamed to COMPOSER_PATCHES_FROM_SOURCE. Backwards compatible
• re-installed packages (when resetting patches) not being re-deployed when using 'patch' command (resulting in incorrect app behaviour due to some old files being still used)

Maintenance

• log messages updated to include applied patch count when resetting package
• showing [NEW] flag when re-applying patches for a package and patch file was previously not applied

Links: src diff

Fix

• bundled patches reset mechanism targeting wrong packages (where root package as owner was being sent to 'patches reset' which caused a crash)

Links: src diff

Feature

• allow default indirect dependency to be defined for a package version restriction
• allow base patch to be defined for widgets - including variable conversion for vendor, module name and version
• introduced new definition pattern to be used together with patches-base and base patch variables: version ranges

Fix

• renamed constants that conflicted with constant names that were reserved in PHP5.3.X

Links: src diff

Maintenance

• package meta-data fixes. syntax error in composer.json

Links: src diff

Fix

• bundled patch targets resolver failing due to patch info loaders being re-arranged and certain array values no longer being available (patch path not available as array keys)

Links: src diff

Fix

• minor architecture changes around filtering patch files / packages

Links: src diff

Feature

• allow patch exclusions based on partial paths
• renamed 'excluded-patches' to 'patches-exclude' to follow similar naming convention through-out the configuration for the plugin. Backwards compatible

Fix

• patch exclusion failed to kick in due to bad configuration pass-down from factory to the component that is responsible for the exclusion

Links: src diff

Feature

• patcher configuration overrides that depend on the OS
• topological sorting on patches to allow sequencing even when patches not defined by same owner or defined in different patch-list files
• allow fuzzy package name targeting with 'patch' command

Fix

• the --filter argument to work similarly to how package filter narrows down on what is being targeted

Links: src diff

Feature

• make it possible to allow patch download from HTTP (separate config from allowing this for packages)

Fix

• fail early when some of the remote patches fail to download (only for patches that are actually required)
• make sure that same patch file is not downloaded twice (might happen with bundled patches)

Links: src diff

Fix

• re-apply remote patch when it's contents have changed (download remote patches beforehand and make the decision based on the contents of the patch)
• remote patches treated as if they're local patch files

Maintenance

• moved patch downloading to be done before any patches are applied
• documentation simplified. Using comments in examples to explain what certain config does

Links: src diff

Maintenance

• documentation re-organized and simplified

Links: src diff

Maintenance

• minor readme and package description updates

Links: src diff

Maintenance

• documentation changes. Some explanations re-written. Added example for bundle-patch

Links: src diff

Maintenance

• documentation re-organized to prioritize quick comprehension on the basics of the module's functionality
• minor code restyle changes

Links: src diff

Feature

• added new operation to check if applier is available (can be used to exclude certain appliers on certain systems)
• added new operation to find applier's executable and use it in the operations that come afterwards
• allow multiple commands per operation
• introduced the possibility to define an operation that is considered a success when the command does not succeed

Fix

• removed references to $this within closures (as it's not supported in 5.3.X)

Links: src diff

Feature

• several config keys renamed (patchers => appliers, patcher-config => patcher). Backwards compatible
• patch enabling moved under patcher/sources (project:bool, packages:bool|array, vendors:bool|array). Backwards compatible
• allow granular patch sources inclusion (so that only some vendors would be included)
• allow some providers to have special extra operations (before this change, every applier was expected to have every listed operation declared)

Links: src diff

Fix

• switched to using PHP constants for OS-related values like newline and path separator

Maintenance

• switched to using constants for each free-text array key value + reduced code repetition
• logger indentation reworked not to be hardcoded in log messages in text form to open up the chance to switch to different logging methods/formats in the future

Links: src diff

Fix

• patches not registered for patch target packages when 'COMPOSER_PATCHES_FATAL_FAIL' enabled and error is encountered

Links: src diff

Fix

• composer patch command option 'undo' not working correctly when patching explicitly set to be enabled in composer.json of the project
• composer patch command option 'redo' not working correctly when patching explicitly set to be enabled in composer.json of the project
• using 'undo' and 'redo' together still triggers 'undo' functionality

Links: src diff

Fix

• don't force bundle patches to have 'vendor' in their paths as it's a customizable value
• patch information not correctly restored to installed.json when there were no patch updates while running 'composer update'

Maintenance

• code split into smaller classes where applicable to move towards single-responsibility entities in design
• reduced the mess around re-using same terminology in too many different contexts

Links: src diff

Feature

• auto-resolve bundle patch targets when 'targets' not defined
• multiple filters for patch command
• allow patch command path filter to have wildcards and negation

Fix

• ignore custom 'targets' config for non-bundled patches
• bundled patch was not registering/resetting target packages when performing redo/undo
• patches-dev and patches-file not enabling patching by default when defined on project level
• having patcher enabled only on project level did not compile patch queue correctly when disabling the option of including patches from packages

Links: src diff

Feature

• allow multiple patch files to be defined to enable high-level patch grouping (or to allow occasional cleanup where really old legacy patches could be moved elsewhere)

Fix

• patch files not loaded from relative path even when they belong to a package rather than being referred directly from the project

Links: src diff

Fix

• crash when trying to declare path stripping level for version-branched sources

Links: src diff

Feature

• allow certain patches to be processed only with very strict path strip options and patcher type
• changed patcher definition template to use variable markup rather than relying on sprintf patterns which dictates the variables in the template to be defined in certain order
• allow extra operations to be defined or the sequence of existing ones to be changed

Fix

• made sure that no compact array markup is used within the plugin

Maintenance

• changed the 'validate' in patcher configuration key to 'check'. Support for 'validate' kept

Links: src diff