pkg-stats 0.5.0 → 0.7.0

package/dist/__tests__/cli-options.test.js

@@ -0,0 +1,18 @@
+import { expect, test } from 'vitest';
+import { parseCliOptions } from '../cli-options.js';
+test('parseCliOptions defaults to version sorting', () => {
+    const options = parseCliOptions(['node', 'pkg-stats', 'react', '--color', 'atlas']);
+    expect(options.sort).toBe('version');
+});
+test('parseCliOptions supports download sorting', () => {
+    const options = parseCliOptions([
+        'node',
+        'pkg-stats',
+        'react',
+        '--sort',
+        'downloads',
+        '--color',
+        'atlas',
+    ]);
+    expect(options.sort).toBe('downloads');
+});

package/dist/__tests__/output.test.js

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

package/dist/__tests__/stats.test.js

@@ -0,0 +1,50 @@
+import { expect, test } from 'vitest';
+import { downloadCompare, filterStats } from '../stats.js';
+const stats = [
+    {
+        version: { major: 3 },
+        versionString: '3.x',
+        downloads: 100,
+    },
+    {
+        version: { major: 2 },
+        versionString: '2.x',
+        downloads: 300,
+    },
+    {
+        version: { major: 1 },
+        versionString: '1.x',
+        downloads: 200,
+    },
+];
+test('filterStats keeps top downloads in version order by default', () => {
+    expect(filterStats(stats, {
+        totalDownloads: 600,
+        top: 2,
+    }).map((stat) => stat.versionString)).toEqual(['2.x', '1.x']);
+});
+test('downloadCompare sorts by downloads descending', () => {
+    expect([...stats].sort(downloadCompare).map((stat) => stat.versionString)).toEqual([
+        '2.x',
+        '1.x',
+        '3.x',
+    ]);
+});
+test('downloadCompare falls back to version order for ties', () => {
+    const tiedStats = [
+        {
+            version: { major: 1 },
+            versionString: '1.x',
+            downloads: 100,
+        },
+        {
+            version: { major: 2 },
+            versionString: '2.x',
+            downloads: 100,
+        },
+    ];
+    expect([...tiedStats].sort(downloadCompare).map((stat) => stat.versionString)).toEqual([
+        '2.x',
+        '1.x',
+    ]);
+});

package/dist/cli-options.js

@@ -12,9 +12,9 @@ Options:
   ${colorOption('--major')}               Group by major version
   ${colorOption('--minor')}               Group by minor version
   ${colorOption('--patch')}               Group by patch version
+  ${colorOption('--sort')} <order>        Sort results by version or downloads
   ${colorOption('-t, --top')} <number>    Show top <number> most downloaded versions
   ${colorOption('-a, --all')}             Include all versions in output, even those with minimal downloads
-  ${colorOption('-x, --extended')}        Show extended stats
   ${colorOption('-c, --color')} <scheme>  ${wrapOption(`Choose color scheme from: ${COLOR_SCHEMES.sort().join(', ')}`, 50, 24)}
 
 Examples:
