Command Line Interface

Usage

dependency-owners [OPTIONS] --loader <loader> <dependency-file>

<dependency-file> is a required positional argument pointing to the file containing the dependencies to check (e.g., package.json).

Options

Flag	Description	Default
--loader <name>	(Required) Specify which loader to use for parsing the dependency file.	(required)
--config <path>	Path to the configuration file mapping owners to dependencies.	dependency-owners.json
--dependency <name>	Limit checks to one or more specific dependency names (variadic; can be repeated).	(all dependencies)
--fail-on-unowned	Exit with an error code if any inspected dependency has no owner.	false

Examples

Check all dependencies against the default config:

dependency-owners \
  --loader @dependency-owners/package-json-loader \
  package.json

Use a custom config file:

dependency-owners \
  --loader @dependency-owners/package-json-loader \
  --config config/dependency-owners.json \
  package.json

Fail if any dependencies are unowned (useful in CI):

dependency-owners \
  --loader @dependency-owners/package-json-loader \
  --fail-on-unowned \
  package.json

Check only specific dependencies:

dependency-owners \
  --loader @dependency-owners/package-json-loader \
  --dependency react --dependency react-dom \
  package.json

Combine multiple options:

dependency-owners \
  --loader @dependency-owners/package-json-loader \
  --config ./owners.json \
  --fail-on-unowned \
  --dependency typescript \
  package.json

Output

A JSON object mapping each dependency to an array of owners.

A simple example (for the dependencies in this repository):

{
  "@stricli/core": ["kirkeaton"],
  "@dependency-owners/package-json-loader": ["kirkeaton"],
  "@kirkeaton/prettier-config": ["kirkeaton"],
  "@kirkeaton/semantic-release-config": ["kirkeaton"],
  "@kirkeaton/tsconfig": ["kirkeaton"],
  "@types/node": ["kirkeaton"],
  "fs-fixture": ["kirkeaton"],
  "prettier": ["kirkeaton"],
  "semantic-release": ["kirkeaton"],
  "typescript": ["kirkeaton"],
  "vitepress": ["kirkeaton"]
}

If a dependency has no owner, its array will be empty. Use --fail-on-unowned to make this an error condition.