tmp

Author: flakey5

src/generators/json-all/example.json

@@ -0,0 +1,89 @@
+// @ts-check
+'use strict';
+
+import { writeFile, readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { parse as jsoncParse } from 'jsonc-parser';
+
+// TODO add test w/ https://www.npmjs.com/package/jsonschema
+
+/**
+ * TODO docs
+ *
+ * @typedef {Array<ApiDocMetadataEntry>} Input
+ *
+ * @type {GeneratorMetadata<Input, Array<import('./generated.d.ts').NodeJsAPIDocumentationSchema>>}
+ */
+export default {
+  name: 'json-all',
+
+  // This should be kept in sync with the JSON schema version
+  version: '2.0.0',
+
+  description: 'TODO',
+
+  dependsOn: 'json',
+
+  /**
+   * Generates a JSON file.
+   *
+   * @param {Input} input
+   * @param {Partial<GeneratorOptions>} param1
+   * @returns {Promise<any>}
+   */
+  async generate(input, { output }) {
+    const generatedValue = {
+      $schema: './node-doc-all-schema.jsonc',
+      modules: [],
+      text: []
+    }
+
+    const propertiesToIgnore = [
+      '$schema',
+      'source',
+    ]
+
+    input.forEach(section => {
+      const copiedSection = {};
+
+      Object.keys(section).forEach(key => {
+        if (!propertiesToIgnore.includes(key)) {
+          copiedSection[key] = section[key];
+        }
+      })
+
+      switch (section.type) {
+        case 'module':
+          generatedValue.modules.push(copiedSection);
+          break;
+        case 'text':
+          generatedValue.text.push(copiedSection);
+          break;
+        default:
+          throw new TypeError(`unsupported root section type ${section.type}`);
+      }
+    })
+
+    if (output) {
+      // Current directory path relative to the `index.mjs` file
+      const baseDir = import.meta.dirname;
+
+      // Read the contents of the JSON schema
+      const schemaString = await readFile(
+        join(baseDir, 'schema.jsonc'),
+        'utf8'
+      );
+
+      // Parse the JSON schema into an object
+      const schema = await jsoncParse(schemaString);
+
+      // Write the parsed JSON schema to the output directory
+      // await writeFile(
+      //   join(output, 'node-doc-schema.json'),
+      //   JSON.stringify(schema)
+      // );
+    }
+
+    return generatedValue;
+  },
+};

src/generators/json-all/index.mjs

@@ -1,15 +1,17 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "nodejs-api-doc-all@v0.0.0",
+  "$id": "nodejs-api-doc-all@v2.0.0", // This should be kept in sync with the generator version.
   "title": "Node.js API Documentation Schema (All)",
   "readOnly": true,
 
   "properties": {
     "modules": {
       "type": "array",
-      // TODO figure out how to reference the other file here
-      // "items": { "$ref": "http://json-schema.org/draft-07/schema#" }
-      "items": { "$ref": "../json/parsed-schema.json" },
+      "items": { "$ref": "../json/schema.jsonc/#/definitions/Module" },
     },
+    "text": {
+      "type": "array",
+      "items": { "$ref": "../json/schema.jsonc/#/definitions/Text" }
+    }
   },
 }

src/generators/json-all/schema.jsonc

@@ -3,7 +3,7 @@
 
 import { writeFile, readFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { parse } from 'jsonc-parser';
+import { parse as jsoncParse } from 'jsonc-parser';
 import { groupNodesByModule } from '../../utils/generators.mjs';
 import { createSectionBuilder } from './utils/createSection.mjs';
 
@@ -50,7 +50,7 @@ export default {
     const processModuleNodes = head => {
       const nodes = groupedModules.get(head.api);
       if (!nodes) {
-        throw new TypeError('TODO');
+        throw new TypeError(`no grouped nodes found for ${head.api}`);
       }
 
       const section = buildSection(head, nodes);
@@ -92,7 +92,7 @@ export default {
       );
 
       // Parse the JSON schema into an object
-      const schema = await parse(schemaString);
+      const schema = await jsoncParse(schemaString);
 
       // Write the parsed JSON schema to the output directory
       // await writeFile(

src/generators/json/index.mjs

@@ -14,6 +14,8 @@ export const createMethodSectionBuilder = () => {
    */
   const parseSignatures = (entry, section) => {
     section.signatures = [];
+
+    
   };
 
   /**

src/generators/json/utils/createMethodSection.mjs

@@ -45,7 +45,7 @@ export const createSectionBuilder = () => {
     /**
      * @type {import('../types.d.ts').Section}
      */
-    const section = createSectionBase(entry, parent?.type);
+    const section = (createSectionBase(entry, parent?.type));
 
     section.parent = parent;
 
@@ -63,23 +63,29 @@ export const createSectionBuilder = () => {
         // createPropertySection(entry, parent, section);
         break;
       case 'text':
+        if (parent) {
+          parent.text ??= [];
+
+          parent.text.push(section);
+        }
+
         break;
       default:
         throw new TypeError(`unhandled section type ${section.type}`);
     }
 
     handleChildren(entry, section);
 
-    if (parent) {
-      if (!parent.tmp) {
-        parent.tmp = [];
-      }
-      parent.tmp.push(section);
-    }
-    // console.debug(section);
-
     delete section.parent;
 
+    // if (parent) {
+    //   if (!parent.tmp) {
+    //     parent.tmp = [];
+    //   }
+    //   parent.tmp.push(section);
+    // }
+    // console.debug(section);
+
     return section;
   };
 

src/generators/json/utils/createSection.mjs

@@ -58,7 +58,6 @@ export const createSectionBaseBuilder = () => {
       switch (node.type) {
         case 'paragraph': {
           addDescriptionAndExamples(section, node.children);
-
           break;
         }
         case 'emphasis': {

src/generators/json/utils/createSectionBase.mjs

@@ -1,6 +1,7 @@
 'use strict';
 
 /**
+ * Finds the closest parent section with the specified type(s).
  * @param {import('../types.d.ts').Section} section
  * @param {import('../generated.d.ts').SectionBase['type'] | Array<import('../generated.d.ts').SectionBase['type']>} type
  * @returns {import('../types.d.ts').Section | undefined}