Propagate updated packages throughout a project.
Managing dependencies can be tiresome if your project relies on more than a few frequently updated packages. Consider the following dependency graph. Here the solid lines represent dependencies, the dotted lines developer dependencies:
alice
^ ^
. |
........ |_______
. |
. |
bernard |
^ |
| |
_____|_____ chuck
| | ^
| | .
dylan erica .
^ .
| .
|_____ .....
| .
| .
freddie
If we fix a bug in the freddie package and bump its patch number then we must update the package JSON files of both the erica and chuck packages in order to make sure that they both make use of the updated freddie package.
However, that is not the end of the task.
We must also bump their package numbers and update the package JSON files of packages or binaries that depend on them, too.
And so on, ad nauseam.
Propagate automates the process, allowing you to update the version, dependencies and devDependencies fields of all the requisite package JSON files in a project whenever a package is updated, effectively propagating the original update through the entire project.
It will also optionally save, commit and publish these changes by way of configurable shell commands.
Here are the actual updates that Propagate would make:
'./freddie' ("freddie"):
"version": "^1.0.4" -> "^1.0.5"
'./erica' ("erica"):
"version": "^2.1.3" -> "^2.1.4",
"dependencies": {
"freddie": "^1.0.4" -> "^1.0.5"
}
'./chuck' ("chuck"):
"version": "^1.7.12" -> "^1.7.13",
"devDependencies": {
"freddie": "^1.0.4" -> "^1.0.5"
}
'./bernard' ("bernard"):
"version": "^1.3.2" -> "^1.3.3",
"dependencies": {
"erica": "^2.1.3" -> "^2.1.4",
}
'./alice':
"dependencies": {},
"devDependencies": {
"bernard": "^1.3.2" -> "^1.3.3",
}
Note that only core semver versions are supported, that is, versions of the form major.minor.patch where major, minor and patch are natural numbers.
As yet Propagate does not support version ranges or multiple sets.
Additionally, it will leave intact but otherwise ignore modifiers such as ^ and ~.
If you are not using either just these modifiers or no modifiers at all, Propagate is unlikely to work for you.
You can install Propagate via npm:
npm install --global propagate-cli
You may need to prepend sudo, depending on your setup.
If you would like to contribute or would simply like to have a look at the code, you can clone the repository with Git...
git clone https://github.com/djalbat/propagate-cli.git
...then install the dependencies with npm from within the project's root directory:
npm install
Propagate has the following commands and options:
propagate [<options>] [<command>] [<argument>]
Commands:
help Show this help
version Show the version
initialise Create a configuration file
add-directory Add an additional directory
remove-directory Remove an additional directory
list-directories List directories, including the default directory
set-shell-commands Set the Git, poll, build, install and publish shell commands
add-ignored-dependency Add an ignored dependency
list-ignored-dependencies List the ignored dependencies
remove-ignored-dependency Remove an ignored dependency
add-forced-dependency-relation Add a forced dependency relation
list-forced-dependency-relations List the forced dependency relations
remove-forced-dependency-relation Remove a forced dependency relation
Options:
--help|-h Show this help
--version|-v Show the version
--dry-run|-d Show updates but do not apply them
--delay|-w Polling delay, the default is three seconds
--attempts|-a Polling atempts, the default is ten
--quietly|-q Execute shell commands without printing to the console
--yes|-y Initially answer yes to prompts
In the directory that contains the sub-directories holding your project's packages and binaries, run the following command:
propagate initialise
To propagate the freddie package, for example, run the following command:
propagate freddie
You can also execute a lone propagate command from within a package's subdirectory and it will propagate that package.