pkg-stats 0.3.1 → 0.4.0

package/dist/__tests__/chart.test.js

@@ -1,7 +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.0, { length: 10 })).toMatchInlineSnapshot(`"▏         "`);
     expect(renderChart(0.5, { length: 10 })).toMatchInlineSnapshot(`"█████     "`);
     expect(renderChart(1.0, { length: 10 })).toMatchInlineSnapshot(`"██████████"`);
 });

package/dist/bin.js

@@ -1,11 +1,7 @@
 import chalk from 'chalk';
-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 { comparePackages } from './mode/compare-packages.js';
+import { printPackageStats } from './mode/package-stats.js';
 export async function pkgStats(argv) {
     let options;
     try {
@@ -16,43 +12,11 @@ export async function pkgStats(argv) {
         console.error(chalk.red(`Error parsing CLI options: ${error instanceof Error ? error.message : error}`));
         process.exit(2);
     }
-    let data;
-    try {
-        data = await fetchNpmLastWeekDownloads(options.packageName);
-    }
-    catch (error) {
-        console.error(`Failed to fetch data for package "${options.packageName}"`, error);
-        return;
+    if (options.packageNames.length === 1) {
+        await printPackageStats(options.packageNames[0], options);
     }
-    if (!Object.keys(data.downloads).length) {
-        console.error(`No data found for package "${options.packageName}".\n`);
-        process.exit(1);
+    else {
+        await comparePackages(options.packageNames, options);
     }
-    const npmStats = Object.keys(data.downloads)
-        .map((versionString) => {
-        const version = parseVersion(versionString);
-        return {
-            ...version,
-            downloads: data.downloads[versionString],
-        };
-    })
-        .sort(versionCompare);
-    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.packageName)}\n`));
-    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\n`);
-    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 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(`${versionString.padStart(8)} ${color(chart)} ${color(downloads.padStart(6))}`);
-    });
     console.log('');
 }

package/dist/chart.js

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

package/dist/cli-options.js

@@ -1,19 +1,50 @@
+import chalk from 'chalk';
 import meow from 'meow';
 import redent from 'redent';
 import { COLOR_SCHEMES } from './colors.js';
+const colorCommand = chalk.hex('#22c1c3');
+const colorOption = chalk.hex('#fdbb2d');
 const HELP = `
-pkg-stats <package-name>
-
-Show NPM weekly downloads stats for a package
+  ${colorCommand('pkg-stats')} <package> - Show version stats
+  ${colorCommand('pkg-stats')} <package-1> <package-2>... - Compare between packages
 
 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(', ')}
+  ${colorOption('--major')}               Group by major version
+  ${colorOption('--minor')}               Group by minor version
+  ${colorOption('--patch')}               Group by patch version
+  ${colorOption('-t, --top')} <number>    Show top <number> most downloaded versions
+  ${colorOption('-a, --all')}             Include all versions in output, even those with minimal downloads
+  ${colorOption('-c, --color')} <scheme>  ${wrapOption(`Choose color scheme from: ${COLOR_SCHEMES.sort().join(', ')}`, 50, 24)}
+
+Examples:
+  ${chalk.dim('# Show stats for react')}
+  ${colorCommand('pkg-stats')} react
+
+  ${chalk.dim('# Compare react, vue, angular and svelte')}
+  ${colorCommand('pkg-stats')} react vue @angular/core svelte
+
+  ${chalk.dim('# Show top 10 major versions of lodash')}
+  ${colorCommand('pkg-stats')} lodash ${colorOption('--major -t 10')}
 `;
+function wrapOption(text, maxLength, indent) {
+    const words = text.split(' ');
+    let result = '';
+    let currentLine = words[0];
+    for (let i = 1; i < words.length; i++) {
+        const nextCurrentLine = currentLine + ' ' + words[i];
+        if (nextCurrentLine.length <= maxLength) {
+            currentLine = nextCurrentLine;
+        }
+        else {
+            result += `\n${currentLine}`;
+            currentLine = words[i];
+        }
+    }
+    if (currentLine) {
+        result += `\n${currentLine}`;
+    }
+    return redent(result.trim(), indent).trim();
+}
 export function showHelp() {
     console.log(redent(HELP, 2));
 }
