npm-downloads-counter

This is a CLI tool (and an ES module) to output an overview of the (last 30 days) download activity of all the packages maintained (or published) by a certain NPM username. I've also added support for outputting the score statistics of each package.

The tool can even push notifications (containing this output) to your Slack channel whenever there are new statistics available when the tool is ran. This could be used together with e.g. cron or systemd timers for daily updates.

I created this mainly because I wanted an easy way to monitor the popularity of the packages I've published.

Funding

If you find this useful then please consider helping me out (I'm jobless and sick). For more information visit my GitHub profile.

Cross-platform support

I've tested it successfully on Linux (my main system), Windows and macOS.

Windows usage notes

For the unicode output of this program to display correctly you'll need to use the new Windows Terminal.

Installing

Install it globally like this:

npm install -g npm-downloads-counter

Optionally install chalk to enable colors in CLI:

npm i -g chalk

Optionally install terminal-link to enable links in CLI:

npm i -g terminal-link

How to use

To list all packages published by a user (e.g. to list packages published by yourself):

npm-downloads-counter npm_username

To list all packages maintained by a user (a package can have several maintainers though):

npm-downloads-counter -m npm_username

To list (only) score statistics:

npm-downloads-counter --score npm_username

You can also run it without installing it using npx, but then it can't have colors or links in the CLI:

npx npm-downloads-counter joakimch

Example output (download stats)

Download count of packages published by joakimch the last 30 days:
|⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⣦⣀⣿⢀⠀⠀⠀⢀⠀| npm-downloads-counter 60 0-22 
|⢀⠀⠀⠀⣀⣠⢀⢀⠀⠀⠀⠀⣿⢀⢀⠀⠀⠀⠀⢀⠀⠀⠀⠀⣿⢀⠀⠀⠀⢀| ▲1 pluggable-prng 59 0-20 
|⠀⢀⠀⢀⢀⢀⢀⣾⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠀⣿⢀⠀⢀⢀⢀⠀⠀⠀⠀⢀| ▼1 bit-consumer 57 0-22 
|⠀⠀⠀⢀⢀⠀⠀⣿⠀⠀⠀⠀⠀⠀⠀⢀⠀⠀⠀⣿⢀⠀⠀⢀⢀⠀⢀⠀⠀⠀| base-endecoder 45 0-20 
|⠀⠀⠀⠀⢀⢀⠀⣾⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⠀⠀⠀⢀⠀⠀⠀⠀⠀⢀| ▲1 bit-manipulation 44 0-21 
|⢀⠀⠀⠀⢀⠀⠀⠀⠀⠀⠀⢀⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⠀⢀⠀⢀⠀| ▼1 platform-checker 44 0-20 
|⠀⠀⠀⢀⢀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠀⠀⠀⠀⢀⢀⠀⠀⣿⠀⠀⠀⠀⠀| whichever-data 30 0-24 

Summary of packages climbing the list:
pluggable-prng is up: 1
bit-manipulation is up: 1

Output explained

I've designed the output from this tool to be as minimal as it can get to easily fit in most terminal windows. Hence I feel the need to explain what you're looking at.

Each line represents a different package.

It begins with a bar graph (cleverly using unicode braille characters) to represent the "download pressure" of the last 30 days. Where a space represents a download count that day equal to the least amount of daily downloads of this period. Whereas a ⣿ symbol represents the maximum amount (but is not used when the maximum is less than 8 downloads).

The graph is followed by the package name, which is then followed by a number representing the total of downloads this period and some min-max numbers representing the minimum and maximum amount of daily downloads this period.

The lines are sorted so that the packages on top are the ones with the highest amount of downloads this period.

If the package has changed its position in the list compared to when you last ran the tool then it will be indicated by a ▲ or ▼ before the package name, together with a number representing how many lines it jumped from.

Example output (score stats)

Score list of packages published by joakimch sorted by final:
bit-consumer {
  final: 0.2816297020884584,
  quality: 0.5214210083588049,
  popularity: 0.024733028932926553,
  maintenance: 0.33299096986940757,
  searchScore: 0.00000006146252
}
whichever-data {
  final: 0.2810230954009417,
  quality: 0.5214210083588049,
  popularity: 0.022999866968593137,
  maintenance: 0.33299096986940757,
  searchScore: 0.000000058837163
}
[and so on...]

Custom configuration

This tool supports some configuration, mainly of the output format of the statistics. Below is the code that loads the config file, you can use this as an overview of what can be written in the config.json file.

Tip, use --paths to output the configDir path on your platform; this is where to place the config.json file.

const options = { // merge default with custom config
  // noColors: true, // no colors in CLI even if chalk is installed
  // noLinks: true, // no links in CLI even if terminal-link is installed
  // separateLines: true, // graph is on a separate line
  // thinBars: true, // use thin bars in graph
  displayDate: true, // date of when download-statistics was updated
  logToTerminal: true, // output the result to terminal
  climbersSummary: true, // summary of packages climbing the list
  comparePrevious: true, // show position changes of packages
  ...loadConfig(configDir+'config.json') // merge (overwriting options above)
}
if (options.slack) {
  options.slack = { // Slack only options
    // token: 'xoxb-XXXX-XXXX', // the much needed Web API token
    // channel: 'npm-downloads-counter', // which channel to post to, name or id
    // username: 'npm-downloads-counter', // custom username for message
    // icon_emoji: ':bar_chart:', // custom icon for message
    // noScores: true, // do not push notifications about scores
    // onlyUsername: 'username', // only push notifications when checking this username
    thinBars: true, // use thin bars in graph
    separateLines: true, // graph is on a separate line
    ...options.slack, // merge (overwriting options above)
    noColors: true, // not compatible with Slack
    noLinks: true // not compatible with Slack
  }
}

Slack notifications

How to setup a new Slack app for notifications

Go to https://api.slack.com/apps/ and press "Create New App", then "From scratch".

Enter the page for your app and under "Add features and functionality" press "Permissions" then scroll down to "Scopes" and add these "Bot Token Scopes" by pressing "Add an OAuth Scope":

• chat:write.public To send messages to channels it isn't a member of.
• chat:write.customize To send messages with a customized username and avatar.

Then you can scroll up to "OAuth Tokens for Your Workspace" and press "Install to Workspace". This results in a "Bot User OAuth Token" which is the token you need to use. It should look similar to this: xoxb-1234567891230-9876543219870-theAlPhaBetRoCks1234Abcz

Then in your config.json put something like this to use it:

{
  "slack": {
    "token": "xoxb-1234567891230-9876543219870-theAlPhaBetRoCks1234Abcz",
    "channel": "the-channel-to-post-in"
  }
}

I find it useful to also add:

"onlyUsername": "your_NPM_username"

So that you can check the download and score statistics of other NPM-usernames without having them pushed to your Slack channel.

Usage as an ES module

I didn't design this to be a nice and useful library (I only care about the CLI tool), but I have exported the functions used by the CLI tool so that anyone can use them. Check the documentation below to learn about them.

Module documentation

Auto-generated documentation from JSDoc

Classes

Functions

getPackages(maintainerUsername, [publisherUsername]) ⇒ Array.<object>

Get all packages where maintainerUsername is listed as one of the maintainers (anyone publishing a package is automatically listed as one). Optionally filter out any packages not published by publisherUsername (this can be used to return only packages published by this user).

Kind: global function
Returns: Array.<object> - An array of objects with details about the packages.

| Param | Type | Description | | --- | --- | --- | | maintainerUsername | string | Get all packages listed with this user as one of its maintainers. | | [publisherUsername] | string | Return only packages with this user listed as the publisher. |

getLastDownloads(packages, range) ⇒ object | Array.<object>

Get the daily download counts of a package (or packages) in the given timeframe. If doing a bulk query then limit it to <=128 packages.

Kind: global function
Returns: object | Array.<object> - {packageName, dailyDownloads} (in an array if doing a bulk query)

| Param | Type | Description | | --- | --- | --- | | packages | string | Array.<string> | The package (or packages if an array) to query. | | range | string | A range/timeframe compatible with the registry API. |

getStatistics(options) ⇒ PackageStatistics

Get either download or score statistics of all packages where maintainerUsername is listed as one of the maintainers (anyone publishing a package is automatically listed as one). Optionally filter out any packages not published by publisherUsername (this can be used to return only packages published by this user).

Kind: global function

| Param | Type | Default | Description | | --- | --- | --- | --- | | options | object | | | | options.maintainerUsername | string | | | | options.publisherUsername | string | | | | [options.range] | string | "'last-month'" | A range/timeframe compatible with the registry API (used for download stats). | | [options.withoutDownloads] | boolean | | To only get score stats. |

pushToSlack(options) ⇒ Promise.<object>

Push provided text to the channel, with customizable username and icon emoji.

Kind: global function
Returns: Promise.<object> - The result from the Slack Web API.

| Param | Type | Default | | --- | --- | --- | | options | object | | | options.token | string | | | options.channel | string | | | options.text | string | | | [options.username] | string | "'npm-downloads-counter'" | | [options.icon_emoji] | string | "':bar_chart:'" |

The End

Aliens (as in extra-terrestrial and extra-dimensional beings) 
are visiting our planet, also abducting people. 
They're mostly friendly though, I had one next to my bed once, 
it just stared at me while I was sleeping.