tmp

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

package-lock.json

@@ -46,6 +46,8 @@
     "hast-util-to-string": "^3.0.1",
     "hastscript": "^9.0.1",
     "html-minifier-terser": "^7.2.0",
+    "json-schema-to-typescript": "^15.0.4",
+    "jsonc-parser": "^3.3.1",
     "rehype-stringify": "^10.0.1",
     "remark-gfm": "^4.0.1",
     "remark-parse": "^11.0.0",

package.json

@@ -9,6 +9,7 @@ import legacyJsonAll from './legacy-json-all/index.mjs';
 import addonVerify from './addon-verify/index.mjs';
 import apiLinks from './api-links/index.mjs';
 import oramaDb from './orama-db/index.mjs';
+import json from './json/index.mjs';
 
 export default {
   'json-simple': jsonSimple,
@@ -20,4 +21,5 @@ export default {
   'addon-verify': addonVerify,
   'api-links': apiLinks,
   'orama-db': oramaDb,
+  json: json,
 };

src/generators/index.mjs

@@ -0,0 +1,86 @@
+// @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

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "[email protected]", // This should be kept in sync with the generator version.
+  "title": "Node.js API Documentation Schema (All)",
+  "readOnly": true,
+
+  "properties": {
+    "modules": {
+      "type": "array",
+      "items": { "$ref": "../json/schema.jsonc/#/definitions/Module" },
+    },
+    "text": {
+      "type": "array",
+      "items": { "$ref": "../json/schema.jsonc/#/definitions/Text" },
+    },
+  },
+}

src/generators/json-all/schema.jsonc

@@ -0,0 +1 @@
+'use strict';