NPM.Validate (NPM v0.6.0)

Copy Markdown View Source

Validates package.json data against npm conventions.

Checks for required fields, correct types, valid values, and common mistakes.

Summary

Functions

Returns only errors (not warnings).

Formats validation issues for display.

Returns a list of unknown fields.

Checks if the package.json is valid (no errors).

Validates package.json data, returning a list of issues.

Returns only warnings.

Functions

errors(data)

@spec errors(map()) :: [map()]

Returns only errors (not warnings).

format_issues(issues)

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

Formats validation issues for display.

unknown_fields(data)

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

Returns a list of unknown fields.

valid?(data)

@spec valid?(map()) :: boolean()

Checks if the package.json is valid (no errors).

validate(data)

@spec validate(map()) :: [map()]

Validates package.json data, returning a list of issues.

warnings(data)

@spec warnings(map()) :: [map()]

Returns only warnings.