wip

Author: AugustinMauroy

fixtures/addons.md

@@ -7,7 +7,6 @@ import { remove } from 'unist-util-remove';
 
 import createQueries from '../../queries.mjs';
 import { getRemark } from '../../utils/remark.mjs';
-import { createProgressBar } from '../../utils/progressBar.mjs';
 
 /**
  * This generator generates a simplified JSON version of the API docs and returns it as a string
@@ -34,10 +33,6 @@ export default {
     // Gets a remark processor for stringifying the AST tree into JSON
     const remarkProcessor = getRemark();
 
-    // Creates a progress bar for the JSON generation
-    const progressBar = createProgressBar('Generating JSON');
-    progressBar.start(input.length, 0);
-
     // Iterates the input (ApiDocMetadataEntry) and performs a few changes
     const mappedInput = input.map(node => {
       // Deep clones the content nodes to avoid affecting upstream nodes
@@ -53,13 +48,9 @@ export default {
       // For the JSON generate we want to transform the whole content into JSON
       content.toJSON = () => remarkProcessor.stringify(content);
 
-      progressBar.increment();
-
       return { ...node, content };
     });
 
-    progressBar.stop();
-
     // This simply grabs all the different files and stringifies them
     const stringifiedContent = JSON.stringify(mappedInput);
 

fixtures/assert.md

@@ -11,7 +11,6 @@ import tableOfContents from './utils/tableOfContents.mjs';
 
 import { groupNodesByModule } from '../../utils/generators.mjs';
 import { getRemarkRehype } from '../../utils/remark.mjs';
-import { createProgressBar } from '../../utils/progressBar.mjs';
 
 /**
  * @typedef {{
@@ -148,10 +147,6 @@ export default {
       return replaceTemplateValues(generatedTemplate);
     };
 
-    // Creates a progress bar to show the progress of the generation process
-    const progressBar = createProgressBar('Generating HTML files');
-    progressBar.start(headNodes.length, 0);
-
     for (const node of headNodes) {
       const result = processModuleNodes(node);
 
@@ -162,12 +157,8 @@ export default {
       });
 
       await writeFile(join(output, `${node.api}.html`), minified);
-      progressBar.increment();
     }
 
-    // Stops the progress bar and clears the line
-    progressBar.stop();
-
     // Define the output folder for API docs assets
     const assetsFolder = join(output, 'assets');
 

fixtures/async_context.md

@@ -6,7 +6,7 @@ import { extname } from 'node:path';
 import { globSync } from 'glob';
 import { VFile } from 'vfile';
 
-import { createProgressBar } from './utils/progressBar.mjs';
+import createProgressBar from './utils/progressBar.mjs';
 
 /**
  * This method creates a simple abstract "Loader", which technically

src/generators/json-simple/index.mjs

@@ -11,6 +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';
 
 /**
  * Creates an API doc parser for a given Markdown API doc file
@@ -177,7 +178,18 @@ const createParser = () => {
   const parseApiDocs = async apiDocs => {
     // 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 resolvedApiDocEntries = await Promise.all(apiDocs.map(parseApiDoc));
+
+    const progressBar = createProgressBar('Parsing API Docs');
+    progressBar.start(apiDocs.length, 0);
+
+    const resolvedApiDocEntries = await Promise.all(
+      apiDocs.map(async apiDoc => {
+        progressBar.increment();
+        return await parseApiDoc(apiDoc);
+      })
+    );
+
+    progressBar.stop();
 
     return resolvedApiDocEntries.flat();
   };

src/generators/legacy-html/index.mjs

@@ -2,6 +2,8 @@
 
 import { coerce } from 'semver';
 
+import createProgressBar from './progressBar.mjs';
+
 /**
  * Groups all the API metadata nodes by module (`api` property) so that we can process each different file
  * based on the module it belongs to.
@@ -12,14 +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);
+
   for (const node of nodes) {
     if (!groupedNodes.has(node.api)) {
       groupedNodes.set(node.api, []);
     }
 
     groupedNodes.get(node.api).push(node);
+    progressBar.increment();
   }
 
+  progressBar.stop();
+
   return groupedNodes;
 };
 

src/loader.mjs

@@ -3,11 +3,14 @@ import { styleText } from 'node:util';
 import cliProgress from 'cli-progress';
 
 /**
+ *
+ * Create a progress bar instance
+ * with our custom format
  *
  * @param {string} label
  * @returns {import('cli-progress').SingleBar}
  */
-export function createProgressBar(label = '') {
+function createProgressBar(label = '') {
   const format = ` ${styleText(['bold', 'green'], '{bar}')} | ${label} {percentage}% | {value}/{total}`;
 
   return new cliProgress.SingleBar({
@@ -17,3 +20,5 @@ export function createProgressBar(label = '') {
     hideCursor: true,
   });
 }
+
+export default createProgressBar;

src/parser.mjs

@@ -3,7 +3,7 @@ import { test } from 'node:test';
 
 import cliProgress from 'cli-progress';
 
-import { createProgressBar } from '../progressBar.mjs';
+import createProgressBar from '../progressBar.mjs';
 
 /**
  * Simple test to unsure that the progress bar is created