fixup!

Author: avivkeller

src/generators/legacy-json/utils/parseList.mjs

@@ -2,7 +2,6 @@ import parseSignature from './parseSignature.mjs';
 import {
   TYPED_LIST_STARTERS,
   DEFAULT_EXPRESSION,
-  LEADING_HYPHEN,
   NAME_EXPRESSION,
   TYPE_EXPRESSION,
 } from '../../../utils/queries/regex.mjs';
@@ -72,7 +71,7 @@ export function parseListItem(child) {
   text = extractPattern(text, DEFAULT_EXPRESSION, 'default', current);
 
   // Set the remaining text as the description, removing any leading hyphen
-  current.desc = text.replace(LEADING_HYPHEN, '').trim() || undefined;
+  current.desc = text.replace(/^-\s*/, '').trim() || undefined;
 
   // Parse nested lists (options) recursively if present
   if (subList) {

src/parsers/markdown.mjs

@@ -4,13 +4,11 @@ import { coerce } from 'semver';
 
 import { loadFromURL } from '../utils/parser.mjs';
 import createQueries from '../utils/queries/index.mjs';
-import {
-  LIST_ITEM,
-  NODE_LTS_VERSION,
-  NODE_VERSIONS,
-} from '../utils/queries/regex.mjs';
+import { MD_LINKED_LIST_ITEM, NODE_VERSIONS } from '../utils/queries/regex.mjs';
 import { getRemark } from '../utils/remark.mjs';
 
+const LTS = 'long term support';
+
 /**
  * Creates an API doc parser for a given Markdown API doc file
  *
@@ -79,7 +77,7 @@ export const parseChangelog = async path => {
 
   return nodeMajors.map(match => ({
     version: coerce(match[1]),
-    isLts: NODE_LTS_VERSION.test(match[2]),
+    isLts: match[2].toLowerCase().includes(LTS),
   }));
 };
 
@@ -92,7 +90,7 @@ export const parseChangelog = async path => {
 export const parseIndex = async path => {
   const index = await loadFromURL(path);
 
-  const items = Array.from(index.matchAll(LIST_ITEM));
+  const items = Array.from(index.matchAll(MD_LINKED_LIST_ITEM));
 
   return items.map(([, section, api]) => ({ section, api }));
 };

src/utils/queries/__tests__/regex.test.mjs

@@ -187,21 +187,6 @@ const testCases = {
     },
   ],
 
-  NORMALIZE_TYPES: [
-    {
-      input: '{string}',
-      matches: '{string}',
-    },
-    {
-      input: 'Takes a {string} and returns an <Object>',
-      matches: ['{string}', '<Object>'],
-    },
-    {
-      input: '{Buffer|string}',
-      matches: '{Buffer|string}',
-    },
-  ],
-
   LINKS_WITH_TYPES: [
     {
       input: 'Returns [`<Buffer>`](/api/buffer) or [`<string>`](/api/string)',
@@ -431,25 +416,6 @@ const testCases = {
     },
   ],
 
-  LEADING_HYPHEN: [
-    {
-      input: '- item',
-      matches: '- ',
-    },
-    {
-      input: '-  spaced item',
-      matches: '-  ',
-    },
-    {
-      input: '* bullet point',
-      matches: false,
-    },
-    {
-      input: '- ',
-      matches: '- ',
-    },
-  ],
-
   DEFAULT_EXPRESSION: [
     {
       input: '**Default:** `true`',
@@ -520,7 +486,7 @@ const testCases = {
     },
   ],
 
-  LIST_ITEM: [
+  MD_LINKED_LIST_ITEM: [
     {
       input: '* [Buffer](buffer.md)',
       matches: ['* [Buffer](buffer.md)'],
@@ -540,25 +506,6 @@ const testCases = {
     },
   ],
 
-  NODE_LTS_VERSION: [
-    {
-      input: 'This is a Long Term Support version',
-      matches: 'Long Term Support',
-    },
-    {
-      input: 'long term support release',
-      matches: 'long term support',
-    },
-    {
-      input: 'LTS',
-      matches: false,
-    },
-    {
-      input: 'Long-term support',
-      matches: false,
-    },
-  ],
-
   INTRODUCED_IN: [
     {
       input: '<!-- introduced_in=v10.0.0 -->',

src/utils/queries/index.mjs

@@ -15,9 +15,9 @@ import { getRemark } from '../remark.mjs';
 import { transformNodesToString } from '../unist.mjs';
 import {
   MARKDOWN_URL,
-  NORMALIZE_TYPES,
   STABILITY_INDEX,
   STABILITY_INDEX_PREFIX,
+  TYPE_EXPRESSION,
   UNIX_MANUAL_PAGE,
 } from './regex.mjs';
 
@@ -181,7 +181,7 @@ const createQueries = () => {
     updateMarkdownLink,
     /** @param {Array<import('@types/mdast').Node>} args */
     updateTypeReference: (...args) =>
-      updateReferences(NORMALIZE_TYPES, transformTypeToReferenceLink, ...args),
+      updateReferences(TYPE_EXPRESSION, transformTypeToReferenceLink, ...args),
     /** @param {Array<import('@types/mdast').Node>} args */
     updateUnixManualReference: (...args) =>
       updateReferences(UNIX_MANUAL_PAGE, transformUnixManualToLink, ...args),

src/utils/queries/regex.mjs

@@ -119,6 +119,8 @@ export const EVENT_HEADING = /^Event: +`?['"]?([^'"]+)['"]?`?$/i;
 // TYPE AND REFERENCE PATTERNS
 // ============================================================================
 
+const TYPE_SAFE = '[^<({})>]+';
+
 /**
  * Matches API type references enclosed in curly braces or angle brackets.
  * Used to normalize type references across documentation.
@@ -127,7 +129,10 @@ export const EVENT_HEADING = /^Event: +`?['"]?([^'"]+)['"]?`?$/i;
  * - '{Buffer|string}'
  * - '<Object>'
  */
-export const NORMALIZE_TYPES = /(\{|<)(?! )[^<({})>]+(?! )(\}|>)/g;
+export const TYPE_EXPRESSION = new RegExp(
+  `(?:\\{|<)(${TYPE_SAFE})(?:\\}|>)`,
+  'g'
+);
 
 /**
  * Matches already-parsed API type references in Markdown link format.
@@ -136,7 +141,10 @@ export const NORMALIZE_TYPES = /(\{|<)(?! )[^<({})>]+(?! )(\}|>)/g;
  * - '[`<string>`](/api/string)'
  * - '[`<Buffer>`](/api/buffer)'
  */
-export const LINKS_WITH_TYPES = /\[`<[^<({})>]+>`\]\((\S+)\)/g;
+export const LINKS_WITH_TYPES = new RegExp(
+  `\\[\`<${TYPE_SAFE}>\`\\]\\((\\S+)\\)`,
+  'g'
+);
 
 /**
  * Matches headings that start typed lists in documentation.
@@ -149,15 +157,6 @@ export const LINKS_WITH_TYPES = /\[`<[^<({})>]+>`\]\((\S+)\)/g;
  */
 export const TYPED_LIST_STARTERS = /^(Returns|Extends|Type):?\s*/;
 
-/**
- * Matches type expressions in curly braces.
- * Examples:
- * - '{string}'
- * - '{Buffer|null}'
- * - '{Object}'
- */
-export const TYPE_EXPRESSION = /^\{([^}]+)\}\s*/;
-
 // ============================================================================
 // PARAMETER AND EXPRESSION PATTERNS
 // ============================================================================
@@ -188,14 +187,6 @@ export const PARAM_EXPRESSION = /\((.+)\);?$/;
  */
 export const DEFAULT_EXPRESSION = /\s*\*\*Default:\*\*\s*([^]+)$/i;
 
-/**
- * Matches leading hyphens in list items.
- * Examples:
- * - '- item'
- * - '-  spaced item'
- */
-export const LEADING_HYPHEN = /^-\s*/;
-
 // ============================================================================
 // URL AND REFERENCE PATTERNS
 // ============================================================================
@@ -259,8 +250,7 @@ export const STABILITY_INDEX = new RegExp(
  * - '<!-- YAML foo bar -->'
  * - '<!-- description -->'
  */
-export const YAML_INNER_CONTENT =
-  /^<!--[ ]?(?:YAML([\s\S]*?)|([ \S]*?))?[ ]?-->/;
+export const YAML_INNER_CONTENT = /^<!-- *(?:YAML([\s\S]*?)|([ \S]*?))? *-->/;
 
 /**
  * Matches code filename comments at the beginning of files.
@@ -276,14 +266,14 @@ export const EXTRACT_CODE_FILENAME_COMMENT = /^\/\/\s+(.*\.(?:cc|h|js))[\r\n]/;
  * Examples:
  * - '<!-- introduced_in=v10.0.0 -->'
  */
-export const INTRODUCED_IN = /<!--\s?introduced_in=.*-->/;
+export const INTRODUCED_IN = /<!-- *introduced_in=.*-->/;
 
 /**
  * Matches HTML comments with LLM description metadata.
  * Examples:
  * - '<!-- llm_description=... -->'
  */
-export const LLM_DESCRIPTION = /<!--\s?llm_description=.*-->/;
+export const LLM_DESCRIPTION = /<!-- *llm_description=.*-->/;
 
 // ============================================================================
 // NODE.JS VERSION AND LIST PATTERNS
@@ -303,12 +293,4 @@ export const NODE_VERSIONS = /\* \[Node\.js ([0-9.]+)\]\S+ (.*)\r?\n/g;
  * - '* [Buffer](buffer.md)'
  * - '* [File System](fs.md)'
  */
-export const LIST_ITEM = /\* \[(.*?)\]\((.*?)\.md\)/g;
-
-/**
- * Matches Long Term Support indicators in version descriptions.
- * Examples:
- * - 'Long Term Support'
- * - 'long term support'
- */
-export const NODE_LTS_VERSION = /Long Term Support/i;
+export const MD_LINKED_LIST_ITEM = /\* \[(.*?)\]\((.*?)\.md\)/g;

src/utils/queries/unist.mjs

@@ -1,7 +1,7 @@
 import {
   LINKS_WITH_TYPES,
   MARKDOWN_URL,
-  NORMALIZE_TYPES,
+  NAME_EXPRESSION,
   STABILITY_INDEX,
   TYPED_LIST_STARTERS,
   UNIX_MANUAL_PAGE,
@@ -29,7 +29,7 @@ export const isYamlNode = ({ type, value }) =>
  * @returns {boolean}
  */
 export const isTextWithType = ({ type, value }) =>
-  type === 'text' && NORMALIZE_TYPES.test(value);
+  type === 'text' && NAME_EXPRESSION.test(value);
 
 /**
  * @param {import('@types/mdast').Text} text