Check Drupal Patches
Introduction
In case you're building Drupal projects using Composer you're probably managing code patches using the composer-patches plugin by cweagans.
Check Drupal Patches is a command line tool to check your patch list against multiple releases of your dependencies (Drupal core and contributed packages). For each dependency release it will tell you whether a given patch has been applied, is applicable or can't be applied.
No modifications are made to your project folder, and Drupal doesn't need to be installed.
Requirements
- NodeJS >=12.0.0
- Git
- Composer
- Patch utility
Installation
You should install this tool globally:
npm install -g check-drupal-patches
Usage
Start the scan specifying your Drupal project root folder, relative or absolute:
cdp <Drupal Project Root>
The project root is the folder containing your composer.json file, usually one level above the web root containing the index.php file.
Be aware the scan might take quite some time. The reason is that your dependencies will be installed to a temporary folder from source, so there will be a complete git history.
Sample Output:
...
ℹ Checking patches for package drupal/protected_submissions...
Installed version: 8.x-1.3
Patch description: update latin unicode range
- Patch is not applicable for tag: 8.x-1.0
- Patch is not applicable for tag: 8.x-1.1
- Patch is applicable for tag: 8.x-1.2
- Patch is applicable for tag: 8.x-1.3
- Patch has been applied to tag: 8.x-1.4
- Patch is not applicable for tag: 8.x-1.5
- Patch is not applicable for tag: 8.x-1.6
- Patch is not applicable for tag: 8.x-1.7
- Patch is not applicable for tag: 8.x-1.8
TODO
For now, this tool is kind of a POC and needs definitely more testing. There will be bugs for sure. Feel free to open issues (good) and pull requests (better).
- At the moment there's no way to check development versions of dependencies.
- For now, remote patches aren't supported, the patchfiles need to be stored locally.
Changelog
v0.2.0 Switched to more robust patch application method
v0.1.3 Added version check for NodeJS
v0.1.2 Added sample output to README
v0.1.1 Fixed a typo
v0.1.0 Initial release