⬅️ Back to Table of Contents

📄 insertRuleDescription

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	2

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/website/plugins/generated-rule-docs/insertions/insertRuleDescription.ts

📦 Imports

Name	Source
MdxJsxFlowElement	mdast-util-mdx
RuleDocsPage	../RuleDocsPage

---

Functions

insertRuleDescription(page: RuleDocsPage): void

Parameters:

• page RuleDocsPage

Returns: void

Calls:

• page.spliceChildren

Code

export function insertRuleDescription(page: RuleDocsPage): void {
  page.spliceChildren(0, 0, `> ${page.rule.meta.docs.description}.`, {
    attributes: [
      {
        name: 'name',
        type: 'mdxJsxAttribute',
        value: page.file.stem,
      },
    ],
    name: 'RuleAttributes',
    type: 'mdxJsxFlowElement',
  } as MdxJsxFlowElement);
}

---

Generated by Syntax Scribe