normalize-package-data

Normalization of package metadata

This feature takes a package.json object and normalizes its metadata. After normalization, the package object is modified in place to meet the standard structure and fields as defined by npm and Node.js.

const normalize = require('normalize-package-data');
let pkg = { name: 'example', version: '1.0.0' };
normalize(pkg);
console.log(pkg);

Validation of package data

The package also validates the package data and attaches an array of error messages to the package object if there are any issues found during normalization.

const normalize = require('normalize-package-data');
let pkg = { name: 'example', version: '1.0.0' };
normalize(pkg);
if (pkg.errors) {
  console.error('Package data contains errors:', pkg.errors);
}

Warning for non-standard fields

If the package data contains non-standard fields, the normalization process will not remove them but will provide warnings about their presence.

const normalize = require('normalize-package-data');
let pkg = { name: 'example', version: '1.0.0', nonStandardField: 'some value' };
normalize(pkg);
if (pkg.warnings) {
  console.warn('Package data contains warnings:', pkg.warnings);
}