Skip to content

no-missing-link-fragments.md

Latest commit

 

History

History
118 lines (67 loc) · 3.5 KB

no-missing-link-fragments.md

File metadata and controls

118 lines (67 loc) · 3.5 KB

no-missing-link-fragments

Disallow link fragments that don't exist in the document.

Background

Ensures that link fragments (URLs that start with #) reference valid headings or anchors in the document. This rule helps prevent broken internal links.

This rule uses GitHub's heading algorithm for generating heading IDs, implemented via the github-slugger package. This ensures compatibility with how GitHub renders Markdown heading anchors.

# Introduction

[Link](#introduction)

Rule Details

This rule is triggered when a link fragment does not match any of the fragments that are automatically generated for headings in a document or explicitly defined via HTML anchors or custom heading IDs.

Examples of incorrect code for this rule:

<!-- eslint markdown/no-missing-link-fragments: "error" -->

[Invalid Link](#non-existent-heading)

# Some Heading

[Case Mismatch](#other-heading)

Examples of correct code for this rule:

<!-- eslint markdown/no-missing-link-fragments: "error" -->

# Introduction

[Valid Link](#introduction)

# Another Section {#custom-id}

[Link to custom ID](#custom-id)

<h1 id="html-anchor">HTML Anchor</h1>

[Link to HTML anchor](#html-anchor)

<a name="named-anchor">Named Anchor</a>

[Link to named anchor](#named-anchor)

[Link to top of page](#top)

[Link](#L2)

# café

[Link to café](#caf%C3%A9)

# <span class="icon-star"></span> Starred Projects

[Link to starred projects](#-starred-projects)

Options

This rule supports the following options:

  • ignoreCase: boolean - When false, link fragments are compared with heading and anchor IDs in a case-sensitive manner. (default: true)

    Examples of incorrect code when configured as "no-missing-link-fragments": ["error", { ignoreCase: false }]:

    <!-- eslint markdown/no-missing-link-fragments: ["error", { ignoreCase: false }] -->

# Case Test

[Invalid Link with different case](#CASE-TEST)

    Examples of correct code when configured as "no-missing-link-fragments": ["error", { ignoreCase: false }]:

    <!-- eslint markdown/no-missing-link-fragments: ["error", { ignoreCase: false }] -->

# Case Test

[Valid Link with matching case](#case-test)

  • allowPattern: string - A regular expression string. If a link fragment matches this pattern, it will be ignored by the rule. This is useful for fragments that are dynamically generated or handled by other tools. (default: "")

    Examples of correct code when configured as "no-missing-link-fragments": ["error", { allowPattern: "" }]:

    <!-- eslint markdown/no-missing-link-fragments: ["error", { allowPattern: "^figure-" }] -->

[Ignored Link](#figure-19)

When Not To Use It

You might consider disabling this rule if:

  • You are using a Markdown processor or static site generator that has a significantly different algorithm for generating heading IDs, and this rule produces too many false positives.
  • You have many dynamically generated links or fragments that cannot be easily covered by the allowPattern option.

Further Reading

Prior Art