some lint fixes

flakey5 · flakey5 · commit 6bfc5551ae95 · 2025-10-26T17:41:22.000-07:00
Signed-off-by: flakey5 &lt;73616808+flakey5@users.noreply.github.com&gt;
diff --git a/src/generators/index.mjs b/src/generators/index.mjs
@@ -3,6 +3,8 @@
 import addonVerify from './addon-verify/index.mjs';
 import apiLinks from './api-links/index.mjs';
 import astJs from './ast-js/index.mjs';
+import json from './json/index.mjs';
+import jsonAll from './json-all/index.mjs';
 import jsonSimple from './json-simple/index.mjs';
 import jsxAst from './jsx-ast/index.mjs';
 import legacyHtml from './legacy-html/index.mjs';
@@ -14,8 +16,6 @@ import manPage from './man-page/index.mjs';
 import metadata from './metadata/index.mjs';
 import oramaDb from './orama-db/index.mjs';
 import web from './web/index.mjs';
-import json from './json/index.mjs';
-import jsonAll from './json-all/index.mjs';
 
 export const publicGenerators = {
   'json-simple': jsonSimple,
diff --git a/src/generators/json-all/__tests__/version.test.mjs b/src/generators/json-all/__tests__/version.test.mjs
@@ -1,9 +1,10 @@
 'use strict';
 
-import test from 'node:test';
 import assert from 'node:assert';
-import jsonAll from '../../json-all/index.mjs';
-import json from '../index.mjs';
+import test from 'node:test';
+
+import json from '../../json/index.mjs';
+import jsonAll from '../index.mjs';
 import { generateJsonSchema } from '../util/generateJsonSchema.mjs';
 
 test('json-all generator matches json generator version match', () => {
diff --git a/src/generators/json-all/index.mjs b/src/generators/json-all/index.mjs
@@ -3,6 +3,7 @@
 
 import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
+
 import { DOC_NODE_VERSION } from '../../constants.mjs';
 import { generateJsonSchema } from './util/generateJsonSchema.mjs';
 
diff --git a/src/generators/json-all/util/generateJsonSchema.mjs b/src/generators/json-all/util/generateJsonSchema.mjs
@@ -5,6 +5,9 @@ import jsonAll from '../index.mjs';
 
 const JSON_SCHEMA_URL = `https://nodejs.org/docs/${DOC_NODE_VERSION}/api/node-doc-schema.json`;
 
+/**
+ *
+ */
 export const generateJsonSchema = () => ({
   $schema: 'http://json-schema.org/draft-07/schema#',
   $id: `nodejs-api-doc-all@v${jsonAll.version}`,
diff --git a/src/generators/json/__tests__/index.test.mjs b/src/generators/json/__tests__/index.test.mjs
@@ -1,12 +1,14 @@
 // @ts-check
-import { describe, test, before } from 'node:test';
 import assert from 'node:assert';
 import { join } from 'node:path';
-import { SemVer } from 'semver';
+import { describe, test, before } from 'node:test';
+
 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 createGenerator from '../../../generators.mjs';
 import { parseSchema } from '../utils/parseSchema.mjs';
 
 const FIXTURES_DIR = join(import.meta.dirname, 'fixtures');
diff --git a/src/generators/json/__tests__/version.test.mjs b/src/generators/json/__tests__/version.test.mjs
@@ -1,10 +1,12 @@
 'use strict';
 
-import test from 'node:test';
 import assert from 'node:assert';
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
+import test from 'node:test';
+
 import { parse as jsoncParse } from 'jsonc-parser';
+
 import json from '../index.mjs';
 
 test('schema version matches generator version', async () => {
diff --git a/src/generators/json/index.mjs b/src/generators/json/index.mjs
@@ -3,9 +3,10 @@
 
 import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { groupNodesByModule } from '../../utils/generators.mjs';
+
 import { createSectionBuilder } from './utils/createSection.mjs';
 import { parseSchema } from './utils/parseSchema.mjs';
+import { groupNodesByModule } from '../../utils/generators.mjs';
 
 /**
  * This generator is responsible for generating the JSON representation of the
diff --git a/src/generators/json/utils/__tests__/createMethodSection.test.mjs b/src/generators/json/utils/__tests__/createMethodSection.test.mjs
@@ -1,8 +1,9 @@
 // @ts-check
 'use strict';
 
-import { describe, test } from 'node:test';
 import assert from 'node:assert';
+import { describe, test } from 'node:test';
+
 import { createParameterGroupings } from '../createMethodSection.mjs';
 
 describe('createParameterGroupings', () => {
diff --git a/src/generators/json/utils/__tests__/createModuleSection.test.mjs b/src/generators/json/utils/__tests__/createModuleSection.test.mjs
@@ -1,9 +1,10 @@
 'use strict';
 
-import { test } from 'node:test';
 import assert from 'node:assert';
-import { createModuleSectionBuilder } from '../createModuleSection.mjs';
+import { test } from 'node:test';
+
 import { DOC_NODE_VERSION } from '../../../../constants.mjs';
+import { createModuleSectionBuilder } from '../createModuleSection.mjs';
 
 const createModuleSection = createModuleSectionBuilder();
 
diff --git a/src/generators/json/utils/__tests__/createPropertySection.test.mjs b/src/generators/json/utils/__tests__/createPropertySection.test.mjs
@@ -1,8 +1,8 @@
 // @ts-check
 'use strict';
 
-import test, { describe } from 'node:test';
 import assert from 'node:assert';
+import test, { describe } from 'node:test';
 
 `
 #### \`url.username\`
diff --git a/src/generators/json/utils/__tests__/createSection.test.mjs b/src/generators/json/utils/__tests__/createSection.test.mjs
@@ -1,10 +1,11 @@
 // @ts-check
 'use strict';
 
-import { test } from 'node:test';
 import assert from 'node:assert';
-import { createSectionBuilder } from '../createSection.mjs';
+import { test } from 'node:test';
+
 import { DOC_NODE_VERSION } from '../../../../constants.mjs';
+import { createSectionBuilder } from '../createSection.mjs';
 
 const createSection = createSectionBuilder();
 
diff --git a/src/generators/json/utils/__tests__/createSectionBase.test.mjs b/src/generators/json/utils/__tests__/createSectionBase.test.mjs
@@ -1,8 +1,9 @@
 // @ts-check
 'use strict';
 
-import test, { describe } from 'node:test';
 import assert from 'node:assert';
+import test, { describe } from 'node:test';
+
 import {
   createSectionBaseBuilder,
   ENTRY_TO_SECTION_TYPE,
diff --git a/src/generators/json/utils/__tests__/parseTypeList.test.mjs b/src/generators/json/utils/__tests__/parseTypeList.test.mjs
@@ -1,7 +1,8 @@
 'use strict';
 
-import { test } from 'node:test';
 import assert from 'node:assert';
+import { test } from 'node:test';
+
 import { parseTypeList } from '../parseTypeList.mjs';
 
 test('`bla {[integer](https://mdn-link)} Description start bla bla bla [asd](https://random-link)', () => {
diff --git a/src/generators/json/utils/__tests__/stringifyNode.test.mjs b/src/generators/json/utils/__tests__/stringifyNode.test.mjs
@@ -1,5 +1,6 @@
-import test from 'node:test';
 import assert from 'node:assert';
+import test from 'node:test';
+
 import { stringifyNode } from '../stringifyNode.mjs';
 
 test('break', () => {
diff --git a/src/generators/json/utils/createClassSection.mjs b/src/generators/json/utils/createClassSection.mjs
@@ -1,12 +1,15 @@
 'use strict';
 
-import { GeneratorError } from '../../../utils/generator-error.mjs';
 import { findParentSection } from './findParentSection.mjs';
+import { GeneratorError } from '../../../utils/generator-error.mjs';
 
 /**
  * @typedef {import('../../../utils/buildHierarchy.mjs').HierarchizedEntry} HierarchizedEntry
  */
 
+/**
+ *
+ */
 export const createClassSectionBuilder = () => {
   /**
    * Adds the properties expected in a class section to an object.
diff --git a/src/generators/json/utils/createEventSection.mjs b/src/generators/json/utils/createEventSection.mjs
@@ -9,6 +9,9 @@ import { stringifyNode } from './stringifyNode.mjs';
  * @typedef {import('../../../utils/buildHierarchy.mjs').HierarchizedEntry} HierarchizedEntry
  */
 
+/**
+ *
+ */
 export const createEventSectionBuilder = () => {
   /**
    * Parse the parameters for the event's callback method
diff --git a/src/generators/json/utils/createMethodSection.mjs b/src/generators/json/utils/createMethodSection.mjs
@@ -167,8 +167,8 @@ export const parseParameterListNode = ({ children }) => {
  * @param {HierarchizedEntry} entry The AST entry
  *
  * @returns {{
- *   parameters?: Record<string, import('../generated.d.ts').MethodParameter>,
- *   returns?: import('../generated.d.ts').MethodReturnType
+ * parameters?: Record<string, import('../generated.d.ts').MethodParameter>,
+ * returns?: import('../generated.d.ts').MethodReturnType
  * } | undefined}
  */
 export const parseParameterList = entry => {
@@ -442,6 +442,9 @@ export const parseSignatures = (entry, section) => {
   );
 };
 
+/**
+ *
+ */
 export const createMethodSectionBuilder = () => {
   /**
    * Adds the properties expected in a method section to an object.
diff --git a/src/generators/json/utils/createModuleSection.mjs b/src/generators/json/utils/createModuleSection.mjs
@@ -7,6 +7,9 @@ import { DOC_NODE_VERSION } from '../../../constants.mjs';
  * @typedef {import('../../../utils/buildHierarchy.mjs').HierarchizedEntry} HierarchizedEntry
  */
 
+/**
+ *
+ */
 export const createModuleSectionBuilder = () => {
   /**
    * Adds the properties expected in a module section to an object.
diff --git a/src/generators/json/utils/createPropertySection.mjs b/src/generators/json/utils/createPropertySection.mjs
@@ -20,6 +20,9 @@ const docTypeToCorrectJsType = {
   symbol: 'Symbol',
 };
 
+/**
+ *
+ */
 export const createPropertySectionBuilder = () => {
   /**
    * Parse the type of the property from the AST
diff --git a/src/generators/json/utils/createSection.mjs b/src/generators/json/utils/createSection.mjs
@@ -1,19 +1,22 @@
 'use strict';
 
-import { buildHierarchy } from '../../../utils/buildHierarchy.mjs';
-import { createSectionBaseBuilder } from './createSectionBase.mjs';
-import { createModuleSectionBuilder } from './createModuleSection.mjs';
 import { createClassSectionBuilder } from './createClassSection.mjs';
+import { createEventSectionBuilder } from './createEventSection.mjs';
 import { createMethodSectionBuilder } from './createMethodSection.mjs';
+import { createModuleSectionBuilder } from './createModuleSection.mjs';
 import { createPropertySectionBuilder } from './createPropertySection.mjs';
-import { createEventSectionBuilder } from './createEventSection.mjs';
-import { GeneratorError } from '../../../utils/generator-error.mjs';
+import { createSectionBaseBuilder } from './createSectionBase.mjs';
 import { DOC_NODE_VERSION } from '../../../constants.mjs';
+import { buildHierarchy } from '../../../utils/buildHierarchy.mjs';
+import { GeneratorError } from '../../../utils/generator-error.mjs';
 
 /**
  * @typedef {import('../../../utils/buildHierarchy.mjs').HierarchizedEntry} HierarchizedEntry
  */
 
+/**
+ *
+ */
 export const createSectionBuilder = () => {
   const createSectionBase = createSectionBaseBuilder();
   const createModuleSection = createModuleSectionBuilder();
diff --git a/src/generators/json/utils/createSectionBase.mjs b/src/generators/json/utils/createSectionBase.mjs
@@ -29,6 +29,9 @@ export const ENTRY_TO_SECTION_TYPE = /** @type {const} */ ({
   example: 'text',
 });
 
+/**
+ *
+ */
 export const createSectionBaseBuilder = () => {
   /**
    * @param {import('mdast').Heading} header
diff --git a/src/generators/json/utils/parameter-tree.mjs b/src/generators/json/utils/parameter-tree.mjs
@@ -3,15 +3,18 @@
 
 /**
  * @typedef {{
- *   name: string,
- *   createdAt: number
+ * name: string,
+ * createdAt: number
  * }} Parameter
  *
  * @typedef {{
- *   count: number
+ * count: number
  * }} Counter
  */
 
+/**
+ *
+ */
 export class ParameterTree {
   /**
    * @type {Array<Parameter>}
@@ -45,10 +48,16 @@ export class ParameterTree {
     });
   }
 
+  /**
+   *
+   */
   get parameters() {
     return this.#parameters;
   }
 
+  /**
+   *
+   */
   get children() {
     return this.#children;
   }
diff --git a/src/generators/json/utils/parseSchema.mjs b/src/generators/json/utils/parseSchema.mjs
@@ -3,6 +3,7 @@
 
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
+
 import { parse as jsoncParse } from 'jsonc-parser';
 
 /**
diff --git a/src/generators/legacy-json/utils/buildSection.mjs b/src/generators/legacy-json/utils/buildSection.mjs
@@ -1,6 +1,6 @@
-import { buildHierarchy } from '../../../utils/buildHierarchy.mjs';
 import { parseList } from './parseList.mjs';
 import { enforceArray } from '../../../utils/array.mjs';
+import { buildHierarchy } from '../../../utils/buildHierarchy.mjs';
 import { getRemarkRehype } from '../../../utils/remark.mjs';
 import { transformNodesToString } from '../../../utils/unist.mjs';
 import { SECTION_TYPE_PLURALS, UNPROMOTED_KEYS } from '../constants.mjs';
diff --git a/src/utils/generator-error.mjs b/src/utils/generator-error.mjs
@@ -2,7 +2,7 @@
  * An error thrown by a generator when it encounters something unexpected.
  *
  * @typedef {{
- *   entry?: ApiDocMetadataEntry
+ * entry?: ApiDocMetadataEntry
  * } & ErrorOptions} GeneratorErrorOptions
  */
 export class GeneratorError extends Error {
@@ -21,13 +21,16 @@ export class GeneratorError extends Error {
     this.entry = options?.entry;
   }
 
+  /**
+   * Get the error message with some debug info attached
+   */
   get message() {
     let message = super.message;
 
     // Add general info of what was being processed when this error was thrown
     // for debugging
     if (this.entry) {
-      message += ` (${options.entry.api_doc_source}#${options.entry.slug})`;
+      message += ` (${this.entry.api_doc_source}#${this.entry.slug})`;
     }
 
     return message;
diff --git a/tools/generate-json-types.mjs b/tools/generate-json-types.mjs
@@ -6,10 +6,11 @@
  * To use, just run this.
  */
 
-import { join } from 'node:path';
 import { readFile, writeFile } from 'node:fs/promises';
-import { parse } from 'jsonc-parser';
+import { join } from 'node:path';
+
 import { compile } from 'json-schema-to-typescript';
+import { parse } from 'jsonc-parser';
 
 const JSON_GENERATOR_PATH = join(
   import.meta.dirname,

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`// @ts-check`
`2`	`2`	`'use strict';`
`3`	`3`
`4`		`-import test, { describe } from 'node:test';`
`5`	`4`	`import assert from 'node:assert';`
	`5`	`+import test, { describe } from 'node:test';`
`6`	`6`
`7`	`7`	`
`8`	`8`	#### \`url.username\`