NPM.Linker (NPM v0.6.0)

Creates node_modules from the global cache.

Supports multiple linking strategies:

:symlink (default) — symlinks from node_modules/pkg to cache
:copy — full file copy

Uses a hoisted layout where packages are placed as high in the tree as possible, only nesting when version conflicts occur.

Summary

Types

nested_info()

resolved()

strategy()

Functions

hoist(lockfile)

Hoist packages for a flat node_modules layout.

link(lockfile, node_modules_dir \\ "node_modules", strategy \\ default_strategy())

Link all resolved packages into node_modules.

link_bins(node_modules_dir, tree)

Create node_modules/.bin/ symlinks for packages with bin entries.

link_nested(nested_info, flat_lockfile, nm_dir \\ "node_modules", strategy \\ default_strategy())

Link nested packages into parent package node_modules/ subdirectories.

prune(node_modules_dir, expected_names)

Remove packages from node_modules that are not in the expected set.

Types

nested_info()

@type nested_info() :: %{required(String.t()) => term()}

resolved()

@type resolved() :: %{required(String.t()) => NPM.Lockfile.entry()}

strategy()

@type strategy() :: :symlink | :copy

Functions

hoist(lockfile)

@spec hoist(resolved()) :: [{String.t(), String.t()}]

Hoist packages for a flat node_modules layout.

Returns a list of {name, version} tuples representing the top-level packages. When multiple versions of a package exist, the most commonly depended-on version gets hoisted.

link(lockfile, node_modules_dir \\ "node_modules", strategy \\ default_strategy())

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

Link all resolved packages into node_modules.

First populates the global cache, then creates the node_modules tree.

link_bins(node_modules_dir, tree)

@spec link_bins(String.t(), [{String.t(), String.t()}]) :: :ok

Create node_modules/.bin/ symlinks for packages with bin entries.

Reads each package's package.json for the bin field and creates executable symlinks in .bin/.

link_nested(nested_info, flat_lockfile, nm_dir \\ "node_modules", strategy \\ default_strategy())

@spec link_nested(nested_info(), resolved(), String.t(), strategy()) :: :ok

Link nested packages into parent package node_modules/ subdirectories.

For each nested package, resolves which version each parent needs and creates parent_pkg/node_modules/nested_pkg/ with the correct version.

prune(node_modules_dir, expected_names)

@spec prune(String.t(), MapSet.t()) :: :ok

Remove packages from node_modules that are not in the expected set.

Handles both regular and scoped packages (@scope/pkg).