chore(queries): organize and test

Author: avivkeller

src/generators/addon-verify/constants.mjs

@@ -5,13 +5,13 @@ import { join } from 'node:path';
 
 import { visit } from 'unist-util-visit';
 
-import { EXTRACT_CODE_FILENAME_COMMENT } from './constants.mjs';
 import { generateFileList } from './utils/generateFileList.mjs';
 import {
   generateSectionFolderName,
   isBuildableSection,
   normalizeSectionName,
 } from './utils/section.mjs';
+import { EXTRACT_CODE_FILENAME_COMMENT } from '../../utils/queries/regex.mjs';
 
 /**
  * This generator generates a file list from code blocks extracted from

src/generators/addon-verify/index.mjs

@@ -2,8 +2,6 @@
 
 import { visit } from 'estree-util-visit';
 
-import { CONSTRUCTOR_EXPRESSION } from '../constants.mjs';
-
 /**
  * @see https://github.com/estree/estree/blob/master/es5.md#assignmentexpression
  *
@@ -99,7 +97,7 @@ function handleExpression(node, basename, nameToLineNumberMap) {
             case 'Identifier': {
               exports.identifiers.push(value.name);
 
-              if (CONSTRUCTOR_EXPRESSION.test(value.name[0])) {
+              if (/^[A-Z]/.test(value.name)) {
                 exports.ctors.push(value.name);
               }
 

src/generators/api-links/constants.mjs

@@ -5,7 +5,7 @@ import { join } from 'node:path';
 
 import { remove } from 'unist-util-remove';
 
-import createQueries from '../../utils/queries/index.mjs';
+import { isHeading, isStabilityNode } from '../../utils/queries/unist.mjs';
 
 /**
  * This generator generates a simplified JSON version of the API docs and returns it as a string
@@ -41,10 +41,7 @@ export default {
 
       // Removes numerous nodes from the content that should not be on the "body"
       // of the JSON version of the API docs as they are already represented in the metadata
-      remove(content, [
-        createQueries.UNIST.isStabilityNode,
-        createQueries.UNIST.isHeading,
-      ]);
+      remove(content, [isStabilityNode, isHeading]);
 
       return { ...node, content };
     });

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

@@ -9,7 +9,11 @@ import createPropertyTable from './buildPropertyTable.mjs';
 import { DOC_NODE_BLOB_BASE_URL } from '../../../constants.mjs';
 import { enforceArray } from '../../../utils/array.mjs';
 import { sortChanges } from '../../../utils/generators.mjs';
-import createQueries from '../../../utils/queries/index.mjs';
+import {
+  isStabilityNode,
+  isHeading,
+  isTypedList,
+} from '../../../utils/queries/unist.mjs';
 import { JSX_IMPORTS } from '../../web/constants.mjs';
 import {
   STABILITY_LEVELS,
@@ -219,17 +223,17 @@ export const processEntry = (entry, remark) => {
   const content = structuredClone(entry.content);
 
   // Visit and transform stability nodes
-  visit(content, createQueries.UNIST.isStabilityNode, transformStabilityNode);
+  visit(content, isStabilityNode, transformStabilityNode);
 
   // Visit and transform headings with metadata and links
-  visit(content, createQueries.UNIST.isHeading, (...args) =>
+  visit(content, isHeading, (...args) =>
     transformHeadingNode(entry, remark, ...args)
   );
 
   // Transform typed lists into property tables
   visit(
     content,
-    createQueries.UNIST.isTypedList,
+    isTypedList,
     (node, idx, parent) => (parent.children[idx] = createPropertyTable(node))
   );
 

src/generators/json-simple/index.mjs

@@ -1,6 +1,7 @@
 import { h as createElement } from 'hastscript';
 
-import createQueries from '../../../utils/queries/index.mjs';
+import { TYPED_LIST_STARTERS } from '../../../utils/queries/regex.mjs';
+import { isTypedList } from '../../../utils/queries/unist.mjs';
 
 /**
  * Determines if a node looks like part of a type annotation.
@@ -51,9 +52,7 @@ export const extractPropertyName = children => {
 
   // Text with a prefix like "Type:", "Param:", etc.
   if (first.type === 'text') {
-    const starterMatch = first.value.match(
-      createQueries.QUERIES.typedListStarters
-    );
+    const starterMatch = first.value.match(TYPED_LIST_STARTERS);
     if (starterMatch) {
       // If the starter is 'Type', we don't have a property.
       const label = starterMatch[1] !== 'Type' && starterMatch[1];
@@ -133,7 +132,7 @@ export const parseListIntoProperties = node => {
       // The remaining children are the description
       desc: children,
       // Is there a list within this list?
-      sublist: sublists.find(createQueries.UNIST.isTypedList),
+      sublist: sublists.find(isTypedList),
     });
   }
 

src/generators/jsx-ast/utils/buildContent.mjs

@@ -1,7 +1,7 @@
 import { highlightToHast } from '@node-core/rehype-shiki';
 import { h as createElement } from 'hastscript';
 
-import createQueries from '../../../utils/queries/index.mjs';
+import { isTypedList } from '../../../utils/queries/unist.mjs';
 import { parseListItem } from '../../legacy-json/utils/parseList.mjs';
 import parseSignature from '../../legacy-json/utils/parseSignature.mjs';
 
@@ -89,7 +89,7 @@ export const getFullName = ({ name, text }, fallback = name) => {
  */
 export default ({ children }, { data }, idx) => {
   // Try to locate the parameter list immediately following the heading
-  const listIdx = children.findIndex(createQueries.UNIST.isTypedList);
+  const listIdx = children.findIndex(isTypedList);
 
   // Parse parameters from the list, if found
   const params =

src/generators/jsx-ast/utils/buildPropertyTable.mjs

@@ -6,7 +6,12 @@ import { SKIP, visit } from 'unist-util-visit';
 
 import buildExtraContent from './buildExtraContent.mjs';
 import { DOC_NODE_BLOB_BASE_URL } from '../../../constants.mjs';
-import createQueries from '../../../utils/queries/index.mjs';
+import { LINKS_WITH_TYPES } from '../../../utils/queries/regex.mjs';
+import {
+  isHeading,
+  isHtmlWithType,
+  isStabilityNode,
+} from '../../../utils/queries/unist.mjs';
 
 /**
  * Builds a Markdown heading for a given node
@@ -71,7 +76,7 @@ const buildStability = ({ children, data }, index, parent) => {
  */
 const buildHtmlTypeLink = node => {
   node.value = node.value.replace(
-    createQueries.QUERIES.linksWithTypes,
+    LINKS_WITH_TYPES,
     (_, type, link) => `<a href="${link}" class="type">&lt;${type}&gt;</a>`
   );
 };
@@ -223,16 +228,16 @@ export default (headNodes, metadataEntries, remark) => {
       const content = structuredClone(entry.content);
 
       // Parses the Heading nodes into Heading elements
-      visit(content, createQueries.UNIST.isHeading, buildHeading);
+      visit(content, isHeading, buildHeading);
 
       // Parses the Blockquotes into Stability elements
       // This is treated differently as we want to preserve the position of a Stability Index
       // within the content, so we can't just remove it and append it to the metadata
-      visit(content, createQueries.UNIST.isStabilityNode, buildStability);
+      visit(content, isStabilityNode, buildStability);
 
       // Parses the type references that got replaced into Markdown links (raw)
       // into actual HTML links, these then get parsed into HAST nodes on `runSync`
-      visit(content, createQueries.UNIST.isHtmlWithType, buildHtmlTypeLink);
+      visit(content, isHtmlWithType, buildHtmlTypeLink);
 
       // Splits the content into the Heading node and the rest of the content
       const [headingNode, ...restNodes] = content.children;

src/generators/jsx-ast/utils/buildSignature.mjs

@@ -1,19 +1,3 @@
-// Grabs a method's name
-export const NAME_EXPRESSION = /^['`"]?([^'`": {]+)['`"]?\s*:?\s*/;
-
-// Denotes a method's type
-export const TYPE_EXPRESSION = /^\{([^}]+)\}\s*/;
-
-// Checks if there's a leading hyphen
-export const LEADING_HYPHEN = /^-\s*/;
-
-// Grabs the default value if present
-export const DEFAULT_EXPRESSION = /\s*\*\*Default:\*\*\s*([^]+)$/i;
-
-// Grabs the parameters from a method's signature
-//  ex/ 'new buffer.Blob([sources[, options]])'.match(PARAM_EXPRESSION) === ['([sources[, options]])', '[sources[, options]]']
-export const PARAM_EXPRESSION = /\((.+)\);?$/;
-
 // The plurals associated with each section type.
 export const SECTION_TYPE_PLURALS = {
   module: 'modules',