feat: add a multi-package mode so that classes are exported under a module instead of at the top level of the API (#23)

Author: MarshallOfSound

src/DocsParser.ts

@@ -40,6 +40,7 @@ export class DocsParser {
     private moduleVersion: string,
     private apiFiles: string[],
     private structureFiles: string[],
+    private packageMode: 'single' | 'multi',
   ) {}
 
   private async parseBaseContainers(
@@ -132,6 +133,7 @@ export class DocsParser {
     const allTokens = md.parse(contents, {});
 
     const baseInfos = await this.parseBaseContainers(filePath, contents, allTokens);
+    let lastModule: ModuleDocumentationContainer | null = null;
     for (const { container, tokens, isClass } of baseInfos) {
       let isElement = false;
       if (container.name.endsWith('` Tag')) {
@@ -189,6 +191,11 @@ export class DocsParser {
           instanceEvents: parseEventBlocks(findContentInsideHeader(tokens, 'Instance Events', 3)),
           instanceName,
         });
+        // If we're inside a module, pop off the class and put it in the module as an exported class
+        // Only do this in "multi package" mode as when we are in a single package mode everything is exported at the
+        // top level.  In multi-package mode things are exported under each module so we need the nesting to be correct
+        if (this.packageMode === 'multi' && lastModule)
+          lastModule.exportedClasses.push(parsed.pop() as ClassDocumentationContainer);
       } else {
         // This is a module
         if (isElement) {
@@ -214,7 +221,10 @@ export class DocsParser {
             properties: parsePropertyBlocks(findContentInsideHeader(tokens, 'Properties', 2)),
             // ## Events
             events: parseEventBlocks(findContentInsideHeader(tokens, 'Events', 2)),
+            // ## Class: MyClass
+            exportedClasses: [],
           });
+          lastModule = parsed[parsed.length - 1] as ModuleDocumentationContainer;
         }
       }
     }

src/ParsedDocumentation.ts

@@ -91,6 +91,7 @@ export declare type ModuleDocumentationContainer = {
   instanceProperties?: undefined;
   staticProperties?: undefined;
   staticMethods?: undefined;
+  exportedClasses: ClassDocumentationContainer[];
 } & BaseDocumentationContainer;
 export declare type StructureDocumentationContainer = {
   type: 'Structure';

src/bin.ts

@@ -9,9 +9,17 @@ import pretty from 'pretty-ms';
 import { parseDocs } from '.';
 import chalk from 'chalk';
 
-const args = minimist(process.argv);
+const args = minimist(process.argv, {
+  default: {
+    packageMode: 'single',
+  },
+});
 
-const { dir, outDir, help } = args;
+const { dir, outDir, packageMode, help } = args;
+if (!['single', 'multi'].includes(packageMode)) {
+  console.error(chalk.red('packageMode must be one of "single" and "multi"'));
+  process.exit(1);
+}
 
 if (help) {
   console.info(
@@ -58,6 +66,7 @@ fs.mkdirp(resolvedOutDir).then(() =>
   parseDocs({
     baseDirectory: resolvedDir,
     moduleVersion: pj.version,
+    packageMode,
   })
     .then(data =>
       fs.writeJson(path.resolve(resolvedOutDir, './electron-api.json'), data, {

src/index.ts

@@ -5,16 +5,19 @@ import { DocsParser } from './DocsParser';
 type ParseOptions = {
   baseDirectory: string;
   moduleVersion: string;
+  packageMode?: 'single' | 'multi';
 };
 
 export async function parseDocs(options: ParseOptions) {
+  const packageMode = options.packageMode || 'single';
   const electronDocsPath = path.resolve(options.baseDirectory, 'docs', 'api');
 
   const parser = new DocsParser(
     options.baseDirectory,
     options.moduleVersion,
     await getAllMarkdownFiles(electronDocsPath),
     await getAllMarkdownFiles(path.resolve(electronDocsPath, 'structures')),
+    packageMode,
   );
 
   return await parser.parse();