@@ -49,6 +49,7 @@ function wrapOption(text, maxLength, indent) {
 export function showHelp() {
     console.log(redent(HELP, 2));
 }
+const SORT_ORDERS = ['version', 'downloads'];
 export function parseCliOptions(argv) {
     const cli = meow(HELP, {
         argv: argv.slice(2),
@@ -70,6 +71,10 @@ export function parseCliOptions(argv) {
             patch: {
                 type: 'boolean',
             },
+            sort: {
+                type: 'string',
+                choices: [...SORT_ORDERS],
+            },
             top: {
                 shortFlag: 't',
                 type: 'number',
@@ -78,10 +83,6 @@ export function parseCliOptions(argv) {
                 type: 'boolean',
                 shortFlag: 'a',
             },
-            extended: {
-                type: 'boolean',
-                shortFlag: 'x',
-            },
             color: {
                 shortFlag: 'c',
                 type: 'string',
@@ -105,11 +106,17 @@ export function parseCliOptions(argv) {
                     ? 'patch'
                     : undefined,
         top: cli.flags.top,
+        sort: coalesceSortOrder(cli.flags.sort) ?? 'version',
         all: cli.flags.all ?? false,
-        extended: cli.flags.extended ?? false,
-        color: coalesceColor(cli.flags.color) ?? getColorOfDay(),
+        color: coalesceColor(cli.flags.color ?? process.env.PKG_STATS_COLOR_SCHEME) ?? getColorOfDay(),
     };
 }
+function coalesceSortOrder(sort) {
+    if (sort && SORT_ORDERS.includes(sort)) {
+        return sort;
+    }
+    return undefined;
+}
 function coalesceColor(color) {
     if (color && COLOR_SCHEMES.includes(color)) {
         return color;

package/dist/mode/compare-packages.js

@@ -16,7 +16,7 @@ export async function comparePackages(packageNames, options) {
     const items = packagesToDisplay.map((item) => ({
         label: item.packageName,
         value: item.downloads,
-        extended: options.extended ? formatPercentage(item.downloads / maxDownloads) : undefined,
+        extra: formatPercentage(item.downloads / maxDownloads),
     }));
     printChart(items, {
         colorScheme: options.color,

package/dist/mode/package-stats.js

@@ -3,7 +3,7 @@ import { getPrimaryColor } from '../colors.js';
 import { formatPercentage } from '../format.js';
 import { fetchNpmLastWeekDownloads } from '../npm-api.js';
 import { printChart } from '../output.js';
-import { filterStats, groupStats } from '../stats.js';
+import { downloadCompare, filterStats, groupStats } from '../stats.js';
 import { parseVersion, versionCompare } from '../version.js';
 export async function printPackageStats(packageName, options) {
     let data;
@@ -29,11 +29,14 @@ export async function printPackageStats(packageName, options) {
         .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, {
+    const filteredStats = filterStats(stats, {
         totalDownloads,
         all: options.all,
         top: options.top,
     });
+    const statsToDisplay = options.sort === 'downloads'
+        ? [...filteredStats].sort(downloadCompare)
+        : filteredStats;
     const downloadToDisplay = statsToDisplay.reduce((sum, version) => sum + version.downloads, 0);
     if (totalDownloads - downloadToDisplay > 0) {
         statsToDisplay.push({
@@ -48,7 +51,7 @@ export async function printPackageStats(packageName, options) {
     const items = statsToDisplay.map((item) => ({
         label: item.versionString,
         value: item.downloads,
-        extended: options.extended ? formatPercentage(item.downloads / totalDownloads) : undefined,
+        extra: formatPercentage(item.downloads / totalDownloads),
     }));
     printChart(items, {
         colorScheme: options.color,

package/dist/output.js

@@ -5,24 +5,29 @@ export function printChart(items, options) {
     const maxLabelLength = Math.max(...items.map((item) => item.label.length));
     const maxValue = Math.max(...items.map((item) => item.value));
     const maxValueLength = formatDownloads(maxValue, maxValue).length;
-    const maxExtendedLength = Math.max(...items.map((item) => item.extended?.length ?? 0));
+    const maxExtraLength = Math.max(...items.map((item) => item.extra?.length ?? 0));
     const colors = getColors(items.length, options.colorScheme);
     const indent = options.indent ?? 0;
+    const chartWidth = getTerminalWidth() - indent - maxLabelLength - maxValueLength - maxExtraLength - 5;
     items.forEach((item, i) => {
         const color = chalk.hex(colors[i]);
         const label = ' '.repeat(indent) + item.label.padStart(maxLabelLength);
-        const bar = formatBar(item.value / maxValue);
+        const bar = formatBar(item.value / maxValue, { width: clamp(chartWidth, 30, 60) });
         const value = formatDownloads(item.value, maxValue).padStart(maxValueLength);
-        const extended = item.extended
-            ? chalk.dim(` ${item.extended}`.padStart(maxExtendedLength + 1))
-            : '';
-        console.log(`${label} ${color(bar)} ${color(value)}${extended}`);
+        const extra = item.extra ? chalk.dim(` ${item.extra}`.padStart(maxExtraLength + 1)) : '';
+        console.log(`${label} ${color(bar)} ${color(value)}${extra}`);
     });
 }
-export function formatBar(value, { length = 50 } = {}) {
-    const filledChars = Math.round(value * length);
+export function formatBar(value, { width = 50 } = {}) {
+    const filledChars = Math.round(value * width);
     if (filledChars === 0) {
-        return '▏' + ' '.repeat(length - 1);
+        return '▏' + ' '.repeat(width - 1);
     }
-    return '█'.repeat(filledChars) + ' '.repeat(length - filledChars);
+    return '█'.repeat(filledChars) + ' '.repeat(width - filledChars);
+}
+export function getTerminalWidth() {
+    return process.stdout.columns;
+}
+function clamp(value, min, max) {
+    return Math.min(Math.max(value, min), max);
 }

package/dist/stats.js

@@ -81,7 +81,11 @@ export function filterStats(stats, options) {
     return filtered;
 }
 function pickTopStats(stats, top) {
-    const sortedStats = stats.sort((a, b) => b.downloads - a.downloads);
+    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));
 }
+export function downloadCompare(a, b) {
+    const downloadDifference = b.downloads - a.downloads;
+    return downloadDifference === 0 ? versionCompare(a.version, b.version) : downloadDifference;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkg-stats",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Beautiful NPM package download stats",
   "license": "MIT",
   "repository": {
@@ -24,6 +24,9 @@
   "bin": {
     "pkg-stats": "./bin.js"
   },
+  "engines": {
+    "node": ">=22.13.0"
+  },
   "scripts": {
     "build": "tsc",
     "test": "vitest",
@@ -33,22 +36,22 @@
     "validate": "pnpm lint && pnpm typecheck && pnpm test -- --no-watch"
   },
   "dependencies": {
-    "chalk": "^5.4.1",
-    "meow": "^13.2.0",
+    "chalk": "^5.6.2",
+    "meow": "^14.1.0",
     "redent": "^4.0.0",
-    "tinygradient": "^1.1.5"
+    "tinygradient": "^2.0.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.18.0",
-    "@release-it/conventional-changelog": "^10.0.0",
-    "@types/node": "^22.10.5",
-    "eslint": "^9.18.0",
+    "@eslint/js": "^9.39.4",
+    "@release-it/conventional-changelog": "^11.0.1",
+    "@types/node": "^22.19.20",
+    "eslint": "^9.39.4",
     "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"
+    "globals": "^15.15.0",
+    "release-it": "^20.2.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.61.0",
+    "vitest": "^2.1.9"
   },
-  "packageManager": "pnpm@9.15.3+sha512.1f79bc245a66eb0b07c5d4d83131240774642caaa86ef7d0434ab47c0d16f66b04e21e0c086eb61e62c77efc4d7f7ec071afad3796af64892fae66509173893a"
+  "packageManager": "pnpm@11.5.3+sha512.7ac1c919341c213a34dc0d02afb7143c5c26ac26ee8c4782deea821b8ac64d2134a081fd8941dae6e29bbb48f58dfc2b7fbceeccc07cb2f09d219d342a4969ed"
 }

package/dist/__tests__/output.js

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

package/dist/chart.js

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

package/dist/mode/package-details.js

@@ -1,57 +0,0 @@
-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-info.js

@@ -1,64 +0,0 @@
-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 fetchPackageInfo(packageName, options) {
-    const data = await fetchNpmLastWeekDownloads(packageName);
-    if (!Object.keys(data.downloads).length) {
-        throw new Error(`No data found for package "${packageName}".`);
-    }
-    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);
-    return {
-        name: packageName,
-        totalDownloads,
-        groupingType: type,
-        stats: stats.map((stat) => ({
-            version: stat.versionString,
-            downloads: stat.downloads,
-        })),
-    };
-}
-export function printPackageInfo({ name, stats, totalDownloads, groupingType }, options) {
-    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(name)}\n`));
-    console.log(`Total: ${primaryColor(totalDownloads.toLocaleString())} last week\n`);
-    console.log(options.top
-        ? `Top ${options.top} ${groupingType} versions:\n`
-        : `By ${groupingType} version:\n`);
-    const maxDownloads = Math.max(...stats.map((v) => v.downloads));
-    const displayData = statsToDisplay.map((item) => {
-        const versionParts = item.version.split('.');
-        return {
-            version: versionParts.length < 3 ? `${item.version}.x` : item.version,
-            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(chalk.bold(`\nNPM weekly downloads for ${chalk.green(name)}\n`));
-    console.log(`Total: ${chalk.green(totalDownloads.toLocaleString())} last week\n`);
-}

package/dist/mode/single-package.js

@@ -1,58 +0,0 @@
-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/render.js

@@ -1,23 +0,0 @@
-import { style } from './style.js';
-export function renderChart(value) {
-    const filledValues = Math.round(value * style.chart.width * style.chart.pattern.length);
-    if (filledValues === 0) {
-        return '▏' + (style.rightLabel === 'align-right' ? ' '.repeat(style.chart.width - 1) : '');
-    }
-    const fullBlocks = Math.floor(filledValues / style.chart.pattern.length);
-    const partialBlock = filledValues % style.chart.pattern.length;
-    const hasPartialBlock = partialBlock > 0;
-    return (style.chart.pattern.at(-1).repeat(fullBlocks) +
-        (hasPartialBlock ? style.chart.pattern.at(partialBlock) : '') +
-        (style.rightLabel === 'align-right'
-            ? ' '.repeat(style.chart.width - fullBlocks - (hasPartialBlock ? 1 : 0))
-            : ''));
-}
-// export type RenderChartLineOptions = {
-//   value: number;
-//   leftLabel: string;
-//   rightLabel: string;
-// };
-// export function renderChartLine({ value, leftLabel, rightLabel }: RenderChartLineOptions) {
-//   return `${leftLabel}${renderChart(value)}${rightLabel}`;
-// }

package/dist/style.js

@@ -1,16 +0,0 @@
-export const style = {
-    chart: {
-        width: 50,
-        //pattern: ['⏹'],
-        //pattern: ['⏺'],
-        //pattern: ['█'],
-        //pattern: [' ', '▎', '▌', '▊', '█'],
-        //pattern: [' ', '▩'],
-        //pattern: [' ', '▰'],
-        //pattern: [' ', '∎'],
-        pattern: [' ', '█'],
-        //pattern: [' ', '▓'],
-        zeroPattern: '▏',
-    },
-    rightLabel: 'align-right',
-};

package/dist/types.js

@@ -1 +0,0 @@
-export {};