updates/README.md
2023-09-05 01:20:26 +02:00

1.9 KiB

updates

updates is a CLI tool which checks for npm and poetry dependency updates of the current project and optionally updates package.json/pyproject.toml. It is highly configurable and is typically able to complete in less than a second.

Usage

# check for updates
npx updates

# update package.json and install new dependencies
npx updates -u && npm i

Bun and Deno

bunx updates
deno run -A npm:updates

Options

See --help. Options that take multiple arguments can take them either via comma-separated value or by specifying the option multiple times.

If an option has a optional pkg argument but none is given, the option will be applied to all packages instead.

All pkg options support glob matching via picomatch or regex (on CLI, wrap the regex in slashes, e.g. '/^foo/').

Config File

Put a updates.config.js or updates.config.mjs in the root of your project, usually besides package.json to configure certain options of the module. CLI arguments have precedence over options in the config file, except for include and exclude options which are merged.

export default {
  exclude: [
    "semver",
    "@vitejs/*",
    /^react(-dom)?$/,
  ],
};

Config File Options

  • include Array[String|Regexp]: Array of dependencies to include
  • exclude Array[String|Regexp]: Array of dependencies to exclude
  • types Array[String]: Array of dependency types
  • registry String: URL to npm registry

© silverwind, distributed under BSD licence