pkg-stats 0.2.0 → 0.3.1

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,29 +1,34 @@
 import chalk from 'chalk';
-import minimist from 'minimist';
 import { renderChart } from './chart.js';
+import { parseCliOptions, showHelp } from './cli-options.js';
 import { getColors } from './colors.js';
+import { formatDownloads } from './format.js';
+import { fetchNpmLastWeekDownloads } from './npm-api.js';
+import { groupStats, pickTopStats } from './stats.js';
 import { parseVersion, versionCompare } from './version.js';
-import { groupByType, pickTopStats } from './stats.js';
 export async function pkgStats(argv) {
-    const options = parseCliOptions(argv);
-    if (options.help) {
-        printHelp();
-        return;
+    let options;
+    try {
+        options = parseCliOptions(argv);
+    }
+    catch (error) {
+        showHelp();
+        console.error(chalk.red(`Error parsing CLI options: ${error instanceof Error ? error.message : error}`));
+        process.exit(2);
     }
     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)
+    const npmStats = Object.keys(data.downloads)
         .map((versionString) => {
         const version = parseVersion(versionString);
         return {
@@ -32,70 +37,22 @@ export async function pkgStats(argv) {
         };
     })
         .sort(versionCompare);
-    let 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;
-    const colors = getColors(groupedStatsToDisplay.length);
+    const { type, stats } = groupStats(npmStats, options.group);
+    const totalDownloads = Object.values(stats).reduce((sum, version) => sum + version.downloads, 0);
+    const statsToDisplay = options.top ? pickTopStats(stats, options.top) : stats;
+    const colors = getColors(statsToDisplay.length, options.color);
     const primaryColor = chalk.hex(colors[0]);
-    console.log(chalk.bold(`\nNPM weekly downloads for ${primaryColor(options.name)}\n`));
+    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 maxDownloads = Math.max(...groupedStats.map((v) => v.downloads));
-    groupedStatsToDisplay.forEach((item, i) => {
+    console.log(options.top ? `Top ${options.top} ${type} versions:\n` : `By ${type} version:\n`);
+    const maxDownloads = Math.max(...stats.map((v) => v.downloads));
+    statsToDisplay.forEach((item, i) => {
         const versionParts = item.versionString.split('.');
-        const version = versionParts.length < 3 ? `${item.versionString}.x` : item.versionString;
+        const versionString = 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]);
-        console.log(`${version.padStart(8)} ${color(chart)} ${color(downloads.padStart(6))}`);
+        console.log(`${versionString.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;
-    if (options.group === 'major' || options.major) {
-        group = 'major';
-    }
-    else 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 formatDownloads(downloads, maxDownloads) {
-    if (maxDownloads > 1000000) {
-        return `${(downloads / 1000000).toFixed(1)}M`;
-    }
-    if (maxDownloads > 1000) {
-        return `${(downloads / 1000).toFixed(1)}K`;
-    }
-    return downloads.toString();
-}

package/dist/cli-options.js

@@ -0,0 +1,70 @@
+import meow from 'meow';
+import redent from 'redent';
+import { COLOR_SCHEMES } from './colors.js';
+const HELP = `
+pkg-stats <package-name>
+
+Show NPM weekly downloads stats for a package
+
+Options:
+  -h, --help            Show help
+  --major               Group by major version
+  --minor               Group by minor version
+  --patch               Group by patch version
+  -t, --top <number>    Show top <number> versions
+  -c, --color <color>   Color scheme: ${COLOR_SCHEMES.sort().join(', ')}
+`;
+export function showHelp() {
+    console.log(redent(HELP, 2));
+}
+export function parseCliOptions(argv) {
+    const cli = meow(HELP, {
+        argv: argv.slice(2),
+        autoHelp: true,
+        description: 'Show NPM weekly downloads stats for a package',
+        importMeta: import.meta,
+        flags: {
+            help: {
+                type: 'boolean',
+                shortFlag: 'h',
+            },
+            major: {
+                type: 'boolean',
+                shortFlag: 'm',
+            },
+            minor: {
+                type: 'boolean',
+            },
+            patch: {
+                type: 'boolean',
+            },
+            top: {
+                shortFlag: 't',
+                type: 'number',
+            },
+            color: {
+                shortFlag: 'c',
+                type: 'string',
+                choices: COLOR_SCHEMES,
+            },
+        },
+    });
+    if (cli.flags.help) {
+        cli.showHelp();
+    }
+    if (!cli.input[0]) {
+        throw new Error('<package-name> is required');
+    }
+    return {
+        packageName: cli.input[0],
+        group: cli.flags.major
+            ? 'major'
+            : cli.flags.minor
+                ? 'minor'
+                : cli.flags.patch
+                    ? 'patch'
+                    : undefined,
+        top: cli.flags.top,
+        color: cli.flags.color,
+    };
+}

package/dist/colors.js

@@ -9,7 +9,7 @@ const gradients = {
     vice: { colors: ['#5ee7df', '#b490ca'], options: { interpolation: 'hsv' } },
     passion: { colors: ['#f43b47', '#453a94'], options: {} },
     fruit: { colors: ['#ff4e50', '#f9d423'], options: {} },
-    instagram: { colors: ['#833ab4', '#fd1d1d', '#fcb045'], options: {} },
+    insta: { colors: ['#833ab4', '#fd1d1d', '#fcb045'], options: {} },
     retro: {
         colors: [
             '#3f51b1',
@@ -25,20 +25,30 @@ const gradients = {
         options: {},
     },
     summer: { colors: ['#fdbb2d', '#22c1c3'], options: {} },
-    rainbow: { colors: ['#ff0000', '#ff0100'], options: { interpolation: 'hsv', hsvSpin: 'long' } },
-    pastel: { colors: ['#74ebd5', '#74ecd5'], options: { interpolation: 'hsv', hsvSpin: 'long' } },
+    rainbow: {
+        colors: ['#ff0100', '#ff0000'],
+        options: { interpolation: 'hsv', hsvSpin: 'long', padEnd: 0.1 },
+    },
+    pastel: {
+        colors: ['#74ebd5', '#74ecd5'],
+        options: { interpolation: 'hsv', hsvSpin: 'long', padEnd: 0.1 },
+    },
 };
+export const COLOR_SCHEMES = Object.keys(gradients);
 export function getColors(count, colorScheme) {
-    const { colors, options } = gradients[colorScheme ?? getRandomScheme()];
-    if (count < colors.length) {
+    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(count, options.hsvSpin ?? false)
-        : gradient.rgb(count);
+        ? gradient.hsv(paddedCount, options.hsvSpin ?? false)
+        : gradient.rgb(paddedCount);
     return tinyColors.map((c) => c.toHexString());
 }
-function getRandomScheme() {
-    return Object.keys(gradients)[Math.floor(Math.random() * Object.keys(gradients).length)];
+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/format.js

@@ -0,0 +1,9 @@
+export function formatDownloads(downloads, maxDownloads) {
+    if (maxDownloads > 1000000) {
+        return `${(downloads / 1000000).toFixed(1)}M`;
+    }
+    if (maxDownloads > 1000) {
+        return `${(downloads / 1000).toFixed(1)}K`;
+    }
+    return downloads.toString();
+}

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

@@ -1,23 +1,23 @@
 import { versionCompare } from './version.js';
-export function groupByType(type, stats) {
+export function groupStats(stats, type) {
     if (type === 'major') {
-        return groupByMajor(stats);
+        return { type: 'major', stats: groupByMajor(stats) };
     }
     if (type === 'minor') {
-        return groupByMinor(stats);
+        return { type: 'minor', stats: groupByMinor(stats) };
     }
     if (type === 'patch') {
-        return groupByPatch(stats);
+        return { type: 'patch', stats: groupByPatch(stats) };
     }
     const groupedByMajor = groupByMajor(stats);
-    if (groupedByMajor.length > 1) {
-        return groupedByMajor;
+    if (groupedByMajor.length >= 3) {
+        return { type: 'major', stats: groupedByMajor };
     }
     const groupedByMinor = groupByMinor(stats);
-    if (groupedByMinor.length > 1) {
-        return groupedByMinor;
+    if (groupedByMinor.length >= 3) {
+        return { type: 'minor', stats: groupedByMinor };
     }
-    return groupByPatch(stats);
+    return { type: 'patch', stats: groupByPatch(stats) };
 }
 function groupByMajor(stats) {
     const result = {};

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "pkg-stats",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "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,31 @@
   "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",
+    "meow": "^13.2.0",
+    "redent": "^4.0.0",
     "tinygradient": "^1.1.5"
   },
   "devDependencies": {
-    "@types/minimist": "^1.2.5",
+    "@eslint/js": "^9.18.0",
+    "@release-it/conventional-changelog": "^10.0.0",
     "@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",
+    "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"
+}