pkg-stats 0.1.1 → 0.3.0

package/README.md

@@ -1,3 +1,16 @@
 ## PKG Stats
 
-Beautiful package download stats.
+Beautiful NPM package download stats.
+
+```
+npx pkg-stats react
+```
+
+<div align='center'>
+  <img src="https://raw.githubusercontent.com/mdjastrzebski/pkg-stats/main/docs/public/example-react.png" alt="pkg-stats" height="210" width="538" />
+</div>
+
+### Options:
+
+- version grouping: `--group major|minor|patch` (alias `-g`, `--major`, `--minor`, `--patch`)
+- top version: `--top <number>` (alias `-t`)

package/bin.js

@@ -2,4 +2,4 @@
 
 import { pkgStats } from './dist/index.js';
 
-pkgStats(process.argv.slice(2));
+pkgStats(process.argv);

package/dist/__tests__/chart.test.js

@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest';
+import { renderChart } from '../chart.js';
+test('renderChart basic tests', () => {
+    expect(renderChart(0.0, { length: 10 })).toMatchInlineSnapshot(`"          "`);
+    expect(renderChart(0.5, { length: 10 })).toMatchInlineSnapshot(`"█████     "`);
+    expect(renderChart(1.0, { length: 10 })).toMatchInlineSnapshot(`"██████████"`);
+});

package/dist/bin.js

@@ -1,25 +1,22 @@
 import chalk from 'chalk';
-import minimist from 'minimist';
 import { renderChart } from './chart.js';
-import { gradients } from './colors.js';
+import { parseCliOptions } from './cli-options.js';
+import { getColors } from './colors.js';
+import { fetchNpmLastWeekDownloads } from './npm-api.js';
+import { groupByType, pickTopStats } from './stats.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();
+        data = await fetchNpmLastWeekDownloads(options.packageName);
     }
     catch (error) {
-        console.error(`Failed to fetch data for package "${options.name}"`);
+        console.error(`Failed to fetch data for package "${options.packageName}"`, error);
         return;
     }
     if (!Object.keys(data.downloads).length) {
-        console.error(`No data found for package "${options.name}".\n`);
+        console.error(`No data found for package "${options.packageName}".\n`);
         process.exit(1);
     }
     const rawStats = Object.keys(data.downloads)
@@ -31,27 +28,20 @@ export async function pkgStats(argv) {
         };
     })
         .sort(versionCompare);
