feat: add sorting to default command

Closes: #24

README.md

@@ -64,6 +64,7 @@ OPTIONS
   --transitiveOnly     Only include transitive dependencies [boolean]
   --duplicatesOnly     Only include modules that have duplicates in a resulting bundle [boolean]
   --ignore             Comma separated list of glob patterns to exclude modules from final output [string]
+  --sortBy             Sort modules, available fields: size, imported. E.g. size:asc or size:desc. [string]
   --help               Output usage information
   --version            Output the version number
 

commands/by.ts

@@ -6,6 +6,7 @@ import { analyze, getStats } from "../lib";
 import { vlidateStatsJson } from "../lib/validate";
 import { log, invalidStatsJson } from "../lib/console/messages";
 import { normalizeStats } from "../lib/normalize-stats";
+import { sortDefault } from "./common/sort-modules";
 
 /**
  * Shows all modules that were brought into the bundle by a particular module.
@@ -43,6 +44,7 @@ export default async function byCommand(
     ? modulesOnlyBy(report.modules, by)
     : modulesFollowingDepsChain(report.modules, by);
 
+  sortDefault(modules);
   defaultReporter.print(modules, report.chunks, { by: by }, limit);
 
   const timing = (Date.now() - start) / 1000;

commands/common/sort-modules.ts

@@ -0,0 +1,37 @@
+import type { Module } from "../../lib/analyze";
+
+export function sortModules(
+  modules: Array<Module>,
+  maybeKey: string,
+  order: string = "asc"
+) {
+  const allowedKeys = new Set(["size", "imported"]);
+  if (!allowedKeys.has(maybeKey)) {
+    return sortDefault(modules);
+  }
+
+  const key = maybeKey as keyof Module;
+
+  switch (order) {
+    case "asc":
+      return sortAscByKey(modules, key);
+
+    case "desc":
+      return sortDescByKey(modules, key);
+
+    default:
+      return sortDefault(modules);
+  }
+}
+
+function sortAscByKey(arr: Array<Module>, key: keyof Module) {
+  arr.sort((a, b) => (a[key] > b[key] ? 1 : a[key] === b[key] ? 0 : -1));
+}
+
+function sortDescByKey(arr: Array<Module>, key: keyof Module) {
+  arr.sort((a, b) => (a[key] > b[key] ? -1 : a[key] === b[key] ? 0 : 1));
+}
+
+export function sortDefault(arr: Array<Module>) {
+  arr.sort((a, b) => b.imported - a.imported);
+}

commands/index.ts

@@ -5,6 +5,8 @@ import { log, invalidStatsJson } from "../lib/console/messages";
 import { normalizeStats } from "../lib/normalize-stats";
 import { reporter as defaultReporter } from "../lib/reporter";
 import { createProgressBar } from "../lib/console/progress-bar";
+import type { Module } from "../lib/analyze";
+import { sortModules } from "./common/sort-modules";
 
 /**
  * Whybundled – Why the hell is this module in a bundle?
@@ -17,10 +19,12 @@ import { createProgressBar } from "../lib/console/progress-bar";
  * @param {boolean} transitiveOnly Only include transitive dependencies
  * @param {boolean} duplicatesOnly Only include modules that have duplicates in a resulting bundle
  * @param {string} ignore Comma separated list of glob patterns to exclude modules from final output
+ * @param {string} sortBy Sort modules, available fields: size, imported. E.g. size:asc or size:desc.
  *
  * @usage {cliName} stats.json [pattern]
  * @example whybundled stats.json --ignore babel-runtime,tslib
  * @example whybundled stats.json --modulesOnly
+ * @example whybundled stats.json --sortBy size:asc
  * @example whybundled by stats.json styled-components
  */
 export default async function defaultCommand(
@@ -31,7 +35,8 @@ export default async function defaultCommand(
   directOnly?: boolean,
   transitiveOnly?: boolean,
   duplicatesOnly?: boolean,
-  ignore?: string
+  ignore?: string,
+  sortBy?: string
 ) {
   const start = Date.now();
   const [statsFilePath, pattern] = $inputs;
@@ -67,6 +72,9 @@ export default async function defaultCommand(
   });
 
   const updatedLimit = pattern ? 0 : limit >= 0 ? limit : 20;
+  const [sortKey, sortOrder] = (sortBy || "").split(":");
+  sortModules(modules, sortKey, sortOrder);
+
   defaultReporter.print(modules, report.chunks, {}, updatedLimit);
 
   const timing = (Date.now() - start) / 1000;