NPM.Publish (NPM v0.6.0)

Validates a package before publishing to the registry.

Checks required fields, validates package.json completeness, and reports readiness for publishing.

Summary

Functions

check(pkg_data)

Checks if a package is ready for publishing.

check_recommended(pkg_data)

Checks recommended fields and returns warnings.

check_required(pkg_data)

Checks required fields are present.

name_available?(name)

Validates that the package name is not taken (for new packages).

summary(pkg_data)

Returns a readiness summary.

version_exists?(name, version, packument)

Checks if the version has already been published.

Functions

check(pkg_data)

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

Checks if a package is ready for publishing.

check_recommended(pkg_data)

@spec check_recommended(map()) :: [String.t()]

Checks recommended fields and returns warnings.

check_required(pkg_data)

@spec check_required(map()) :: [String.t()]

Checks required fields are present.

name_available?(name)

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

Validates that the package name is not taken (for new packages).

summary(pkg_data)

@spec summary(map()) :: %{
  ready: boolean(),
  errors: [String.t()],
  warnings: [String.t()],
  name: String.t() | nil,
  version: String.t() | nil
}

Returns a readiness summary.

version_exists?(name, version, packument)

@spec version_exists?(String.t(), String.t(), map()) :: boolean()

Checks if the version has already been published.