use clack

Author: AugustinMauroy

src/loader.mjs

@@ -6,7 +6,7 @@ import { extname } from 'node:path';
 import { globSync } from 'glob';
 import { VFile } from 'vfile';
 
-import createProgressBar from './utils/progressBar.mjs';
+import { Spinner } from './utils/spinner.mjs';
 
 /**
  * This method creates a simple abstract "Loader", which technically
@@ -28,18 +28,18 @@ const createLoader = () => {
       filePath => extname(filePath) === '.md'
     );
 
-    const progressBar = createProgressBar('Loading files');
-
-    progressBar.start(resolvedFiles.length, 0);
+    const spinner = new Spinner();
+    spinner.total = resolvedFiles.length;
+    spinner.start();
 
     return resolvedFiles.map(async filePath => {
       const fileContents = await readFile(filePath, 'utf-8');
-      progressBar.increment();
+      spinner.update(1);
 
-      // normally we stop the progress bar when the loop is done
+      // normally we stop the spinner when the loop is done
       // but here we return the loop so we need to stop it when the last file is loaded
-      if (progressBar.value === progressBar.total) {
-        progressBar.stop();
+      if (spinner.progress === spinner.total) {
+        spinner.stop();
       }
 
       return new VFile({ path: filePath, value: fileContents });

src/parser.mjs

@@ -11,7 +11,7 @@ import createQueries from './queries.mjs';
 
 import { getRemark } from './utils/remark.mjs';
 import { createNodeSlugger } from './utils/slugger.mjs';
-import createProgressBar from './utils/progressBar.mjs';
+import { Spinner } from './utils/spinner.mjs';
 
 /**
  * Creates an API doc parser for a given Markdown API doc file
@@ -179,18 +179,19 @@ const createParser = () => {
     // We do a Promise.all, to ensure that each API doc is resolved asynchronously
     // but all need to be resolved first before we return the result to the caller
 
-    const progressBar = createProgressBar('Parsing API Docs');
-    progressBar.start(apiDocs.length, 0);
+    const spinner = new Spinner();
+    spinner.start();
+    spinner.total = apiDocs.length;
 
     const resolvedApiDocEntries = await Promise.all(
       apiDocs.map(apiDoc => {
-        progressBar.increment();
+        spinner.update(1);
 
         return parseApiDoc(apiDoc);
       })
     );
 
-    progressBar.stop();
+    spinner.stop();
 
     return resolvedApiDocEntries.flat();
   };

src/utils/generators.mjs

@@ -2,7 +2,7 @@
 
 import { coerce } from 'semver';
 
-import createProgressBar from './progressBar.mjs';
+import { Spinner } from '../utils/spinner.mjs';
 
 /**
  * Groups all the API metadata nodes by module (`api` property) so that we can process each different file
@@ -14,19 +14,20 @@ export const groupNodesByModule = nodes => {
   /** @type {Map<string, Array<ApiDocMetadataEntry>>} */
   const groupedNodes = new Map();
 
-  const progressBar = createProgressBar(groupNodesByModule.name);
-  progressBar.start(nodes.length, 0);
+  const spinner = new Spinner();
+  spinner.total = nodes.length;
+  spinner.start();
 
   for (const node of nodes) {
     if (!groupedNodes.has(node.api)) {
       groupedNodes.set(node.api, []);
     }
 
     groupedNodes.get(node.api).push(node);
-    progressBar.increment();
+    spinner.update(1);
   }
 
-  progressBar.stop();
+  spinner.stop();
 
   return groupedNodes;
 };