@spec add_dep(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, term()}

Add a dependency to package.json, creating the file if needed.

Options

• :dev - when true, adds to devDependencies instead of dependencies

@spec expand_workspaces([String.t()], String.t()) :: [String.t()]

Expand workspace patterns to actual directories with package.json files.

Supports glob patterns like packages/* and apps/**.

@spec file_dep?(String.t()) :: boolean()

Check if a dependency range refers to a local file path.

Supports file:../path and file:./path references.

@spec git_dep?(String.t()) :: boolean()

Check if a dependency range refers to a git repository.

Supports git+https://, git+ssh://, github:user/repo, and git:// URLs.

@spec read(String.t()) ::
  {:ok, %{required(String.t()) => String.t()}} | {:error, term()}

Read dependencies from package.json.

@spec read_all(String.t()) ::
  {:ok,
   %{dependencies: map(), dev_dependencies: map(), optional_dependencies: map()}}
  | {:error, term()}

Read all dependency groups from package.json.

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

Read bundleDependencies (or bundledDependencies) from package.json.

Returns a list of package names that should be bundled in the tarball.

@spec read_overrides(String.t()) ::
  {:ok, %{required(String.t()) => String.t()}} | {:error, term()}

Read overrides from package.json.

@spec read_resolutions(String.t()) ::
  {:ok, %{required(String.t()) => String.t()}} | {:error, term()}

Read resolutions (Yarn-style) from package.json.

@spec read_scripts(String.t()) ::
  {:ok, %{required(String.t()) => String.t()}} | {:error, term()}

Read scripts from package.json.

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

Read workspace patterns from package.json.

@spec remove_dep(String.t(), String.t()) :: :ok | {:error, term()}

Remove a dependency from package.json.

@spec resolve_file_dep(String.t(), String.t()) :: String.t()

Resolve a file dependency path.

Returns the absolute path for a file: reference.

@spec url_dep?(String.t()) :: boolean()

Check if a dependency range refers to a URL tarball.

Supports http:// and https:// URLs ending in .tgz or .tar.gz.