dependents's Introduction

dependents

Tool to gather all dependents of a package and sort by npm weekly downloads, GitHub forks, stars or watchers

This repository is managed by the Package Maintenance Working Group, see Governance.

Personal Access Token

Note that to use this tool you need a GitHub personal token set as an environment variable named GITHUB_TOKEN. For public repositories, no scopes are required. For more information about GitHub tokens: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line

Install

To install this tool run:

$ npm i -g dependents

Or via npx:

$ GITHUB_TOKEN=<your token> npx dependents [options]

Require it in your project

const expressDependents = require('dependents')({ package: "express", total: 10, sort: 'downloads' })

Examples

dependents --package express --number 5 --sort downloads --total 25

Getting first 5 dependents of express sorted by downloads
{"webpack-dev-server":{"downloads":7492143,"forks":1023,"stars":6264,"watchers":116,"url":"github.com/webpack/webpack-dev-server"}}
{"webpack-bundle-analyzer":{"downloads":3031281,"forks":290,"stars":9863,"watchers":97,"url":"github.com/webpack-contrib/webpack-bundle-analyzer"}}
{"apollo-server-express":{"downloads":1032911,"forks":1318,"stars":9604,"watchers":216,"url":"github.com/apollographql/apollo-server"}}
{"gatsby":{"downloads":444063,"forks":7870,"stars":44480,"watchers":977,"url":"github.com/gatsbyjs/gatsby"}}
{"firebase-functions":{"downloads":433052,"forks":100,"stars":707,"watchers":109,"url":"github.com/firebase/firebase-functions"}}

JSON output only

dependents --package express --number 5 --sort downloads --total 25 --json

[
  {
    'webpack-dev-server': {
      downloads: 7492143,
      forks: 1023,
      stars: 6264,
      watchers: 116,
      url: 'github.com/webpack/webpack-dev-server'
    }
  },
  {
    'webpack-bundle-analyzer': {
      downloads: 3031281,
      forks: 290,
      stars: 9863,
      watchers: 97,
      url: 'github.com/webpack-contrib/webpack-bundle-analyzer'
    }
  },
  {
    'apollo-server-express': {
      downloads: 1032911,
      forks: 1318,
      stars: 9604,
      watchers: 216,
      url: 'github.com/apollographql/apollo-server'
    }
  },
  {
    gatsby: {
      downloads: 444063,
      forks: 7870,
      stars: 44480,
      watchers: 977,
      url: 'github.com/gatsbyjs/gatsby'
    }
  },
  {
    'firebase-functions': {
      downloads: 433052,
      forks: 100,
      stars: 707,
      watchers: 109,
      url: 'github.com/firebase/firebase-functions'
    }
  }
]

dependents's People

Contributors

Stargazers

Watchers

dependents's Issues

Add CI

Hi,

I'd like propose and help to setup CI via GitHub Actions for this repo.
Just let me know if it is OK for you.

Issues with JSON output mode

Using dependents 0.2.0 on Node.js 14.8.0 I ran:

dependents --package nano -n 200 --json > output.json

Clipped output:

[
  // clipped first 99 entries for github posting
  {
    'dlay-core': {
      downloads: 1,
      forks: 3,
      stars: 16,
      watchers: 2,
      url: 'github.com/dlay-io/dlay-core'
    }
  },
  ... 100 more items
]

The ... 100 more items is from the actual output. Also for valid JSON all strings would need to be double-quoted. I haven't had a chance to look at your code but from the output I'm guessing that util.inspect is being used instead of JSON.stringify.

Recommend Projects