NPM.Migration (NPM v0.6.0)

Copy Markdown View Source

Provides migration guidance between npm and lockfile versions.

Summary

Functions

Returns breaking changes between npm major versions.

Formats migration guide.

Determines required lockfile version for an npm version.

Checks if a lockfile migration is needed.

Returns migration steps.

Functions

breaking_changes(from, to)

@spec breaking_changes(non_neg_integer(), non_neg_integer()) :: [String.t()]

Returns breaking changes between npm major versions.

format_guide(from, to)

@spec format_guide(non_neg_integer(), non_neg_integer()) :: String.t()

Formats migration guide.

lockfile_version(npm_version)

@spec lockfile_version(String.t()) :: non_neg_integer()

Determines required lockfile version for an npm version.

needs_migration?(current_lockfile_version, target_npm_version)

@spec needs_migration?(non_neg_integer(), String.t()) :: boolean()

Checks if a lockfile migration is needed.

steps(from_lockfile, to_lockfile)

@spec steps(non_neg_integer(), non_neg_integer()) :: [String.t()]

Returns migration steps.