Like read-package-json, but faster
npm install read-package-json-fastLike read-package-json, but faster and
more accepting of "missing" data.
This is only suitable for reading package.json files in a node_modules
tree, since it doesn't do the various cleanups, normalization, and warnings
that are beneficial at the root level in a package being published.
``js
const rpj = require('read-package-json-fast')
// typical promisey type API
rpj('/path/to/package.json')
.then(data => ...)
.catch(er => ...)
// or just normalize a package manifest
const normalized = rpj.normalize(packageJsonObject)
`
Errors raised from parsing will use
json-parse-even-better-errors,
so they'll be of type JSONParseError and have a code: 'EJSONPARSE'path
property. Errors will also always have a member referring to the
path originally passed into the function.
To preserve indentation when the file is saved back to disk, use
data[Symbol.for('indent')] as the third argument to JSON.stringify, and\r\n
if you want to preserve windows newlines, replace the \n chars indata[Symbol.for('newline')]
the string with .
For example:
`js`
const data = await readPackageJsonFast('./package.json')
const indent = Symbol.for('indent')
const newline = Symbol.for('newline')
// .. do some stuff to the data ..
const string = JSON.stringify(data, null, data[indent]) + '\n'
const eolFixed = data[newline] === '\n' ? string
: string.replace(/\n/g, data[newline])
await writeFile('./package.json', eolFixed)
Indentation is determined by looking at the whitespace between the initial
{ and the first " that follows it. If you have lots of weird
inconsistent indentation, then it won't track that or give you any way to
preserve it. Whether this is a bug or a feature is debatable ;)
- Parse JSON
- Normalize bundledDependencies/bundleDependencies naming to justbundleDependencies
(without the extra d)true
- Handle , false, or object values passed to bundleDependenciesfunding:
- Normalize to funding: { url: scripts
- Remove any members that are not a string value.bin
- Normalize a string member to { [name]: bin }.optionalDependencies
- Fold into dependencies._id
- Set the property if name and version are set. (This is
load-bearing in a few places within the npm CLI.)
- Warn about invalid/missing name, version, repository, etc.
- Extract a description from the README.md file, or attach the readme toHEAD
the parsed data object.
- Read the value out of the .git folder.tset
- Warn about potentially typo'ed scripts (eg, instead of test)files
- Check to make sure that all the files in the field exist and aredependencies
valid files.
- Fix bundleDependencies that are not listed in .dependencies
- Fix fields that are not strictly objects of string values.directories` field (ie, bins, mans, and so on).
- Anything involving the