-    let groupedStats;
-    if (options.group === 'patch') {
-        groupedStats = sumByPatch(rawStats);
-    }
-    else if (options.group === 'minor') {
-        groupedStats = sumByMinor(rawStats);
-    }
-    else {
-        groupedStats = sumByMajor(rawStats);
-    }
+    const groupedStats = groupByType(options.group, rawStats);
     const totalDownloads = Object.values(groupedStats).reduce((sum, version) => sum + version.downloads, 0);
     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`);
+    const colors = getColors(groupedStatsToDisplay.length, options.color);
+    const primaryColor = chalk.hex(colors[0]);
+    console.log(chalk.bold(`\nNPM weekly downloads for ${primaryColor(options.packageName)}\n`));
+    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\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));
     groupedStatsToDisplay.forEach((item, i) => {
-        const version = options.group != 'patch' ? `${item.versionString}.x` : item.versionString;
+        const versionParts = item.versionString.split('.');
+        const version = versionParts.length < 3 ? `${item.versionString}.x` : item.versionString;
         const chart = renderChart(item.downloads / maxDownloads);
         const downloads = formatDownloads(item.downloads, maxDownloads);
         const color = chalk.hex(colors[i]);
@@ -59,86 +49,6 @@ export async function pkgStats(argv) {
     });
     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';
-    }
-    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 = {};
-    for (const versionStats of stats) {
-        const key = `${versionStats.major}`;
-        const entry = result[key] ?? {
-            version: { major: versionStats.major },
-            versionString: key,
-            downloads: 0,
-        };
-        result[key] = entry;
-        entry.downloads += versionStats.downloads;
-    }
-    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
-}
-function sumByMinor(stats) {
-    const result = {};
-    for (const versionStats of stats) {
-        const key = `${versionStats.major}.${versionStats.minor}`;
-        const entry = result[key] ?? {
-            version: { major: versionStats.major, minor: versionStats.minor },
-            versionString: key,
-            downloads: 0,
-        };
-        result[key] = entry;
-        entry.downloads += versionStats.downloads;
-    }
-    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
-}
-function sumByPatch(stats) {
-    const result = {};
-    for (const versionStats of stats) {
-        const key = `${versionStats.major}.${versionStats.minor}.${versionStats.patch}`;
-        const entry = result[key] ?? {
-            version: {
-                major: versionStats.major,
-                minor: versionStats.minor,
-                patch: versionStats.patch,
-            },
-            versionString: key,
-            downloads: 0,
-        };
-        result[key] = entry;
-        entry.downloads += versionStats.downloads;
-    }
-    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
-}
 function formatDownloads(downloads, maxDownloads) {
     if (maxDownloads > 1000000) {
         return `${(downloads / 1000000).toFixed(1)}M`;
@@ -148,8 +58,3 @@ 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/cli-options.js

@@ -0,0 +1,24 @@
+import { program } from 'commander';
+import { COLOR_SCHEMES } from './colors.js';
+export function parseCliOptions(argv) {
+    program
+        .name('pkg-stats')
+        .description('Show NPM weekly downloads stats for a package')
+        .argument('<package-name>', 'Package name')
+        .option('--major', 'Group by major version')
+        .option('--minor', 'Group by minor version')
+        .option('--patch', 'Group by patch version')
+        .option('-t, --top <number>', 'Show top <number> versions')
+        .option('-c, --color <color>', 'Color scheme: ' + COLOR_SCHEMES.join(', '))
+        .parse(argv);
+    const args = program.args;
+    const options = program.opts();
+    return {
+        packageName: args[0],
+        group: options.major ? 'major' : options.minor ? 'minor' : options.patch ? 'patch' : undefined,
+        top: options.top !== undefined ? parseInt(options.top) : undefined,
+        color: options.color && COLOR_SCHEMES.includes(options.color)
+            ? options.color
+            : undefined,
+    };
+}

package/dist/colors.js

@@ -1,11 +1,54 @@
 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)),
+const gradients = {
+    atlas: { colors: ['#feac5e', '#c779d0', '#4bc0c8'], options: {} },
+    cristal: { colors: ['#bdfff3', '#4ac29a'], options: {} },
+    teen: { colors: ['#77a1d3', '#79cbca', '#e684ae'], options: {} },
+    mind: { colors: ['#473b7b', '#3584a7', '#30d2be'], options: {} },
+    morning: { colors: ['#ff5f6d', '#ffc371'], options: { interpolation: 'hsv' } },
+    vice: { colors: ['#5ee7df', '#b490ca'], options: { interpolation: 'hsv' } },
+    passion: { colors: ['#f43b47', '#453a94'], options: {} },
+    fruit: { colors: ['#ff4e50', '#f9d423'], options: {} },
+    insta: { colors: ['#833ab4', '#fd1d1d', '#fcb045'], options: {} },
+    retro: {
+        colors: [
+            '#3f51b1',
+            '#5a55ae',
+            '#7b5fac',
+            '#8f6aae',
+            '#a86aa4',
+            '#cc6b8e',
+            '#f18271',
+            '#f3a469',
+            '#f7c978',
+        ],
+        options: {},
+    },
+    summer: { colors: ['#fdbb2d', '#22c1c3'], options: {} },
+    rainbow: {
+        colors: ['#ff0100', '#ff0000'],
+        options: { interpolation: 'hsv', hsvSpin: 'long', padEnd: 0.1 },
+    },
+    pastel: {
+        colors: ['#74ebd5', '#74ecd5'],
+        options: { interpolation: 'hsv', hsvSpin: 'long', padEnd: 0.1 },
+    },
 };
-function toColors(colors) {
-    return colors.map((c) => c.toHexString());
+export const COLOR_SCHEMES = Object.keys(gradients);
+export function getColors(count, colorScheme) {
+    const { colors, options } = gradients[colorScheme ?? getColorOfDay()];
+    const paddedCount = count + (options.padEnd ? Math.ceil(count * options.padEnd) : 0);
+    if (paddedCount < colors.length) {
+        return colors;
+    }
+    const gradient = tinygradient(colors);
+    const tinyColors = options.interpolation === 'hsv'
+        ? gradient.hsv(paddedCount, options.hsvSpin ?? false)
+        : gradient.rgb(paddedCount);
+    return tinyColors.map((c) => c.toHexString());
+}
+function getColorOfDay() {
+    const date = new Date();
+    const index = date.getDate() + date.getMonth() * 30 + date.getFullYear() * 360;
+    return COLOR_SCHEMES[index % COLOR_SCHEMES.length];
 }

package/dist/npm-api.js

@@ -0,0 +1,14 @@
+export async function fetchNpmLastWeekDownloads(packageName) {
+    const response = await fetch(`https://api.npmjs.org/versions/${encodeURIComponent(packageName)}/last-week`);
+    if (!response.ok) {
+        throw new Error(`Failed to fetch data for package "${packageName}. Status: ${response.status}`);
+    }
+    const json = await response.json();
+    if (!json.downloads) {
+        throw new Error('No downloads found');
+    }
+    return {
+        package: packageName,
+        downloads: json.downloads,
+    };
+}

