read-package-json-fast

npmpackage.info

Gathering detailed insights and metrics for read-package-json-fast

Other packages similar to read-package-json-fast

@firanorg/mollitia-molestias-accusamus

10.13.142

[![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

@taktikorg/unde-animi-omnis

5.8.117

<p align="center"> <a href="https://www.npmjs.com/package/@taktikorg/unde-animi-omnis"><img src="https://img.shields.io/npm/v/@taktikorg/unde-animi-omnis"></a> <a href=""><img src="https://img.shields.io/github/actions/workflow/status/RemiMyrset/@taktikor

@crabas0npm2/impedit-porro-maiores

0.0.1-security

security holding package

@crabas0npm2/perspiciatis-rerum-blanditiis

0.0.1-security

security holding package

Gathering detailed insights and metrics for read-package-json-fast

USAGE

1const rpj = require('read-package-json-fast') 2 3// typical promisey type API 4rpj('/path/to/package.json') 5 .then(data => ...) 6 .catch(er => ...) 7 8// or just normalize a package manifest 9const 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' property. Errors will also always have a path member referring to the path originally passed into the function.

Indentation

To preserve indentation when the file is saved back to disk, use data[Symbol.for('indent')] as the third argument to JSON.stringify, and if you want to preserve windows \r\n newlines, replace the \n chars in the string with data[Symbol.for('newline')].

For example:

1const data = await readPackageJsonFast('./package.json') 2const indent = Symbol.for('indent') 3const newline = Symbol.for('newline') 4// .. do some stuff to the data .. 5const string = JSON.stringify(data, null, data[indent]) + '\n' 6const eolFixed = data[newline] === '\n' ? string 7 : string.replace(/\n/g, data[newline]) 8await 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 ;)

WHAT THIS MODULE DOES

Parse JSON

Normalize bundledDependencies/bundleDependencies naming to just bundleDependencies (without the extra d)

Handle true, false, or object values passed to bundleDependencies

Normalize funding: <string> to funding: { url: <string> }

Remove any scripts members that are not a string value.

Normalize a string bin member to { [name]: bin }.

Fold optionalDependencies into dependencies.

Set the _id property if name and version are set. (This is load-bearing in a few places within the npm CLI.)

WHAT THIS MODULE DOES NOT DO

Warn about invalid/missing name, version, repository, etc.

Extract a description from the README.md file, or attach the readme to the parsed data object.

Read the HEAD value out of the .git folder.

Warn about potentially typo'ed scripts (eg, tset instead of test)

Check to make sure that all the files in the files field exist and are valid files.

Fix bundleDependencies that are not listed in dependencies.

Fix dependencies fields that are not strictly objects of string values.

Anything involving the directories field (ie, bins, mans, and so on).

Other packages similar to read-package-json-fast

Other packages similar to read-package-json-fast

Installations

Developer Guide

No

CommonJS

^18.17.0 || >=20.5.0

22.9.0

10.8.3

Score

Pull Requests

0

82

41

41

Issues

0

2

2

Releases

Languages

Developer

npm

Download Statistics

GitHub Statistics

Bundle Size

3.92 kB

1.80 kB

Maintainers

Package Meta Information

Total Downloads

1,065,390,050

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

read-package-json-fast

USAGE

Indentation

WHAT THIS MODULE DOES

WHAT THIS MODULE DOES NOT DO

10

10

10

10

10

10

8

2

0

0

0

0

6.3

/10