@@ -21,7 +52,7 @@ export function parseCliOptions(argv) {
     const cli = meow(HELP, {
         argv: argv.slice(2),
         autoHelp: true,
-        description: 'Show NPM weekly downloads stats for a package',
+        description: 'Show NPM weekly downloads stats:',
         importMeta: import.meta,
         flags: {
             help: {
@@ -42,6 +73,10 @@ export function parseCliOptions(argv) {
                 shortFlag: 't',
                 type: 'number',
             },
+            all: {
+                type: 'boolean',
+                shortFlag: 'a',
+            },
             color: {
                 shortFlag: 'c',
                 type: 'string',
@@ -52,11 +87,11 @@ export function parseCliOptions(argv) {
     if (cli.flags.help) {
         cli.showHelp();
     }
-    if (!cli.input[0]) {
-        throw new Error('<package-name> is required');
+    if (!cli.input.length) {
+        throw new Error('At least one <package-name> is required');
     }
     return {
-        packageName: cli.input[0],
+        packageNames: cli.input,
         group: cli.flags.major
             ? 'major'
             : cli.flags.minor
@@ -65,6 +100,7 @@ export function parseCliOptions(argv) {
                     ? 'patch'
                     : undefined,
         top: cli.flags.top,
+        all: cli.flags.all,
         color: cli.flags.color,
     };
 }

package/dist/mode/compare-packages.js

@@ -0,0 +1,48 @@
+import chalk from 'chalk';
+import { renderChart } from '../chart.js';
+import { getColors } from '../colors.js';
+import { formatDownloads } from '../format.js';
+import { fetchNpmLastWeekDownloads } from '../npm-api.js';
+export async function comparePackages(packageNames, options) {
+    const rawPackages = await Promise.all(packageNames.map((packageName) => fetchPackageData(packageName)));
+    const packagesToDisplay = rawPackages
+        .filter((pkg) => pkg !== undefined)
+        .sort((a, b) => b.downloads - a.downloads);
+    if (packagesToDisplay.length === 0) {
+        console.error(chalk.red('\nNo packages found.\n'));
+        process.exit(1);
+    }
+    console.log(chalk.bold(`\nNPM weekly downloads\n`));
+    const maxDownloads = Math.max(...packagesToDisplay.map((v) => v.downloads));
+    const displayData = packagesToDisplay.map((item) => {
+        return {
+            name: item.packageName,
+            chart: renderChart(item.downloads / maxDownloads),
+            downloads: formatDownloads(item.downloads, maxDownloads),
+        };
+    });
+    const maxNameLength = Math.max(...displayData.map((item) => item.name.length));
+    const maxDownloadsLength = Math.max(...displayData.map((item) => item.downloads.length));
+    const colors = getColors(packagesToDisplay.length, options.color);
+    displayData.forEach((item, i) => {
+        const color = chalk.hex(colors[i]);
+        console.log(`${item.name.padStart(2 + maxNameLength)} ${color(item.chart)} ${color(item.downloads.padStart(maxDownloadsLength))}`);
+    });
+}
+async function fetchPackageData(packageName) {
+    try {
+        const data = await fetchNpmLastWeekDownloads(packageName);
+        if (!Object.keys(data.downloads).length) {
+            console.warn(chalk.yellow(`No data found for package "${packageName}".`));
+            return undefined;
+        }
+        return {
+            packageName,
+            downloads: Object.values(data.downloads).reduce((sum, downloads) => sum + downloads, 0),
+        };
+    }
+    catch (error) {
+        console.warn(chalk.yellow(`Failed to fetch data for package "${packageName}"`, error));
+        return undefined;
+    }
+}

package/dist/mode/package-details.js

@@ -0,0 +1,57 @@
+import chalk from 'chalk';
+import { renderChart } from '../chart.js';
+import { getColors } from '../colors.js';
+import { formatDownloads } from '../format.js';
+import { fetchNpmLastWeekDownloads } from '../npm-api.js';
+import { filterStats, groupStats } from '../stats.js';
+import { parseVersion, versionCompare } from '../version.js';
+export async function packageDetails(packageName, options) {
+    let data;
+    try {
+        data = await fetchNpmLastWeekDownloads(packageName);
+    }
+    catch (error) {
+        console.error(`Failed to fetch data for package "${packageName}"`, error);
+        return;
+    }
+    if (!Object.keys(data.downloads).length) {
+        console.error(`No data found for package "${packageName}".\n`);
+        process.exit(1);
+    }
+    const npmStats = Object.keys(data.downloads)
+        .map((versionString) => {
+        const version = parseVersion(versionString);
+        return {
+            ...version,
+            downloads: data.downloads[versionString],
+        };
+    })
+        .sort(versionCompare);
+    const { type, stats } = groupStats(npmStats, options.group);
+    const totalDownloads = Object.values(stats).reduce((sum, version) => sum + version.downloads, 0);
+    const statsToDisplay = filterStats(stats, {
+        totalDownloads,
+        all: options.all,
+        top: options.top,
+    });
+    const colors = getColors(statsToDisplay.length, options.color);
+    const primaryColor = chalk.hex(colors[0]);
+    console.log(chalk.bold(`\nNPM weekly downloads for ${primaryColor(packageName)}\n`));
+    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\n`);
+    console.log(options.top ? `Top ${options.top} ${type} versions:\n` : `By ${type} version:\n`);
+    const maxDownloads = Math.max(...stats.map((v) => v.downloads));
+    const displayData = statsToDisplay.map((item) => {
+        const versionParts = item.versionString.split('.');
+        return {
+            version: versionParts.length < 3 ? `${item.versionString}.x` : item.versionString,
+            chart: renderChart(item.downloads / maxDownloads),
+            downloads: formatDownloads(item.downloads, maxDownloads),
+        };
+    });
+    const maxVersionLength = Math.max(...displayData.map((item) => item.version.length));
+    const maxDownloadsLength = Math.max(...displayData.map((item) => item.downloads.length));
+    displayData.forEach((item, i) => {
+        const color = chalk.hex(colors[i]);
+        console.log(`${item.version.padStart(2 + maxVersionLength)} ${color(item.chart)} ${color(item.downloads.padStart(maxDownloadsLength))}`);
+    });
+}

package/dist/mode/package-stats.js

@@ -0,0 +1,57 @@
+import chalk from 'chalk';
+import { renderChart } from '../chart.js';
+import { getColors } from '../colors.js';
+import { formatDownloads } from '../format.js';
+import { fetchNpmLastWeekDownloads } from '../npm-api.js';
+import { filterStats, groupStats } from '../stats.js';
+import { parseVersion, versionCompare } from '../version.js';
+export async function printPackageStats(packageName, options) {
+    let data;
+    try {
+        data = await fetchNpmLastWeekDownloads(packageName);
+    }
+    catch (error) {
+        console.error(`Failed to fetch data for package "${packageName}"`, error);
+        return;
+    }
+    if (!Object.keys(data.downloads).length) {
+        console.error(`No data found for package "${packageName}".\n`);
+        process.exit(1);
+    }
+    const npmStats = Object.keys(data.downloads)
+        .map((versionString) => {
+        const version = parseVersion(versionString);
+        return {
+            ...version,
+            downloads: data.downloads[versionString],
+        };
+    })
+        .sort(versionCompare);
+    const { type, stats } = groupStats(npmStats, options.group);
+    const totalDownloads = Object.values(stats).reduce((sum, version) => sum + version.downloads, 0);
+    const statsToDisplay = filterStats(stats, {
+        totalDownloads,
+        all: options.all,
+        top: options.top,
+    });
+    const colors = getColors(statsToDisplay.length, options.color);
+    const primaryColor = chalk.hex(colors[0]);
+    console.log(chalk.bold(`\nNPM weekly downloads for ${primaryColor(packageName)}\n`));
+    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\n`);
+    console.log(options.top ? `Top ${options.top} ${type} versions:\n` : `By ${type} version:\n`);
+    const maxDownloads = Math.max(...stats.map((v) => v.downloads));
+    const displayData = statsToDisplay.map((item) => {
+        const versionParts = item.versionString.split('.');
+        return {
+            version: versionParts.length < 3 ? `${item.versionString}.x` : item.versionString,
+            chart: renderChart(item.downloads / maxDownloads),
+            downloads: formatDownloads(item.downloads, maxDownloads),
+        };
+    });
+    const maxVersionLength = Math.max(...displayData.map((item) => item.version.length));
+    const maxDownloadsLength = Math.max(...displayData.map((item) => item.downloads.length));
+    displayData.forEach((item, i) => {
+        const color = chalk.hex(colors[i]);
+        console.log(`${item.version.padStart(2 + maxVersionLength)} ${color(item.chart)} ${color(item.downloads.padStart(maxDownloadsLength))}`);
+    });
+}

package/dist/mode/single-package.js

@@ -0,0 +1,58 @@
+import chalk from 'chalk';
+import { renderChart } from '../chart.js';
+import { getColors } from '../colors.js';
+import { formatDownloads } from '../format.js';
+import { fetchNpmLastWeekDownloads } from '../npm-api.js';
+import { filterStats, groupStats } from '../stats.js';
+import { parseVersion, versionCompare } from '../version.js';
+export async function singlePackage(packageName, options) {
+    let data;
+    try {
+        data = await fetchNpmLastWeekDownloads(packageName);
+    }
+    catch (error) {
+        console.error(`Failed to fetch data for package "${packageName}"`, error);
+        return;
+    }
+    if (!Object.keys(data.downloads).length) {
+        console.error(`No data found for package "${packageName}".\n`);
+        process.exit(1);
+    }
+    const npmStats = Object.keys(data.downloads)
+        .map((versionString) => {
+        const version = parseVersion(versionString);
+        return {
+            ...version,
+            downloads: data.downloads[versionString],
+        };
+    })
+        .sort(versionCompare);
+    const { type, stats } = groupStats(npmStats, options.group);
+    const totalDownloads = Object.values(stats).reduce((sum, version) => sum + version.downloads, 0);
+    const statsToDisplay = filterStats(stats, {
+        totalDownloads,
+        all: options.all,
+        top: options.top,
+    });
+    const colors = getColors(statsToDisplay.length, options.color);
+    const primaryColor = chalk.hex(colors[0]);
+    console.log(chalk.bold(`\nNPM weekly downloads for ${primaryColor(packageName)}\n`));
+    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\n`);
+    console.log(options.top ? `Top ${options.top} ${type} versions:\n` : `By ${type} version:\n`);
+    const maxDownloads = Math.max(...stats.map((v) => v.downloads));
+    const displayData = statsToDisplay.map((item) => {
+        const versionParts = item.versionString.split('.');
+        return {
+            version: versionParts.length < 3 ? `${item.versionString}.x` : item.versionString,
+            chart: renderChart(item.downloads / maxDownloads),
+            downloads: formatDownloads(item.downloads, maxDownloads),
+        };
+    });
+    const maxVersionLength = Math.max(...displayData.map((item) => item.version.length));
+    const maxDownloadsLength = Math.max(...displayData.map((item) => item.downloads.length));
+    displayData.forEach((item, i) => {
+        const color = chalk.hex(colors[i]);
+        console.log(`${item.version.padStart(2 + maxVersionLength)} ${color(item.chart)} ${color(item.downloads.padStart(maxDownloadsLength))}`);
+    });
+    console.log('');
+}

package/dist/stats.js

@@ -65,7 +65,17 @@ function groupByPatch(stats) {
     }
     return Object.values(result).sort((a, b) => versionCompare(a.version, b.version));
 }
-export function pickTopStats(stats, top) {
+export function filterStats(stats, options) {
+    if (options.all) {
+        return stats;
+    }
+    if (options.top) {
+        return pickTopStats(stats, options.top);
+    }
+    const downloadThreshold = 0.005 * options.totalDownloads; // 0.5%
+    return stats.filter((stat) => stat.downloads >= downloadThreshold);
+}
+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,6 +1,6 @@
 {
   "name": "pkg-stats",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Beautiful NPM package download stats",
   "license": "MIT",
   "repository": {