read-pkg

WebJar for read-pkg

License	MIT
GroupId	org.webjars.npm
ArtifactId	read-pkg
Last Version	5.2.0
Release Date	Jul 31, 2020
Type	jar
Description	read-pkg WebJar for read-pkg
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/read-pkg

Download read-pkg

Filename	Size
read-pkg-5.2.0.pom
read-pkg-5.2.0.jar	4 KB
read-pkg-5.2.0-sources.jar	22 bytes
read-pkg-5.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/read-pkg/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>read-pkg</artifactId>
    <version>5.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/read-pkg/
implementation 'org.webjars.npm:read-pkg:5.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/read-pkg/
implementation ("org.webjars.npm:read-pkg:5.2.0")

Apache Buildr

'org.webjars.npm:read-pkg:jar:5.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="read-pkg" rev="5.2.0">
  <artifact name="read-pkg" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='read-pkg', version='5.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "read-pkg" % "5.2.0"

Leiningen

[org.webjars.npm/read-pkg "5.2.0"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.webjars.npm : types__normalize-package-data	jar	[2.4.0,3)
org.webjars.npm : normalize-package-data	jar	[2.5.0,3)
org.webjars.npm : parse-json	jar	[5.0.0,6)
org.webjars.npm : type-fest	jar	[0.6.0,0.7)

Project Modules

There are no modules declared in this project.

read-pkg

Read a package.json file

Why

• Gracefully handles filesystem issues
• Throws more helpful JSON errors
• Normalizes the data

Install

$ npm install read-pkg

Usage

const readPkg = require('read-pkg');

(async () => {
	console.log(await readPkg());
	//=> {name: 'read-pkg', …}

	console.log(await readPkg({cwd: 'some-other-directory'}));
	//=> {name: 'unicorn', …}
})();

API

readPkg(options?)

Returns a Promise<object> with the parsed JSON.

readPkg.sync(options?)

Returns the parsed JSON.

options

Type: object

cwd

Type: string
Default: process.cwd()

Current working directory.

normalize

Type: boolean
Default: true

Normalize the package data.

Related

• read-pkg-up - Read the closest package.json file
• write-pkg - Write a package.json file
• load-json-file - Read and parse a JSON file

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

Versions

Version
5.2.0 Jul 31, 2020
3.0.0 Oct 18, 2018
2.0.0 Nov 22, 2016
1.1.0 Nov 22, 2016