dependency analyzer and fixer
npm install @times-components/dependA tool for analysing, visualizing and syncing version numbers in a monorepo.
This tool parses all package.json files described in your lerna.json or that
match a given glob-expression. All packages found are assumed to be part of one
monorepo.
Based on the parsed packages, linting rules are computed. Based on those rules,
hints are computed and can be displayed using --hint and applied with --fix.
Strategies add additional rules for ensuring packages install the same external
dependencies. By default, only rules are computed that ensure that every package
installs the latest version of each package found in the monorepo.
--list prints all package versions found in the monorepo. Based on the used
rules, packages will be rendered in different colours:
- Green => nothing to do.
- Yellow => rules available to resolve the conflict.
- Red => no rule available to resolve this conflict.
If no rules are available, set a strategy or fix the issue by using --pick.
``
depend --lerna "{path/to/lerna/project}" [...options]
depend --expr "{glob}" [...options]
Evaluate all package.json files defined in the packages field found file.
Defines the glob expression that will be used to search the filesystem for
package.json files.
Fixes the packages according to the computed versions.
Prints a graphviz compatible output that can be
converted to an image.
prints all package versions found in the monorepo.
prints all computed rules.
Consider following repo:
packages/foo/package.json:
`json`
{
"name": "foo",
"version": "0.0.1",
"dependencies": {
"react": "16.10.0",
"bar": "0.0.1"
}
}
packages/bar/package.json:
`json`
{
"name": "bar",
"version": "0.0.2",
"dependencies": {
"react": "16.9.0",
"glob": "6.2.1"
}
}
depend -l . -g outputs all dependencies in .dot format:
`dot`
digraph {
"foo@0.0.1" -> "react@16.10.0";
"foo@0.0.1" -> "bar@0.0.1";
"bar@0.0.2" -> "react@16.9.0";
"bar@0.0.2" -> "glob@6.2.1";
}
depend -l . -g "*=>react" will only outputs the subset that has
reacte as a dependency:
`dot`
digraph {
"foo@0.0.1" -> "react@16.10.0";
"bar@0.0.2" -> "react@16.9.0";
}
depend -l . -g "foo=>*" will only outputs the subset that has react as
a dependency:
`dot`
digraph {
"foo@0.0.1" -> "react@16.10.0";
"foo@0.0.1" -> "bar@0.0.1";
}
Depend itself does not have any rendering capabilities but --graph output canfdp
be directly piped into a graphviz renderer.
and can be obtained by installing the graphviz package.
depend -l . -g "@times-components/*=>dextrose@" | fdp -Tsvg -o dextrose.svg
depend -l . -g "/ad@ => " | circo -Tgif -o ad.gif
!ad
Adds {package}@{version} to the set of rules. Use this in conjunction with--hint to verify the expected behaviour and use --fix to apply the changes.
depend -l . --pick react@16.10.0 --hint would set all react
dependencies to _16.10.0_
The filter allows you to restrict the nodes that will be part of the graph.
The graph is described as a set of relationship of the shape package@version => dependency@version. A Node is included in the graph if the supplied pattern
matches the relationship. Currently only supported placeholder symbol is "\*".
#### Examples
=>react@16.9.*
everything that installs react ver16.9.\*
=>jest
everything that installs jest
@times-components/=>, @times-components
all the dependencies of all times-components packages
=> , , *
everything
exit with code 1 if packages don't install the expected versions.
Strategies compute additional rules how to resolve version conflicts of external
(dev)dependencies within the monorepo.
Dependencies that are also packages of the monorepo, are always (suggested to
be) set to the latest version found in the monorepo irrespective of the chosen
strategy.
pick the oldest used version
pick the newest used version
use the version that is used by the majority of packages in your repo
as majority but on a tie pick the older version
as majority but on a tie pick the newer version
Strategies progressive and conservative` don't support version ranges.