Skip to content
This repository has been archived by the owner on Nov 16, 2022. It is now read-only.

Latest commit

 

History

History
30 lines (23 loc) · 946 Bytes

README.md

File metadata and controls

30 lines (23 loc) · 946 Bytes

Note: pending imminent deprecation

This module will be deprecated once npm v7 is released. Please do not rely on it more than absolutely necessary (ie, only if you are depending on it for use with npm v6 internal dependencies).


lock-verify

Report if your package.json is out of sync with your package-lock.json.

USAGE

const lockVerify = require('lock-verify')
lockVerify(moduleDir).then(result => {
  result.warnings.forEach(w => console.error('Warning:', w))
  if (!result.status) {
    result.errors.forEach(e => console.error(e))
    process.exit(1)
  }
})

As a library it's a function that takes the path to a module and returns a promise that resolves to an object with .status, .warnings and .errors properties. The first will be true if everything was ok (though warnings may exist). If there's no package.json or no lockfile in moduleDir or they're unreadable then the promise will be rejected.