npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@universal-packages/package-json

v1.0.3

Published

package.json utils

Downloads

50,723

Readme

Package Json

npm version Testing codecov

package.json utils.

Install

npm install @universal-packages/package-json

Global methods

readPackageJson([name: string])

Reads the package.json file as a JSON of the current working directory or if a package name is passed and its installed under node_modules the package.json is read from that package.

import { readPackageJson } from '@universal-packages/package-json'

const json = readPackageJson('jest')

console.log(json)

// > { name: 'jest', ...}

PackageJson

PackageJson for a more in deep mapping of the package.json file.

import { PackageJson } from '@universal-packages/package-json'

const packageJson = new PackageJson()

packageJson.read()

Instance methods

read()

Reads the root package.json file and all its dependencies recursively generating a new PackageJson object for ech dependency.

Properties

name:string

Name of the package being mapped.

version:string

Version of the package being mapped.

json: Object

The package.json object of the package being mapped.

flatDependencies: Object<PackageJson>

All the uniq dependencies read while reading recursively.

dependencies: Object<PackageJson>

Collection of all dependencies read as PackageJson objects.

devDependencies: Object<PackageJson>

Collection of all devDependencies read as PackageJson objects.

peerDependencies: Object<PackageJson>

Collection of all peerDependencies read as PackageJson objects.

peerDependenciesMeta: Object<PackageJson>

Collection of all peerDependenciesMeta read as PackageJson objects.

bundleDependencies: Object<PackageJson>

Collection of all bundleDependencies read as PackageJson objects.

optionalDependencies: Object<PackageJson>

Collection of all optionalDependencies read as PackageJson objects.

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.