NPM.Why (NPM v0.6.0)

Explains why a package is installed by tracing through the dependency tree.

Implements the npm why / npm explain functionality.

Summary

reason()

Finds all packages that directly depend on the target.

Checks if a package is a direct dependency.

Explains why a package is in the lockfile.

Returns a human-readable explanation string.

@type reason() :: %{path: [String.t()], range: String.t() | nil, direct: boolean()}

@spec dependents(String.t(), map()) :: [String.t()]

Finds all packages that directly depend on the target.

@spec direct?(String.t(), map()) :: boolean()

Checks if a package is a direct dependency.

@spec explain(String.t(), map(), map()) :: [reason()]

Explains why a package is in the lockfile.

Returns a list of dependency paths that lead to the given package. Each path is a list of package names from root to the target.

@spec format_reasons([reason()]) :: String.t()

Returns a human-readable explanation string.