package/dist/stats.js

@@ -0,0 +1,72 @@
+import { versionCompare } from './version.js';
+export function groupByType(type, stats) {
+    if (type === 'major') {
+        return groupByMajor(stats);
+    }
+    if (type === 'minor') {
+        return groupByMinor(stats);
+    }
+    if (type === 'patch') {
+        return groupByPatch(stats);
+    }
+    const groupedByMajor = groupByMajor(stats);
+    if (groupedByMajor.length > 1) {
+        return groupedByMajor;
+    }
+    const groupedByMinor = groupByMinor(stats);
+    if (groupedByMinor.length > 1) {
+        return groupedByMinor;
+    }
+    return groupByPatch(stats);
+}
+function groupByMajor(stats) {
+    const result = {};
+    for (const versionStats of stats) {
+        const key = `${versionStats.major}`;
+        const entry = result[key] ?? {
+            version: { major: versionStats.major },
+            versionString: key,
+            downloads: 0,
+        };
+        result[key] = entry;
+        entry.downloads += versionStats.downloads;
+    }
+    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
+}
+function groupByMinor(stats) {
+    const result = {};
+    for (const versionStats of stats) {
+        const key = `${versionStats.major}.${versionStats.minor}`;
+        const entry = result[key] ?? {
+            version: { major: versionStats.major, minor: versionStats.minor },
+            versionString: key,
+            downloads: 0,
+        };
+        result[key] = entry;
+        entry.downloads += versionStats.downloads;
+    }
+    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
+}
+function groupByPatch(stats) {
+    const result = {};
+    for (const versionStats of stats) {
+        const key = `${versionStats.major}.${versionStats.minor}.${versionStats.patch}`;
+        const entry = result[key] ?? {
+            version: {
+                major: versionStats.major,
+                minor: versionStats.minor,
+                patch: versionStats.patch,
+            },
+            versionString: key,
+            downloads: 0,
+        };
+        result[key] = entry;
+        entry.downloads += versionStats.downloads;
+    }
+    return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
+}
+export 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/package.json

@@ -1,9 +1,14 @@
 {
   "name": "pkg-stats",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Beautiful NPM package download stats",
-  "author": "Maciej Jastrzębski <mdjastrzebski@gmail.com> (https://github.com/mdjastrzebski)",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mdjastrzebski/pkg-stats"
+  },
+  "homepage": "https://github.com/mdjastrzebski/pkg-stats",
+  "author": "Maciej Jastrzębski <mdjastrzebski@gmail.com> (https://github.com/mdjastrzebski)",
   "keywords": [
     "npm",
     "package",
@@ -19,17 +24,32 @@
   "bin": {
     "pkg-stats": "./bin.js"
   },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint",
+    "release": "release-it",
+    "validate": "pnpm lint && pnpm typecheck && pnpm test -- --no-watch"
+  },
   "dependencies": {
     "chalk": "^5.4.1",
-    "minimist": "^1.2.8",
+    "commander": "^13.0.0",
     "tinygradient": "^1.1.5"
   },
   "devDependencies": {
+    "@eslint/js": "^9.18.0",
+    "@release-it/conventional-changelog": "^10.0.0",
     "@types/minimist": "^1.2.5",
     "@types/node": "^22.10.5",
-    "typescript": "^5.7.3"
+    "eslint": "^9.18.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "globals": "^15.14.0",
+    "redent": "^4.0.0",
+    "release-it": "^18.1.1",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.19.1",
+    "vitest": "^2.1.8"
   },
-  "scripts": {
-    "build": "tsc"
-  }
-}
+  "packageManager": "pnpm@9.15.3+sha512.1f79bc245a66eb0b07c5d4d83131240774642caaa86ef7d0434ab47c0d16f66b04e21e0c086eb61e62c77efc4d7f7ec071afad3796af64892fae66509173893a"
+}