cleanup

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

Author: flakey5

package-lock.json

@@ -32,7 +32,6 @@
     "acorn": "^8.14.0",
     "commander": "^13.1.0",
     "estree-util-visit": "^2.0.0",
-    "gitconfiglocal": "^2.1.0",
     "dedent": "^1.5.3",
     "github-slugger": "^2.0.0",
     "glob": "^11.0.1",

package.json

@@ -5,6 +5,8 @@ import availableGenerators from './generators/index.mjs';
 /**
  * @typedef {{ ast: import('./generators/types.d.ts').GeneratorMetadata<ApiDocMetadataEntry, ApiDocMetadataEntry>}} AstGenerator The AST "generator" is a facade for the AST tree and it isn't really a generator
  * @typedef {import('./generators/types.d.ts').AvailableGenerators & AstGenerator} AllGenerators A complete set of the available generators, including the AST one
+ * @param markdownInput
+ * @param jsInput
  *
  * This method creates a system that allows you to register generators
  * and then execute them in a specific order, keeping track of the
@@ -18,7 +20,7 @@ import availableGenerators from './generators/index.mjs';
  * Generators can also write to files. These would usually be considered
  * the final generators in the chain.
  *
- * @param {ApiDocMetadataEntry} input The parsed API doc metadata entries
+ * @param {ApiDocMetadataEntry} markdownInput The parsed API doc metadata entries
  * @param {Array<import('acorn').Program>} parsedJsFiles
  */
 const createGenerator = (markdownInput, jsInput) => {
@@ -30,8 +32,8 @@ const createGenerator = (markdownInput, jsInput) => {
    * @type {{ [K in keyof AllGenerators]: ReturnType<AllGenerators[K]['generate']> }}
    */
   const cachedGenerators = {
-    ast: Promise.resolve(input),
-    'ast-js': Promise.resolve(parsedJsFiles),
+    ast: Promise.resolve(markdownInput),
+    'ast-js': Promise.resolve(jsInput),
   };
 
   /**

src/generators.mjs

@@ -228,15 +228,13 @@ export function extractExports(program, basename, nameToLineNumberMap) {
 
   const TYPE_TO_HANDLER_MAP = {
     /**
-     *
-     * @param node
+     * @param {import('acorn').Node} node
      */
     ExpressionStatement: node =>
       handleExpression(node, basename, nameToLineNumberMap),
 
     /**
-     *
-     * @param node
+     * @param {import('acorn').Node} node
      */
     VariableDeclaration: node =>
       handleVariableDeclaration(node, basename, nameToLineNumberMap),

src/generators/api-links/utils/extractExports.mjs

@@ -1,4 +1,3 @@
-// @ts-check
 'use strict';
 
 import { visit } from 'estree-util-visit';
@@ -153,22 +152,19 @@ export function findDefinitions(
 ) {
   const TYPE_TO_HANDLER_MAP = {
     /**
-     *
-     * @param node
+     * @param {import('acorn').Node} node
      */
     ExpressionStatement: node =>
       handleAssignmentExpression(node, nameToLineNumberMap, exports),
 
     /**
-     *
-     * @param node
+     * @param {import('acorn').Node} node
      */
     FunctionDeclaration: node =>
       handleFunctionDeclaration(node, basename, nameToLineNumberMap, exports),
 
     /**
-     *
-     * @param node
+     * @param {import('acorn').Node} node
      */
     ClassDeclaration: node =>
       handleClassDeclaration(node, nameToLineNumberMap, exports),

src/generators/api-links/utils/findDefinitions.mjs

@@ -137,8 +137,8 @@ code,
 .pre,
 span.type,
 a.type {
-  font-family: SFMono-Regular, Menlo, Consolas, 'Liberation Mono', 'Courier New',
-    monospace;
+  font-family: SFMono-Regular, Menlo, Consolas, 'Liberation Mono',
+    'Courier New', monospace;
   font-size: 0.9em;
 }
 

src/generators/legacy-html/assets/style.css

@@ -1,7 +1,5 @@
 'use strict';
 
-import { join } from 'node:path';
-
 import { u as createTree } from 'unist-builder';
 
 import { compare } from 'semver';
@@ -149,9 +147,6 @@ const createMetadata = slugger => {
         api: apiDoc.stem,
         slug: sectionSlug,
         source_link,
-        source_link_local: source_link
-          ? join(apiDoc.history[0], '..', '..', '..', source_link)
-          : undefined,
         api_doc_source: `doc/api/${apiDoc.basename}`,
         added_in: added,
         deprecated_in: deprecated,

src/metadata.mjs

@@ -1,4 +1,3 @@
-// @ts-check
 'use strict';
 
 import { u as createTree } from 'unist-builder';

src/parser.mjs

@@ -71,8 +71,6 @@ declare global {
     slug: string;
     // The GitHub URL to the source of the API entry
     source_link: string | Array<string> | undefined;
-    // The path to the JavaScript source for the API entry relative to its location locally (ex. `../node/lib/zlib.js`)
-    source_link_local: string | undefined;
     // Path to the api doc file relative to the root of the nodejs repo root (ex/ `doc/api/addons.md`)
     api_doc_source: string;
     // When a said API section got added (in which version(s) of Node.js)