⬅️ Back to Table of Contents

📄 addESLintHashToCodeBlocksMeta

📊 Analysis Summary

Metric	Count
🔧 Functions	4
📦 Imports	4
📊 Variables & Constants	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/website/plugins/generated-rule-docs/addESLintHashToCodeBlocksMeta.ts

📦 Imports

Name	Source
MdxJsxFlowElement	mdast-util-mdx
RuleDocsPage	./RuleDocsPage
nodeIsCode	../utils/nodes
convertToPlaygroundHash	../utils/rules

---

Variables & Constants

Name	Type	Kind	Value	Exported
optionRegex	RegExp	const	/option='(?<option>.*?)'/	✗

---

Functions

addESLintHashToCodeBlocksMeta(page: RuleDocsPage, eslintrc: string): void

Parameters:

• page RuleDocsPage
• eslintrc string

Returns: void

Calls:

• nodeIsJsxTabs
• addHashesToChildrenTabs
• addHashToNodeIfCode
• nodeIsCode (from ../utils/nodes)
• node.meta?.includes
• node.meta?.match
• playgroundEslintrc.replace
• JSON.stringify
• JSON.parse
• console.error
• [ node.meta,eslintrcHash="${convertToPlaygroundHash(playgroundEslintrc)}", ] .filter(Boolean) .join

Internal Comments:

// eslint-disable-next-line no-console (x4)

Code

export function addESLintHashToCodeBlocksMeta(
  page: RuleDocsPage,
  eslintrc: string,
): void {
  for (const node of page.children) {
    if (nodeIsJsxTabs(node)) {
      addHashesToChildrenTabs(node);
    } else {
      addHashToNodeIfCode(node);
    }
  }

  function addHashesToChildrenTabs(node: MdxJsxFlowElement): void {
    for (const tabItem of node.children) {
      if ('children' in tabItem) {
        for (const child of tabItem.children) {
          addHashToNodeIfCode(child, true);
        }
      }
    }
  }

  function addHashToNodeIfCode(node: unist.Node, insideTab?: boolean): void {
    if (
      nodeIsCode(node) &&
      (insideTab || node.meta?.includes('showPlaygroundButton')) &&
      !node.meta?.includes('title="eslint.config.mjs"') &&
      !node.meta?.includes('title=".eslintrc.cjs"') &&
      !node.meta?.includes('eslintrcHash=')
    ) {
      let playgroundEslintrc = eslintrc;
      const option = node.meta?.match(optionRegex)?.groups?.option;
      if (option) {
        playgroundEslintrc = playgroundEslintrc.replace(
          '"error"',
          `["error", ${option}]`,
        );
        try {
          playgroundEslintrc = JSON.stringify(
            JSON.parse(playgroundEslintrc),
            null,
            2,
          );
        } catch (err) {
          // eslint-disable-next-line no-console
          console.error(
            `Invalid JSON detected in ${page.file.basename}. Check the \`option\` in the meta strings of code blocks.`,
          );
          throw err;
        }
      }

      node.meta = [
        node.meta,
        `eslintrcHash="${convertToPlaygroundHash(playgroundEslintrc)}"`,
      ]
        .filter(Boolean)
        .join(' ');
    }
  }
}

nodeIsJsxTabs(node: unist.Node): node is MdxJsxFlowElement

Parameters:

• node unist.Node

Returns: node is MdxJsxFlowElement

Code

function nodeIsJsxTabs(node: unist.Node): node is MdxJsxFlowElement {
  return (
    node.type === 'mdxJsxFlowElement' && 'name' in node && node.name === 'Tabs'
  );
}

Internal helpers

Declared inside another function in this file.

addHashesToChildrenTabs(node: MdxJsxFlowElement): void

Parameters:

• node MdxJsxFlowElement

Returns: void

Calls:

• addHashToNodeIfCode

Code

function addHashesToChildrenTabs(node: MdxJsxFlowElement): void {
    for (const tabItem of node.children) {
      if ('children' in tabItem) {
        for (const child of tabItem.children) {
          addHashToNodeIfCode(child, true);
        }
      }
    }
  }

addHashToNodeIfCode(node: unist.Node, insideTab: boolean): void

Parameters:

• node unist.Node
• insideTab boolean

Returns: void

Calls:

• nodeIsCode (from ../utils/nodes)
• node.meta?.includes
• node.meta?.match
• playgroundEslintrc.replace
• JSON.stringify
• JSON.parse
• console.error
• [ node.meta,eslintrcHash="${convertToPlaygroundHash(playgroundEslintrc)}", ] .filter(Boolean) .join

Internal Comments:

// eslint-disable-next-line no-console (x4)

Code

function addHashToNodeIfCode(node: unist.Node, insideTab?: boolean): void {
    if (
      nodeIsCode(node) &&
      (insideTab || node.meta?.includes('showPlaygroundButton')) &&
      !node.meta?.includes('title="eslint.config.mjs"') &&
      !node.meta?.includes('title=".eslintrc.cjs"') &&
      !node.meta?.includes('eslintrcHash=')
    ) {
      let playgroundEslintrc = eslintrc;
      const option = node.meta?.match(optionRegex)?.groups?.option;
      if (option) {
        playgroundEslintrc = playgroundEslintrc.replace(
          '"error"',
          `["error", ${option}]`,
        );
        try {
          playgroundEslintrc = JSON.stringify(
            JSON.parse(playgroundEslintrc),
            null,
            2,
          );
        } catch (err) {
          // eslint-disable-next-line no-console
          console.error(
            `Invalid JSON detected in ${page.file.basename}. Check the \`option\` in the meta strings of code blocks.`,
          );
          throw err;
        }
      }

      node.meta = [
        node.meta,
        `eslintrcHash="${convertToPlaygroundHash(playgroundEslintrc)}"`,
      ]
        .filter(Boolean)
        .join(' ');
    }
  }

---

Generated by Syntax Scribe