review + some formatting

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

Author: flakey5

src/generators/index.mjs

@@ -29,8 +29,6 @@ export const publicGenerators = {
   'orama-db': oramaDb,
   'llms-txt': llmsTxt,
   web,
-  'jsx-ast': jsxAst,
-  metadata,
   json,
   'json-all': jsonAll,
 };

src/generators/json-all/index.mjs

@@ -4,7 +4,7 @@
 import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 
-import { DOC_NODE_VERSION } from '../../constants.mjs';
+import { BASE_URL, DOC_NODE_VERSION } from '../../constants.mjs';
 import { generateJsonSchema } from './util/generateJsonSchema.mjs';
 
 /**
@@ -36,7 +36,7 @@ export default {
    */
   async generate(input, { version, output }) {
     const generatedValue = {
-      $schema: `https://nodejs.org/docs/${DOC_NODE_VERSION}/api/node-doc-all-schema.jsonc`,
+      $schema: `${BASE_URL}/docs/${DOC_NODE_VERSION}/api/node-doc-all-schema.jsonc`,
       modules: [],
       text: [],
     };

src/generators/json-all/util/generateJsonSchema.mjs

@@ -1,12 +1,13 @@
 'use strict';
 
+import { BASE_URL } from '../../../constants.mjs';
 import jsonAll from '../index.mjs';
 
 /**
  * @param {string} version
  */
 export function generateJsonSchema(version) {
-  const jsonSchemaUrl = `https://nodejs.org/docs/${version}/api/node-doc-schema.json`;
+  const jsonSchemaUrl = `${BASE_URL}/docs/${version}/api/node-doc-schema.json`;
 
   return {
     $schema: 'http://json-schema.org/draft-07/schema#',

src/generators/json/__tests__/index.test.mjs

@@ -1,17 +1,17 @@
 import assert from 'node:assert';
+import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { describe, test, before } from 'node:test';
 
-import { Validator } from 'jsonschema';
 import { parse as jsoncParse } from 'jsonc-parser';
+import { Validator } from 'jsonschema';
 import { SemVer } from 'semver';
 
 import createGenerator from '../../../generators.mjs';
 import createMarkdownLoader from '../../../loaders/markdown.mjs';
 import createMarkdownParser from '../../../parsers/markdown.mjs';
-import { parseSchema } from '../utils/parseSchema.mjs';
-import { readFile } from 'node:fs/promises';
 import json from '../index.mjs';
+import { parseSchema } from '../utils/parseSchema.mjs';
 
 const FIXTURES_DIR = join(import.meta.dirname, 'fixtures');
 

src/generators/json/constants.mjs

@@ -19,3 +19,32 @@ export const METHOD_RETURN_TYPE_EXTRACTOR = /^Returns(:?) {(.*)}( .*)?$/;
 // Grabs the parameters from a method's signature
 //  ex/ 'new buffer.Blob([sources[, options]])'.match(PARAM_EXPRESSION) === ['([sources[, options]])', '[sources[, options]]']
 export const METHOD_PARAM_EXPRESSION = /\((.+)\);?$/;
+
+/**
+ * Mapping of {@link HeadingMetadataEntry['type']} to types defined in the
+ * JSON schema.
+ */
+export const ENTRY_TO_SECTION_TYPE = /** @type {const} */ ({
+  var: 'property',
+  global: 'property',
+  module: 'module',
+  class: 'class',
+  ctor: 'method',
+  method: 'method',
+  classMethod: 'method',
+  property: 'property',
+  event: 'event',
+  misc: 'text',
+  text: 'text',
+  example: 'text',
+});
+
+/**
+ * Some types in the docs have different capitalization than what exists in JS
+ * @type {Record<string, string>}
+ */
+export const DOC_TYPE_TO_CORRECT_JS_TYPE_MAP = {
+  integer: 'number',
+  bigint: 'BigInt',
+  symbol: 'Symbol',
+};

src/generators/json/index.mjs

@@ -1,11 +1,10 @@
-// @ts-check
 'use strict';
 
 import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 
-import { createSectionBuilder } from './utils/createSection.mjs';
 import { parseSchema } from './utils/parseSchema.mjs';
+import { createSection } from './utils/sections/index.mjs';
 import { groupNodesByModule } from '../../utils/generators.mjs';
 
 /**
@@ -42,8 +41,6 @@ export default {
   async generate(input, { output }) {
     const groupedModules = groupNodesByModule(input);
 
-    const buildSection = createSectionBuilder();
-    console.log('json in', input);
     /**
      * @param {ApiDocMetadataEntry} head
      * @returns {import('./generated.d.ts').NodeJsAPIDocumentationSchema}
@@ -54,7 +51,7 @@ export default {
         throw new TypeError(`no grouped nodes found for ${head.api}`);
       }
 
-      const section = buildSection(head, nodes);
+      const section = createSection(head, nodes);
 
       return section;
     };

src/generators/json/utils/__tests__/createModuleSection.test.mjs

@@ -19,10 +19,10 @@ import { ParameterTree } from './parameter-tree.mjs';
  *
  * For instance, using the above signature, we want to create four method
  * signatures for it:
- *  1. For `something()`
- *  2. For `something(sources)
- *  3. For `something(sources, options, flag)
- *  4. For `something(sources, options, flag, abc)
+ * 1. For `something()`
+ * 2. For `something(sources)
+ * 3. For `something(sources, options, flag)
+ * 4. For `something(sources, options, flag, abc)
  *
  * This method does just that given an array of the parameter names split by
  * commas.