NPM.Link (NPM v0.6.0)

Copy Markdown View Source

Manages local package linking via symlinks.

Implements npm link functionality — creates symlinks in node_modules pointing to local package directories for development.

Summary

Functions

Links a local package into node_modules.

Checks if a package is linked (symlinked, not installed normally).

Lists all linked packages in node_modules.

Unlinks a package from node_modules.

Types

Functions

link(package_dir, node_modules_dir \\ "node_modules")

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

Links a local package into node_modules.

linked?(name, node_modules_dir \\ "node_modules")

@spec linked?(String.t(), String.t()) :: boolean()

Checks if a package is linked (symlinked, not installed normally).

list(node_modules_dir \\ "node_modules")

@spec list(String.t()) :: [link_info()]

Lists all linked packages in node_modules.

unlink(name, node_modules_dir \\ "node_modules")

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

Unlinks a package from node_modules.