chore: minor improvements

Author: ovflowd

src/generators/ast-js/index.mjs

@@ -6,6 +6,7 @@ import createJsLoader from '../../loaders/javascript.mjs';
 import createJsParser from '../../parsers/javascript.mjs';
 
 const { loadFiles } = createJsLoader();
+
 const { parseJsSource } = createJsParser();
 
 /**
@@ -38,17 +39,11 @@ export default {
    * @returns {Promise<object[]>} Parsed JS AST objects for each file
    */
   async processChunk(inputSlice, itemIndices) {
-    const results = [];
-
-    for (const idx of itemIndices) {
-      const [file] = loadFiles(inputSlice[idx]);
+    const filePaths = itemIndices.map(idx => inputSlice[idx]);
 
-      const parsedFile = await parseJsSource(file);
-
-      results.push(parsedFile);
-    }
+    const vfiles = await Promise.all(loadFiles(filePaths));
 
-    return results;
+    return Promise.all(vfiles.map(parseJsSource));
   },
 
   /**

src/generators/ast/index.mjs

@@ -1,37 +1,15 @@
 'use strict';
 
-import { readFile } from 'node:fs/promises';
 import { extname } from 'node:path';
 
 import { globSync } from 'glob';
-import { VFile } from 'vfile';
 
-import createQueries from '../../utils/queries/index.mjs';
+import createLoader from '../../loaders/markdown.mjs';
 import { getRemark } from '../../utils/remark.mjs';
 
-const remarkProcessor = getRemark();
-
-const { updateStabilityPrefixToLink } = createQueries();
-
-/**
- * Parses a single markdown file into an AST.
- *
- * @param {string} filePath - Path to the markdown file
- * @returns {Promise<ParserOutput<import('mdast').Root>>}
- */
-const parseMarkdownFile = async filePath => {
-  const fileContents = await readFile(filePath, 'utf-8');
-
-  const vfile = new VFile({ path: filePath, value: fileContents });
+const { loadFiles } = createLoader();
 
-  // Normalizes all the Stability Index prefixes with Markdown links
-  updateStabilityPrefixToLink(vfile);
-
-  // Parses the API doc into an AST tree using `unified` and `remark`
-  const tree = remarkProcessor.parse(vfile);
-
-  return { file: { stem: vfile.stem, basename: vfile.basename }, tree };
-};
+const remarkProcessor = getRemark();
 
 /**
  * This generator parses Markdown API doc files into AST trees.
@@ -57,15 +35,17 @@ export default {
    * @returns {Promise<Array<ParserOutput<import('mdast').Root>>>}
    */
   async processChunk(inputSlice, itemIndices) {
-    const results = [];
+    const filePaths = itemIndices.map(idx => inputSlice[idx]);
 
-    for (const idx of itemIndices) {
-      const parsed = await parseMarkdownFile(inputSlice[idx]);
+    const vfiles = await Promise.all(loadFiles(filePaths));
 
-      results.push(parsed);
-    }
+    return vfiles.map(vfile => {
+      const tree = remarkProcessor.parse(vfile);
+
+      const minimalVfile = { stem: vfile.stem, basename: vfile.basename };
 
-    return results;
+      return { file: minimalVfile, tree };
+    });
   },
 
   /**

src/loaders/markdown.mjs

@@ -0,0 +1,44 @@
+'use strict';
+
+import { readFile } from 'node:fs/promises';
+import { extname } from 'node:path';
+
+import { globSync } from 'glob';
+import { VFile } from 'vfile';
+
+import createQueries from '../utils/queries/index.mjs';
+
+const { updateStabilityPrefixToLink } = createQueries();
+
+/**
+ * This creates a "loader" for loading Markdown API doc files into VFiles.
+ */
+const createLoader = () => {
+  /**
+   * Loads Markdown source files and transforms them into VFiles.
+   * Applies stability index normalization during load.
+   *
+   * @param {string | string[]} searchPath - Glob pattern(s) or file paths
+   * @returns {Promise<VFile>[]} Array of promises resolving to VFiles
+   */
+  const loadFiles = searchPath => {
+    const resolvedFiles = globSync(searchPath).filter(
+      filePath => extname(filePath) === '.md'
+    );
+
+    return resolvedFiles.map(async filePath => {
+      const fileContents = await readFile(filePath, 'utf-8');
+
+      const vfile = new VFile({ path: filePath, value: fileContents });
+
+      // Normalizes all the Stability Index prefixes with Markdown links
+      updateStabilityPrefixToLink(vfile);
+
+      return vfile;
+    });
+  };
+
+  return { loadFiles };
+};
+
+export default createLoader;