Who? Why? When?
I made this tool when I just got a project from my coworker, and after running
npm install then
grunt build failed miserably. It was working well on his machine, so we compared
npm ls and after a few manual
npm install I finally discovered that a very specific version of a module was required to make the
grunt build work.
This situation should never happen. In a ideal world where developers all follow
semver and don't let their projects in version
0.x for its whole life, then it would not happen. But we don't live in this world :(
Work in progress. Tool is working, but it needs some polish and documentation :)
It, above all, needs optimization in the process too.
- Working API
- Working CLI
- Better output
- Better performance (parallel downloads and/or installs and/or tests)
- Tool to generate
npm-dichotomy.json(some smart guesses from
- Conquer the world
npm install -g npm-dichotomy
Configure & run
testis the command run after each
npm install, this command must exit with code
0to mark a success
setupis the command run once at beginning of the global operation
debugis a boolean, set to true if you want debug (dev) information
modulesdefines the criteria to follow, as a set of
- Key is the module's name
- A rule is a method of
semvermodule, you will generally need
satisfieswhich are all self-explanatory
- Typically you know that your test worked once in your project's life, you have an idea of the few modules that may cause the bug, you may simply list them and add a single
satisfiesrule copied from your
- Additionnally, you may know a module's version when it was working, you can then add a
gterule to limit the number of tested versions
How it works
npm-dichotomy will then grab available versions for each module, keep only the matching ones, then calculate all the possible combinations and test them all, one by one. That can be long, time for a cup of tea.
You can follow the progress in standard output, but that's not really the point of this command, it's supposed to free your mind from this annoying task. At the very end
npm-dichotomy will display the successful combinations.
versions: 'email@example.com' 'firstname.lastname@example.org'success: true
Now you know, you can make your
package.json more strict, yell on modules' maintainers, or try to understand why it failed, with a lot more information.