di-tooling
v0.9.2
Published
Provide tooling for applications
Downloads
10
Readme
@di/tooling
Summary
This package provides yarn helper methods for all applications as well as core to allow for more robust and complex behaviour.
Setup
- Run
yarn add -SE @di/toolingto add the package to your app. - Run
yarn global add yarn-deduplicate, this is needed for theautofixcommand. - You also need to add the
toolsscript to yourpackage.json:
"scripts": {
...,
"tools": "node ./node_modules/@di/tooling"
}- You can remove the following scripts from your
package.json:link:all,unlink:allandupgradeDi - These are replaced with the
linkAll,unlinkAllandupgradePackagescommand fromm tooling.
Commands
To run simply do yarn tools and you will be prompted with the commands available to your app.
You can also run a command directly with yarn tools {cmdName}
Common
analyzeDependenciesanalyzes the dependencies of your applicationfindDuplicatesdetects dependencies which have multiple versions installedcheckVersionsreports the currently installed versions of@dipackagesautofixthis will try to fix issues with youryarn.lockfile, if problems persist contact the core team
Graphviz
If you would like to use the svg graph option of analyzeDependencies you need to install graphviz => http://www.graphviz.org/download/
On Windows you also need to adapt the PATH variable. If you installed graphviz at its default location append the following path to your PATH variable:
# Adapt the path to match your installed version and location
C:\Program Files (x86)\Graphviz2.38\binNote
findDuplicatescan also be run with a param, i.e.yarn tools findDuplicates packageNamethis will only report duplicates that containpackageName.- Running
yarn tools findDuplicates allwill result in a complete report, this will result in a very long list.
App specific
linkStatusshows you which packages are currently linked and installed from npm.orglinkAlllinks all packagesunlinkAllunlinks all packagesupgradePackagesupgrades all @di packages to the latest version
Important
linkAll and unlinkAll require that you have run registerAll in core beforehand
Core specific
registerAllregisters all packages so they can be linked in your applicationsunregisterAllunregisters all packages (they can no longer be linked in your applications)
