feat: add progress bar with example large input

Author: JDIZM

package-lock.json

@@ -21,14 +21,15 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "cac": "^6.7.14",
-    "chalk": "^4.1.2",
+    "@types/cli-progress": "^3.11.0",
     "@types/node": "^20.2.1",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",
     "@vitest/coverage-c8": "^0.32.0",
-    "eslint": "^8.37.0",
+    "cac": "^6.7.14",
+    "chalk": "^4.1.2",
     "esbuild": "^0.18.1",
+    "eslint": "^8.37.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-plugin-import": "^2.27.5",
@@ -45,5 +46,8 @@
   },
   "exports": {
     ".": "./dist/src/index.js"
+  },
+  "dependencies": {
+    "cli-progress": "^3.12.0"
   }
 }

package.json

@@ -1,3 +1,5 @@
+import { SingleBar } from "cli-progress";
+
 export const Compare = {
   LESS_THAN: -1,
   BIGGER_THAN: 1,
@@ -129,12 +131,20 @@ export const compareStrings = (a: string, b: string) => {
 };
 
 // Using Bubble Sort
-export const sortProducts = (products: ProductTuple[], method: SortMethod = "ascending") => {
+export const sortProducts = (products: ProductTuple[], method: SortMethod = "ascending", progress?: SingleBar) => {
   const result = filterProductsById(products);
+  // const result = [...products]; // uncomment to test unfiltered for longer duration sort
 
-  for (let p = 0; p < products.length; p++) {
+  if (progress) {
+    progress.start(result.length, 0);
+  }
+
+  for (let p = 0; p < result.length; p++) {
     // Outer pass
     // iterate over products
+    if (progress) {
+      progress.increment();
+    }
 
     for (let i = 0; i < result.length; i++) {
       // Inner pass
@@ -178,5 +188,9 @@ export const sortProducts = (products: ProductTuple[], method: SortMethod = "asc
     result.reverse();
   }
 
+  if (progress) {
+    progress.stop();
+  }
+
   return result;
 };

src/helpers/sort.ts

@@ -4,6 +4,7 @@ import cac from "cac";
 import { version } from "../package.json";
 import { checkColumns, readCsvSync, createCsvFile, logger, parseCsv } from "./helpers";
 import { sortProducts } from "./helpers/sort";
+import cliprogress from "cli-progress";
 
 const cli = cac();
 
@@ -39,8 +40,10 @@ async function run(args: string[], options: CliOptions = {}) {
   checkColumns(columns);
   logger.info(`processing ${rows.length} rows`);
 
+  const progress = new cliprogress.SingleBar({}, cliprogress.Presets.shades_classic);
+
   const startedSort = Date.now();
-  const sortedRows = sortProducts(rows);
+  const sortedRows = sortProducts(rows, "ascending", progress);
   const finishedSort = Date.now();
 
   const sortedProducts = [columns, ...sortedRows];