pkg-stats 0.0.1 → 0.1.1

package/bin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { pkgStats } from './dist/index.js';
+
+pkgStats(process.argv.slice(2));

package/dist/bin.js

@@ -1,10 +1,27 @@
-import { renderChart } from "./chart.js";
-import { parseVersion, versionCompare } from "./version.js";
-const PACKAGE_NAME = process.argv[2];
-const NPM_STATS_URL = `https://api.npmjs.org/versions/${encodeURIComponent(PACKAGE_NAME)}/last-week`;
-export async function bin() {
-    const response = await fetch(NPM_STATS_URL);
-    const data = await response.json();
+import chalk from 'chalk';
+import minimist from 'minimist';
+import { renderChart } from './chart.js';
+import { gradients } from './colors.js';
+import { parseVersion, versionCompare } from './version.js';
+export async function pkgStats(argv) {
+    const options = parseCliOptions(argv);
+    if (options.help) {
+        printHelp();
+        return;
+    }
+    let data;
+    try {
+        const response = await fetch(`https://api.npmjs.org/versions/${encodeURIComponent(options.name)}/last-week`);
+        data = await response.json();
+    }
+    catch (error) {
+        console.error(`Failed to fetch data for package "${options.name}"`);
+        return;
+    }
+    if (!Object.keys(data.downloads).length) {
+        console.error(`No data found for package "${options.name}".\n`);
+        process.exit(1);
+    }
     const rawStats = Object.keys(data.downloads)
         .map((versionString) => {
         const version = parseVersion(versionString);
@@ -14,16 +31,67 @@ export async function bin() {
         };
     })
         .sort(versionCompare);
-    const groupedStats = sumByMajor(rawStats);
+    let groupedStats;
+    if (options.group === 'patch') {
+        groupedStats = sumByPatch(rawStats);
+    }
+    else if (options.group === 'minor') {
+        groupedStats = sumByMinor(rawStats);
+    }
+    else {
+        groupedStats = sumByMajor(rawStats);
+    }
     const totalDownloads = Object.values(groupedStats).reduce((sum, version) => sum + version.downloads, 0);
-    console.log(`${PACKAGE_NAME} weekly downloads\n`);
-    console.log(`Total: ${totalDownloads.toLocaleString()}.\n`);
-    console.log("By version:\n");
+    const groupedStatsToDisplay = options.top
+        ? pickTopStats(groupedStats, options.top)
+        : groupedStats;
+    console.log(chalk.bold(`\nNPM weekly downloads for ${chalk.cyan(options.name)}\n`));
+    console.log(`Total: ${chalk.cyan(totalDownloads.toLocaleString())}\n`);
+    console.log(options.top ? `Top ${options.top} versions:\n` : 'By version:\n');
+    const colors = gradients.passion(groupedStatsToDisplay.length);
     const maxDownloads = Math.max(...groupedStats.map((v) => v.downloads));
-    for (const item of groupedStats) {
-        console.log(`${item.versionString.padStart(6)} ${renderChart(item.downloads / maxDownloads)} ${formatDownloads(item.downloads, maxDownloads).padStart(6)}`);
+    groupedStatsToDisplay.forEach((item, i) => {
+        const version = options.group != 'patch' ? `${item.versionString}.x` : item.versionString;
+        const chart = renderChart(item.downloads / maxDownloads);
+        const downloads = formatDownloads(item.downloads, maxDownloads);
+        const color = chalk.hex(colors[i]);
+        console.log(`${version.padStart(8)} ${color(chart)} ${color(downloads.padStart(6))}`);
+    });
+    console.log('');
+}
+function parseCliOptions(argv) {
+    const options = minimist(argv, {
+        string: ['group', 'top'],
+        boolean: ['help'],
+        alias: { g: 'group', h: 'help', t: 'top' },
+    });
+    let group = 'major';
+    if (options.group === 'minor' || options.minor) {
+        group = 'minor';
+    }
+    else if (options.group === 'patch' || options.patch) {
+        group = 'patch';
     }
-    console.log(`\nGenerated on ${new Date().toISOString().slice(0, 10)} by npm-stats.`);
+    const top = options.top ? parseInt(options.top) : undefined;
+    if (!options._[0]) {
+        console.error('Package name is required');
+        process.exit(1);
+    }
+    return { name: options._[0], group, help: options.help, top };
+}
+function printHelp() {
+    console.log(`
+    Usage:
+      pkg-stats [options] <package-name>
+
+    Options:
+      -h, --help       Show help
+      --group <group>  Group by major, minor, or patch (default: major)
+      --major          Group by major
+      --minor          Group by minor
+      --patch          Group by patch
+      --top <number>   Show top <number> versions
+  `);
 }
 function sumByMajor(stats) {
     const result = {};
@@ -80,3 +148,8 @@ function formatDownloads(downloads, maxDownloads) {
     }
     return downloads.toString();
 }
+function pickTopStats(stats, top) {
+    const sortedStats = stats.sort((a, b) => b.downloads - a.downloads);
+    const topStats = sortedStats.slice(0, top);
+    return topStats.sort((a, b) => versionCompare(a.version, b.version));
+}

package/dist/chart.js

@@ -1,5 +1,5 @@
 export function renderChart(value, { length = 50 } = {}) {
     const filledChars = Math.round(value * length);
     const emptyChars = length - filledChars;
-    return "█".repeat(filledChars) + " ".repeat(emptyChars);
+    return '█'.repeat(filledChars) + ' '.repeat(emptyChars);
 }

package/dist/colors.js

@@ -0,0 +1,11 @@
+import tinygradient from 'tinygradient';
+// See: https://github.com/bokub/gradient-string/blob/465e86c8499a7f427c45afb1861f1444a2db74b9/src/index.ts#L166
+export const gradients = {
+    mind: (count) => toColors(tinygradient(['#473b7b', '#3584a7', '#30d2be']).rgb(count)),
+    pastel: (count) => toColors(tinygradient(['#74ebd5', '#74ecd5']).hsv(count, 'long')),
+    passion: (count) => toColors(tinygradient(['#f43b47', '#453a94']).rgb(count)),
+    retro: (count) => toColors(tinygradient(['#4150AB', '#AE6F97', '#EFCB84']).rgb(count)),
+};
+function toColors(colors) {
+    return colors.map((c) => c.toHexString());
+}

package/dist/index.js

@@ -1,2 +1 @@
-import { bin } from "./bin.js";
-bin();
+export { pkgStats } from './bin.js';

package/dist/version.js

@@ -1,6 +1,6 @@
 export function parseVersion(version) {
-    const [versionCore, preRelease] = version.split("-");
-    const [major, minor, patch] = versionCore.split(".");
+    const [versionCore, preRelease] = version.split('-');
+    const [major, minor, patch] = versionCore.split('.');
     return {
         major: Number(major),
         minor: Number(minor),

package/package.json

@@ -1,21 +1,35 @@
 {
   "name": "pkg-stats",
-  "version": "0.0.1",
-  "description": "Beautiful package download stats",
+  "version": "0.1.1",
+  "description": "Beautiful NPM package download stats",
+  "author": "Maciej Jastrzębski <mdjastrzebski@gmail.com> (https://github.com/mdjastrzebski)",
+  "license": "MIT",
+  "keywords": [
+    "npm",
+    "package",
+    "stats",
+    "downloads",
+    "weekly"
+  ],
   "type": "module",
   "main": "dist/index.js",
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc"
+  "bin": {
+    "pkg-stats": "./bin.js"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "minimist": "^1.2.8",
+    "tinygradient": "^1.1.5"
   },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "packageManager": "pnpm@9.15.0+sha512.76e2379760a4328ec4415815bcd6628dee727af3779aaa4c914e3944156c4299921a89f976381ee107d41f12cfa4b66681ca9c718f0668fa0831ed4c6d8ba56c",
   "devDependencies": {
+    "@types/minimist": "^1.2.5",
     "@types/node": "^22.10.5",
     "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "tsc"
   }
-}
+}