@virmator/deps

@virmator/deps

A default plugin for virmator.

Available commands

• deps

  Various dependency commands. A sub-command must be provided.

  • Examples

    • check import dependencies: virmator deps check
    • upgrade npm dependencies: virmator deps upgrade
    • list unused npm dependencies: virmator deps unused
    • regenerate npm dependencies: virmator deps regen

  • Sub Commands

    • check

      Checks that import dependencies pass your dependency cruiser config. The base configuration blocks typical import errors such as circular dependencies and importing test files.

      • Examples
        • virmator deps check
      • Configs
        • configs/dep-cruiser.config.cts
      • Deps
        • dependency-cruiser
        • esbuild

    • unused

      Lists direct dependencies declared in package.json that are not referenced by a static import in the package's code. Dependencies used only by npm scripts or dynamically generated module names may be reported as unused.

      • Examples
        • virmator deps unused
      • Deps
        • dependency-cruiser

    • upgrade

      Upgrades dependencies using npm-check-update. Does not automatically run 'npm i'. It is recommended to run 'virmator deps regen' instead.

      If a package name or glob is passed as an argument, only the matching direct dependencies are upgraded via 'npm i @'. An optional '@' suffix on the argument selects which version to install (defaulting to 'latest' when omitted). Any flags or args supplied after the pattern are forwarded to npm verbatim (e.g. '--min-release-age 0'). In a mono-repo, this scans the root package.json as well as every workspace package.json, running an install in each one that has a match. Outside a mono-repo, it scans the current package only. The command errors out if no direct deps match in any package.json.

      • Examples
        • virmator deps upgrade
        • upgrade a single package across the mono-repo: virmator deps upgrade @augment-vir/common
        • upgrade all packages matching a glob: virmator deps upgrade "@augment-vir/*"
        • upgrade matches to a specific version: virmator deps upgrade "my-package@^2.0.0"
        • forward npm flags (e.g. bypass min-release-age): virmator deps upgrade "@augment-vir/*" --min-release-age 0
      • Configs
        • configs/ncu.config.ts
      • Deps
        • npm-check-updates

    • regen

      Force regeneration of all all dependencies by deleting all node_modules directories and package-lock.json and then running 'npm i'.

      • Examples
        • virmator deps regen