Gathering detailed insights and metrics for read-pkg
Gathering detailed insights and metrics for read-pkg
Installations
npm install read-pkgDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=18
Node Version
21.1.0
NPM Version
9.2.0
Score
98.5
Supply Chain
91.8
Quality
75.7
Maintenance
100
Vulnerability
99.6
License
Releases
11
Languages
2
JavaScript
TypeScript
JavaScript (70.58%)
TypeScript (29.42%)
Developer
sindresorhus
Download Statistics
Total Downloads
11,512,856,756
Last Day
2,533,357
Last Week
40,570,993
Last Month
176,880,899
Last Year
1,863,426,262
GitHub Statistics
MIT License
167 Stars
49 Commits
25 Forks
6 Watchers
1 Branches
9 Contributors
Updated on May 22, 2025
Bundle Size
100.50 kB
Minified
35.99 kB
Minified + Gzipped
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
9.0.1
Package Id
read-pkg@9.0.1
Unpacked Size
6.76 kB
Size
2.54 kB
File Count
5
NPM Version
9.2.0
Node Version
21.1.0
Published on
Nov 16, 2023
Total Downloads
Cumulative downloads
Total Downloads
11,512,856,756
read-pkg
Read a package.json file
Why
Install
1npm install read-pkg
Usage
1import {readPackage} from 'read-pkg'; 2 3console.log(await readPackage()); 4//=> {name: 'read-pkg', …} 5 6console.log(await readPackage({cwd: 'some-other-directory'})); 7//=> {name: 'unicorn', …}
API
readPackage(options?)
Returns a Promise<object> with the parsed JSON.
readPackageSync(options?)
Returns the parsed JSON.
options
Type: object
cwd
Type: URL | string
Default: process.cwd()
Current working directory.
normalize
Type: boolean
Default: true
Normalize the package data.
parsePackage(packageFile, options?)
Parses an object or string into JSON.
packageFile
Type: object | string
An object or a stringified object to be parsed as a package.json.
options
Type: object
normalize
Type: boolean
Default: true
Normalize the package data.
Related
- read-package-up - Read the closest package.json file
- write-package - Write a
package.jsonfile - load-json-file - Read and parse a JSON file
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
security policy file detected
Details
- Info: security policy file detected: .github/security.md:1
- Info: Found linked content: .github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/security.md:1
- Info: Found text in security policy: .github/security.md:1
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
Found 8/30 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/read-pkg/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/sindresorhus/read-pkg/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:21
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 8 are checked with a SAST tool
Score
4.2
/10
Last Scanned on 2025-05-26
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More