NPM.Overrides (NPM v0.6.0)

Handles npm overrides for forcing specific package versions.

npm overrides allow replacing versions of transitive dependencies, useful for security patches and compatibility fixes.

Summary

override()

Applies overrides to a lockfile, replacing matched versions.

Formats an override for display.

Finds which overrides would affect the current lockfile.

parse(arg1)

Parses overrides from package.json data.

Validates overrides — checks if specified versions are valid semver.

@type override() :: %{
  package: String.t(),
  version: String.t(),
  parent: String.t() | nil
}

@spec apply_overrides(map(), [override()]) :: {map(), [map()]}

Applies overrides to a lockfile, replacing matched versions.

Returns the modified lockfile and a list of applied overrides.

@spec format_override(override()) :: String.t()

Formats an override for display.

@spec matching(map(), [override()]) :: [override()]

Finds which overrides would affect the current lockfile.

@spec parse(map()) :: [override()]

Parses overrides from package.json data.

Supports both flat overrides {"pkg": "version"} and nested overrides {"parent": {"pkg": "version"}}.

@spec validate([override()]) :: {:ok, [override()]} | {:error, [String.t()]}

Validates overrides — checks if specified versions are valid semver.