@wedgekit/wedgecop

Keep your monorepo dependencies in check. Stay out of trouble.

@wedgekit/wedgecop

Getting Started

Wedgecop is a CLI utility and can be run via global install or npx. It's recommended to install the tool as a project devDependency to run it as part of a CI process.

Usage

Description
  Dependency checking for monorepos.

Usage
  $ wedgecop [projectPaths] [options]

Options
  -m, --monorepo-config    Specify a repo configuration [lerna | yarn | auto]  (default auto)
  -o, --output-file        Specify file to write report to.  Outputs to the console if not specified.
  -f, --format             Use a specific output file format  (default console)
  -i, --ignores            A comma separated array containing package names to ignore. It can be glob expressions
  -p, --ignore-patterns    Comma separated patterns describing files to ignore. Patterns must match the .gitignore spec
  --skip-missing           Skip check for missing dependencies
  --skip-unused            Skip check for unused dependencies
  --skip-mismatched        Skip check for package version mismatches
  --warn                   Dependency issues are reported as warnings, rather than errors  (default false)
  -v, --version            Displays current version
  -h, --help               Displays this message

Examples
  // Check missing, unused, and mismatched dependencies. Run against all projects in a monorepo.
  $ wedgecop

  // Check for all issues within projects in the specified paths.
  $ wedgecop 'public/*' 'private/*'

  // Check for only missing and mismatched dependencies. Output results to file in JUnit format suitable for CI.
  $ wedgecop --skip-unused false -o junit/wedgecop/results.xml

Further Reading

Detailed option explanations as well as an example of an advanced use case can be found in the DOCUMENTATION.