⬅️ Back to Table of Contents

📄 createRuleDocsPage.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	6

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

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

📦 Imports

Name	Source
ESLintPluginRuleModule	@typescript-eslint/eslint-plugin/use-at-your-own-risk/rules
VFileWithStem	../utils/rules
HeadingName	./RuleDocsPage
findHeadingIndex	../utils/rules
requiredHeadingNames	./RuleDocsPage
RuleDocsPage	./RuleDocsPage

---

Functions

createRuleDocsPage(children: unist.Node[], file: Readonly<VFileWithStem>, rule: Readonly<ESLintPluginRuleModule>): RuleDocsPage

Code

export function createRuleDocsPage(
  children: unist.Node[],
  file: Readonly<VFileWithStem>,
  rule: Readonly<ESLintPluginRuleModule>,
): RuleDocsPage {
  const headingIndices = requiredHeadingNames.map(headingName =>
    findHeadingIndex(children, 2, headingName),
  );

  function insertIfMissing(
    headingName: HeadingName,
    insertionIndex?: number,
  ): void {
    if (headingIndices[requiredHeadingNames.indexOf(headingName)] !== -1) {
      return;
    }

    // Unless otherwise specified: if the heading doesn't yet exist,
    // insert it before the first heading that does,
    // or if none yet exist, push it to the end of children.
    insertionIndex ??=
      headingIndices.find(existingIndex => existingIndex !== -1) ??
      children.length;

    children.splice(insertionIndex, 0, {
      children: [
        {
          type: 'text',
          value: headingName,
        },
      ],
      depth: 2,
      type: 'heading',
    } as mdast.Heading);
  }

  insertIfMissing('Options');

  if (rule.meta.docs.extendsBaseRule) {
    insertIfMissing('How to Use');
  }

  if (rule.meta.docs.requiresTypeChecking) {
    insertIfMissing(
      'When Not To Use It',
      headingIndices[3] === -1 ? children.length : headingIndices[3],
    );
  }

  return new RuleDocsPage(children, file, rule);
}

• Parameters:
• children: unist.Node[]
• file: Readonly<VFileWithStem>
• rule: Readonly<ESLintPluginRuleModule>
• Return Type: RuleDocsPage
• Calls:
• requiredHeadingNames.map
• findHeadingIndex (from ../utils/rules)
• requiredHeadingNames.indexOf
• headingIndices.find
• children.splice
• insertIfMissing
• Internal Comments:

  // Unless otherwise specified: if the heading doesn't yet exist, (x3)
  // insert it before the first heading that does, (x3)
  // or if none yet exist, push it to the end of children. (x3)
  

insertIfMissing(headingName: HeadingName, insertionIndex: number): void

Code

function insertIfMissing(
    headingName: HeadingName,
    insertionIndex?: number,
  ): void {
    if (headingIndices[requiredHeadingNames.indexOf(headingName)] !== -1) {
      return;
    }

    // Unless otherwise specified: if the heading doesn't yet exist,
    // insert it before the first heading that does,
    // or if none yet exist, push it to the end of children.
    insertionIndex ??=
      headingIndices.find(existingIndex => existingIndex !== -1) ??
      children.length;

    children.splice(insertionIndex, 0, {
      children: [
        {
          type: 'text',
          value: headingName,
        },
      ],
      depth: 2,
      type: 'heading',
    } as mdast.Heading);
  }

• Parameters:
• headingName: HeadingName
• insertionIndex: number
• Return Type: void
• Calls:
• requiredHeadingNames.indexOf
• headingIndices.find
• children.splice
• Internal Comments:

  // Unless otherwise specified: if the heading doesn't yet exist, (x3)
  // insert it before the first heading that does, (x3)
  // or if none yet exist, push it to the end of children. (x3)
  

---