style: fix prettier

This allows to use the same version as markdownlint v0.34.0.

.eslintrc.json

@@ -1,7 +1,11 @@
 {
   "extends": ["conventions", "prettier"],
-  "plugins": ["prettier"],
+  "plugins": ["prettier", "import", "unicorn"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
   "rules": {
-    "prettier/prettier": "error"
+    "prettier/prettier": "error",
+    "import/extensions": ["error", "always"]
   }
 }

.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: "actions/checkout@v4.1.1"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: "actions/checkout@v4.1.1"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.husky/commit-msg

@@ -1,4 +1,3 @@
-#!/bin/sh
+#!/usr/bin/env sh
-. "$(dirname "$0")/_/husky.sh"
 
 npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,5 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
-. "$(dirname "$0")/_/husky.sh"
 
 npm run lint:staged
 npm run lint:javascript

.lintstagedrc.json

@@ -1,6 +1,7 @@
 {
-  "*": ["editorconfig-checker"],
+  "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
-  "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
+  "**/*.md": ["markdownlint-cli2 --fix --no-globs"],
-  "*.{json,jsonc,yml,yaml}": ["prettier --write"],
+  "**/*.{js,jsx,ts,tsx}": [
-  "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
+    "eslint --fix --max-warnings 0 --report-unused-disable-directives"
+  ]
 }

.markdownlint-cli2.jsonc

@@ -1,11 +1,11 @@
 {
   "config": {
     "extends": "markdownlint/style/prettier",
-    "relative-links": true,
     "default": true,
-    "MD033": false
+    "relative-links": true,
+    "no-inline-html": false,
   },
-  "globs": ["**/*.{md,mdx}"],
+  "globs": ["**/*.md"],
   "ignores": ["**/node_modules", "**/test/fixtures/**"],
-  "customRules": ["./src/index.js"]
+  "customRules": ["./src/index.js"],
 }

LICENSE

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) Théo LUDWIG
+Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,7 +10,7 @@
   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
   <br />
   <a href="https://github.com/theoludwig/markdownlint-rule-relative-links/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/markdownlint-rule-relative-links/actions/workflows/lint.yml/badge.svg?branch=develop" alt="Lint" /></a>
-  <a href="https://github.com/theoludwig/markdownlint-rule-relative-linksactions/workflows/test.yml"><img src="https://github.com/theoludwig/markdownlint-rule-relative-links/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test" /></a>
+  <a href="https://github.com/theoludwig/markdownlint-rule-relative-links/actions/workflows/test.yml"><img src="https://github.com/theoludwig/markdownlint-rule-relative-links/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test" /></a>
   <br />
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@@ -49,13 +49,12 @@ awesome.md:3 relative-links Relative links should be valid ["./invalid.txt" shou
 ### Additional features
 
 - Support images (e.g: `![Image](./image.png)`).
-- Support anchors (heading fragment links) (e.g: `[Link](./awesome.md#existing-heading)`).
+- Support links fragments similar to the [built-in `markdownlint` rule - MD051](https://github.com/DavidAnson/markdownlint/blob/main/doc/md051.md) (e.g: `[Link](./awesome.md#heading)`).
 - Ignore external links and absolute paths as it only checks relative links (e.g: `https://example.com/` or `/absolute/path.png`).
 
 ### Limitations
 
-- Only images and links defined using markdown syntax are supported, html syntax is not supported (e.g: `<a href="./link.txt" />` or `<img src="./image.png" />`).
+- Only images and links defined using markdown syntax are validated, html syntax is ignored (e.g: `<a href="./link.txt" />` or `<img src="./image.png" />`).
-- Anchors checking is limited to headings, other elements are not supported (e.g: with a "id", `<div id="anchor" />`).
 
 Contributions are welcome to improve the rule, and to alleviate these limitations. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
 
@@ -67,7 +66,7 @@ Contributions are welcome to improve the rule, and to alleviate these limitation
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org/) >= 16.0.0
+[Node.js](https://nodejs.org/) >= 16.0.0
 
 ## Installation
 
@@ -89,7 +88,7 @@ We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markd
     "default": true,
     "relative-links": true
   },
-  "globs": ["**/*.{md,mdx}"],
+  "globs": ["**/*.md"],
   "ignores": ["**/node_modules"],
   "customRules": ["markdownlint-rule-relative-links"]
 }

jsconfig.json

@@ -9,6 +9,7 @@
     "noEmit": true,
     "rootDir": ".",
     "baseUrl": ".",
+    "skipLibCheck": true,
     "strict": true,
     "allowUnusedLabels": false,
     "allowUnreachableCode": false,

package.json

@@ -37,35 +37,35 @@
     "lint:prettier": "prettier . --check --ignore-path .gitignore",
     "lint:javascript": "tsc --project jsconfig.json --noEmit",
     "lint:staged": "lint-staged",
-    "test": "node --test --experimental-test-coverage ./test",
+    "test": "node --test",
     "release": "semantic-release",
-    "postinstall": "husky install",
+    "postinstall": "husky",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "markdown-it": "14.0.0"
+    "markdown-it": "14.1.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.4.4",
+    "@commitlint/cli": "19.1.0",
-    "@commitlint/config-conventional": "18.4.4",
+    "@commitlint/config-conventional": "19.1.0",
-    "@types/markdown-it": "13.0.7",
+    "@types/markdown-it": "14.0.0",
-    "@types/node": "20.10.8",
+    "@types/node": "20.12.5",
-    "editorconfig-checker": "5.1.2",
+    "editorconfig-checker": "5.1.5",
     "eslint": "8.56.0",
-    "eslint-config-conventions": "13.1.0",
+    "eslint-config-conventions": "14.1.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-prettier": "5.1.2",
+    "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "50.0.1",
+    "eslint-plugin-unicorn": "51.0.1",
-    "husky": "8.0.3",
+    "husky": "9.0.11",
-    "lint-staged": "15.2.0",
+    "lint-staged": "15.2.2",
-    "markdownlint": "0.33.0",
+    "markdownlint": "0.34.0",
-    "markdownlint-cli2": "0.11.0",
+    "markdownlint-cli2": "0.13.0",
     "pinst": "3.0.0",
-    "prettier": "3.1.1",
+    "prettier": "3.2.5",
-    "semantic-release": "22.0.12",
+    "semantic-release": "23.0.7",
-    "typescript": "5.3.3"
+    "typescript": "5.4.4"
   }
 }

src/index.js

@@ -3,10 +3,14 @@
 const { pathToFileURL } = require("node:url")
 const fs = require("node:fs")
 
+const { filterTokens } = require("./markdownlint-rule-helpers/helpers.js")
 const {
-  filterTokens,
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
+  getMarkdownIdOrAnchorNameFragments,
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
 } = require("./utils.js")
 
 /** @typedef {import('markdownlint').Rule} MarkdownLintRule */
@@ -18,6 +22,7 @@ const customRule = {
   names: ["relative-links"],
   description: "Relative links should be valid",
   tags: ["links"],
+  parser: "markdownit",
   function: (params, onError) => {
     filterTokens(params, "inline", (token) => {
       const children = token.children ?? []
@@ -45,46 +50,115 @@ const customRule = {
           }
         }
 
-        if (hrefSrc != null) {
+        if (hrefSrc == null) {
-          const url = new URL(hrefSrc, pathToFileURL(params.name))
+          continue
-          const isRelative =
+        }
-            url.protocol === "file:" && !hrefSrc.startsWith("/")
-          if (isRelative) {
-            const detail = `"${hrefSrc}"`
 
-            if (!fs.existsSync(url)) {
+        const url = new URL(hrefSrc, pathToFileURL(params.name))
+        const isRelative =
+          url.protocol === "file:" &&
+          !hrefSrc.startsWith("/") &&
+          !hrefSrc.startsWith("#")
+
+        if (!isRelative) {
+          continue
+        }
+
+        const detail = `"${hrefSrc}"`
+
+        if (!fs.existsSync(url)) {
+          onError({
+            lineNumber,
+            detail: `${detail} should exist in the file system`,
+          })
+          continue
+        }
+
+        if (url.hash.length <= 0) {
+          if (hrefSrc.includes("#")) {
+            if (type === "image") {
               onError({
                 lineNumber,
-                detail: `${detail} should exist in the file system`,
+                detail: `${detail} should not have a fragment identifier as it is an image`,
               })
               continue
             }
 
-            if (type === "link_open" && url.hash !== "") {
+            onError({
-              const fileContent = fs.readFileSync(url, { encoding: "utf8" })
+              lineNumber,
-              const headings = getMarkdownHeadings(fileContent)
+              detail: `${detail} should have a valid fragment identifier`,
+            })
+            continue
+          }
+          continue
+        }
 
-              /** @type {Map<string, number>} */
+        if (type === "image") {
-              const fragments = new Map()
+          onError({
+            lineNumber,
+            detail: `${detail} should not have a fragment identifier as it is an image`,
+          })
+          continue
+        }
 
-              const headingsHTMLFragments = headings.map((heading) => {
+        if (!url.pathname.endsWith(".md")) {
-                const fragment = convertHeadingToHTMLFragment(heading)
+          continue
-                const count = fragments.get(fragment) ?? 0
+        }
-                fragments.set(fragment, count + 1)
+
-                if (count !== 0) {
+        const fileContent = fs.readFileSync(url, { encoding: "utf8" })
-                  return `${fragment}-${count}`
+        const headings = getMarkdownHeadings(fileContent)
-                }
+        const idOrAnchorNameHTMLFragments =
-                return fragment
+          getMarkdownIdOrAnchorNameFragments(fileContent)
+
+        /** @type {Map<string, number>} */
+        const fragments = new Map()
+
+        const fragmentsHTML = headings.map((heading) => {
+          const fragment = convertHeadingToHTMLFragment(heading)
+          const count = fragments.get(fragment) ?? 0
+          fragments.set(fragment, count + 1)
+          if (count !== 0) {
+            return `${fragment}-${count}`
+          }
+          return fragment
+        })
+
+        fragmentsHTML.push(...idOrAnchorNameHTMLFragments)
+
+        if (!fragmentsHTML.includes(url.hash.toLowerCase())) {
+          if (url.hash.startsWith("#L")) {
+            const lineNumberFragmentString = getLineNumberStringFromFragment(
+              url.hash,
+            )
+
+            const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
+            if (!hasOnlyDigits) {
+              onError({
+                lineNumber,
+                detail: `${detail} should have a valid fragment identifier`,
               })
+              continue
+            }
 
-              if (!headingsHTMLFragments.includes(url.hash)) {
+            const lineNumberFragment = Number.parseInt(
-                onError({
+              lineNumberFragmentString,
-                  lineNumber,
+              10,
-                  detail: `${detail} should have a valid fragment identifier`,
+            )
-                })
+            const numberOfLines = getNumberOfLines(fileContent)
-              }
+            if (lineNumberFragment > numberOfLines) {
+              onError({
+                lineNumber,
+                detail: `${detail} should have a valid fragment identifier, ${detail} should have at least ${lineNumberFragment} lines to be valid`,
+              })
+              continue
             }
           }
+
+          onError({
+            lineNumber,
+            detail: `${detail} should have a valid fragment identifier`,
+          })
+          continue
         }
       }
     })

src/markdownlint-rule-helpers/helpers.js

@@ -0,0 +1,38 @@
+/**
+ * Dependency Vendoring of `markdownlint-rule-helpers`
+ * @see https://www.npmjs.com/package/markdownlint-rule-helpers
+ */
+
+/** @typedef {import('markdownlint').RuleParams} MarkdownLintRuleParams */
+/** @typedef {import('markdownlint').MarkdownItToken} MarkdownItToken */
+
+/**
+ * Calls the provided function for each matching token.
+ *
+ * @param {MarkdownLintRuleParams} params RuleParams instance.
+ * @param {string} type Token type identifier.
+ * @param {(token: MarkdownItToken) => void} handler Callback function.
+ * @returns {void}
+ */
+const filterTokens = (params, type, handler) => {
+  for (const token of params.parsers.markdownit.tokens) {
+    if (token.type === type) {
+      handler(token)
+    }
+  }
+}
+
+/**
+ * Gets a Regular Expression for matching the specified HTML attribute.
+ *
+ * @param {string} name HTML attribute name.
+ * @returns {RegExp} Regular Expression for matching.
+ */
+const getHtmlAttributeRe = (name) => {
+  return new RegExp(`\\s${name}\\s*=\\s*['"]?([^'"\\s>]*)`, "iu")
+}
+
+module.exports = {
+  filterTokens,
+  getHtmlAttributeRe,
+}

src/utils.js

@@ -1,23 +1,8 @@
 const MarkdownIt = require("markdown-it")
 
-/** @typedef {import('markdownlint').RuleParams} MarkdownLintRuleParams */
+const { getHtmlAttributeRe } = require("./markdownlint-rule-helpers/helpers.js")
-/** @typedef {import('markdownlint').MarkdownItToken} MarkdownItToken */
 
-/**
+const markdownIt = new MarkdownIt({ html: true })
- * Calls the provided function for each matching token.
- *
- * @param {MarkdownLintRuleParams} params RuleParams instance.
- * @param {string} type Token type identifier.
- * @param {(token: MarkdownItToken) => void} handler Callback function.
- * @returns {void}
- */
-const filterTokens = (params, type, handler) => {
-  for (const token of params.tokens) {
-    if (token.type === type) {
-      handler(token)
-    }
-  }
-}
 
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
@@ -41,7 +26,7 @@ const convertHeadingToHTMLFragment = (inlineText) => {
           "",
         )
         .replace(/ /gu, "-"),
-    )
+    ).toLowerCase()
   )
 }
 
@@ -54,7 +39,6 @@ const ignoredTokens = new Set(["heading_open", "heading_close"])
  * @returns {string[]}
  */
 const getMarkdownHeadings = (content) => {
-  const markdownIt = new MarkdownIt({ html: true })
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -94,8 +78,83 @@ const getMarkdownHeadings = (content) => {
   return headings
 }
 
+const nameHTMLAttributeRegex = getHtmlAttributeRe("name")
+const idHTMLAttributeRegex = getHtmlAttributeRe("id")
+
+/**
+ * Gets the id or anchor name fragments from a Markdown string.
+ * @param {string} content
+ * @returns {string[]}
+ */
+const getMarkdownIdOrAnchorNameFragments = (content) => {
+  const tokens = markdownIt.parse(content, {})
+
+  /** @type {string[]} */
+  const result = []
+
+  for (const token of tokens) {
+    const regexMatch =
+      idHTMLAttributeRegex.exec(token.content) ||
+      nameHTMLAttributeRegex.exec(token.content)
+    if (regexMatch == null) {
+      continue
+    }
+
+    const idOrName = regexMatch[1]
+    if (idOrName == null || idOrName.length <= 0) {
+      continue
+    }
+
+    const htmlFragment = "#" + idOrName
+    if (!result.includes(htmlFragment)) {
+      result.push(htmlFragment)
+    }
+  }
+
+  return result
+}
+
+/**
+ * Checks if a string is a valid integer.
+ *
+ * Using `Number.parseInt` combined with `Number.isNaN` will not be sufficient enough because `Number.parseInt("1abc", 10)` will return `1` (a valid number) instead of `NaN`.
+ *
+ * @param {string} value
+ * @returns {boolean}
+ * @example isValidIntegerString("1") // true
+ * @example isValidIntegerString("45") // true
+ * @example isValidIntegerString("1abc") // false
+ * @example isValidIntegerString("1.0") // false
+ */
+const isValidIntegerString = (value) => {
+  const regex = /^\d+$/
+  return regex.test(value)
+}
+
+/**
+ * Gets the number of lines in a string, based on the number of `\n` characters.
+ * @param {string} content
+ * @returns {number}
+ */
+const getNumberOfLines = (content) => {
+  return content.split("\n").length
+}
+
+/**
+ * Gets the line number string from a fragment.
+ * @param {string} fragment
+ * @returns {string}
+ * @example getLineNumberStringFromFragment("#L50") // 50
+ */
+const getLineNumberStringFromFragment = (fragment) => {
+  return fragment.slice(2)
+}
+
 module.exports = {
-  filterTokens,
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
+  getMarkdownIdOrAnchorNameFragments,
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
 }

test/fixtures/invalid/empty-id-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<div id>Content</div>

test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment](./awesome.md#)

test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md

@@ -0,0 +1,3 @@
+# Invalid
+
+![Image](../image.png#)

test/fixtures/invalid/ignore-fragment-checking-for-image.md

@@ -0,0 +1,3 @@
+# Invalid
+
+![Image](../image.png#non-existing-fragment)

test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<input name="name-should-be-ignored" id="id-after-name" />

test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/ignore-name-fragment-if-not-an-anchor.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Invalid](./awesome.md#name-should-be-ignored)

test/fixtures/invalid/ignore-not-an-id-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<div data-id="not-an-id-should-be-ignored">Content</div>

test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Invalid](./awesome.md#not-an-id-should-be-ignored)

test/fixtures/invalid/invalid-heading-with-L-fragment/awesome.md

@@ -0,0 +1 @@
+# Awesome

test/fixtures/invalid/invalid-heading-with-L-fragment/invalid-heading-with-L-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment line number 7](./awesome.md#L7abc)

test/fixtures/invalid/invalid-line-number-fragment/awesome.md

@@ -0,0 +1 @@
+# Awesome

test/fixtures/invalid/invalid-line-number-fragment/invalid-line-number-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment line number 7](./awesome.md#L7)

test/fixtures/invalid/non-existing-anchor-name-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<a name="existing-heading-anchor">Link</a>

test/fixtures/invalid/non-existing-anchor-name-fragment/non-existing-anchor-name-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment](./awesome.md#non-existing-anchor-name-fragment)

test/fixtures/invalid/non-existing-element-id-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<div id="existing-element-id-fragment">Content</div>

test/fixtures/invalid/non-existing-element-id-fragment/non-existing-element-id-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment](./awesome.md#non-existing-element-id-fragment)

test/fixtures/invalid/non-existing-heading-fragment/awesome.md

@@ -1,3 +1,3 @@
-# Valid
+# Awesome
 
 ## Existing Heading

test/fixtures/valid/existing-anchor-name-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<a name="existing-heading-anchor">Link</a>

test/fixtures/valid/existing-anchor-name-fragment/existing-anchor-name-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment](./awesome.md#existing-heading-anchor)

test/fixtures/valid/existing-element-id-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+<div id="existing-element-id-fragment">Content</div>

test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[Link fragment](./awesome.md#existing-element-id-fragment)

test/fixtures/valid/existing-heading-case-insensitive/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+## Existing Heading

test/fixtures/valid/existing-heading-case-insensitive/existing-heading-case-insensitive.md

@@ -0,0 +1,3 @@
+# Valid
+
+[Link fragment](./awesome.md#ExistIng-Heading)

test/fixtures/valid/existing-heading-fragment/awesome.md

@@ -1,4 +1,4 @@
-# Valid
+# Awesome
 
 ## Existing Heading
 

test/fixtures/valid/existing-heading-with-accents/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+## Développement

test/fixtures/valid/existing-heading-with-accents/existing-heading-with-accents.md

@@ -0,0 +1,3 @@
+# Valid
+
+[Link fragment](./awesome.md#développement)

test/fixtures/valid/existing-image.md

@@ -1,3 +1,3 @@
 # Valid
 
-![Image](./image.png)
+![Image](../image.png)

test/fixtures/valid/ignore-fragment-checking-in-own-file.md

@@ -0,0 +1,5 @@
+# Valid
+
+<div id="existing-element-id-fragment">Content</div>
+
+[Link fragment](#non-existing-element-id-fragment)

test/fixtures/valid/only-parse-markdown-files-for-fragments/awesome.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Awesome</title>
+  </head>
+  <body></body>
+</html>

test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md

@@ -0,0 +1,7 @@
+# Valid
+
+[Link fragment HTML](./awesome.html#existing-heading)
+
+[Link fragment TXT](./abc.txt#existing-heading)
+
+[Link fragment Image](../../image.png#existing-heading)

test/fixtures/valid/valid-heading-like-number-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+## L7

test/fixtures/valid/valid-heading-like-number-fragment/valid-heading-like-number-fragment.md

@@ -0,0 +1,3 @@
+# Valid
+
+[Link fragment](./awesome.md#L7)

test/fixtures/valid/valid-line-number-fragment/awesome.md

@@ -0,0 +1,9 @@
+# Awesome
+
+ABC
+
+Line 5
+
+Line 7 Text
+
+## L7

test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md

@@ -0,0 +1,3 @@
+# Valid
+
+[Link fragment line number 7](./awesome.md#L7)

test/index.test.js

@@ -23,90 +23,172 @@ const validateMarkdownLint = async (fixtureFile) => {
 }
 
 test("ensure the rule validates correctly", async (t) => {
-  await t.test("should be valid", async (t) => {
+  await t.test("should be invalid", async (t) => {
-    await t.test("with an existing heading fragment", async () => {
+    const testCases = [
-      const lintResults = await validateMarkdownLint(
+      {
-        "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
+        name: "should be invalid with an empty id fragment",
-      )
+        fixturePath:
-      assert.equal(lintResults?.length, 0)
+          "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
-    })
+        error: '"./awesome.md#" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a name fragment other than for an anchor",
+        fixturePath:
+          "test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/ignore-name-fragment-if-not-an-anchor.md",
+        error:
+          '"./awesome.md#name-should-be-ignored" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a non-existing id fragment (data-id !== id)",
+        fixturePath:
+          "test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md",
+        error:
+          '"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with invalid heading with #L fragment",
+        fixturePath:
+          "test/fixtures/invalid/invalid-heading-with-L-fragment/invalid-heading-with-L-fragment.md",
+        error: '"./awesome.md#L7abc" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a invalid line number fragment",
+        fixturePath:
+          "test/fixtures/invalid/invalid-line-number-fragment/invalid-line-number-fragment.md",
+        error:
+          '"./awesome.md#L7" should have a valid fragment identifier, "./awesome.md#L7" should have at least 7 lines to be valid',
+      },
+      {
+        name: "should be invalid with a non-existing anchor name fragment",
+        fixturePath:
+          "test/fixtures/invalid/non-existing-anchor-name-fragment/non-existing-anchor-name-fragment.md",
+        error:
+          '"./awesome.md#non-existing-anchor-name-fragment" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a non-existing element id fragment",
+        fixturePath:
+          "test/fixtures/invalid/non-existing-element-id-fragment/non-existing-element-id-fragment.md",
+        error:
+          '"./awesome.md#non-existing-element-id-fragment" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a non-existing heading fragment",
+        fixturePath:
+          "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
+        error:
+          '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
+      },
+      {
+        name: "should be invalid with a link to an image with a empty fragment",
+        fixturePath:
+          "test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md",
+        error:
+          '"../image.png#" should not have a fragment identifier as it is an image',
+      },
+      {
+        name: "should be invalid with a link to an image with a fragment",
+        fixturePath:
+          "test/fixtures/invalid/ignore-fragment-checking-for-image.md",
+        error:
+          '"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image',
+      },
+      {
+        name: "should be invalid with a non-existing file",
+        fixturePath: "test/fixtures/invalid/non-existing-file.md",
+        error: '"./index.test.js" should exist in the file system',
+      },
+      {
+        name: "should be invalid with a non-existing image",
+        fixturePath: "test/fixtures/invalid/non-existing-image.md",
+        error: '"./image.png" should exist in the file system',
+      },
+    ]
 
-    await t.test("with an existing file", async () => {
+    for (const { name, fixturePath, error } of testCases) {
-      const lintResults = await validateMarkdownLint(
+      await t.test(name, async () => {
-        "test/fixtures/valid/existing-file.md",
+        const lintResults = await validateMarkdownLint(fixturePath)
-      )
+        assert.equal(lintResults?.length, 1)
-      assert.equal(lintResults?.length, 0)
+        assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
-    })
+        assert.equal(
-
+          lintResults?.[0]?.ruleDescription,
-    await t.test("with an existing image", async () => {
+          relativeLinksRule.description,
-      const lintResults = await validateMarkdownLint(
+        )
-        "test/fixtures/valid/existing-image.md",
+        assert.equal(lintResults?.[0]?.errorDetail, error)
-      )
+      })
-      assert.equal(lintResults?.length, 0)
+    }
-    })
-
-    await t.test("should ignore absolute paths", async () => {
-      const lintResults = await validateMarkdownLint(
-        "test/fixtures/valid/ignore-absolute-paths.md",
-      )
-      assert.equal(lintResults?.length, 0)
-    })
-
-    await t.test("should ignore external links", async () => {
-      const lintResults = await validateMarkdownLint(
-        "test/fixtures/valid/ignore-external-links.md",
-      )
-      assert.equal(lintResults?.length, 0)
-    })
   })
 
-  await t.test("should be invalid", async (t) => {
+  await t.test("should be valid", async (t) => {
-    await t.test("with a non-existing heading fragment", async () => {
+    const testCases = [
-      const lintResults = await validateMarkdownLint(
+      {
-        "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
+        name: "should be valid with an existing anchor name fragment",
-      )
+        fixturePath:
-      assert.equal(lintResults?.length, 1)
+          "test/fixtures/valid/existing-anchor-name-fragment/existing-anchor-name-fragment.md",
-      assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
+      },
-      assert.equal(
+      {
-        lintResults?.[0]?.ruleDescription,
+        name: "should be valid with an existing element id fragment",
-        relativeLinksRule.description,
+        fixturePath:
-      )
+          "test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md",
-      assert.equal(
+      },
-        lintResults?.[0]?.errorDetail,
+      {
-        '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
+        name: "should be valid with an existing heading fragment (case insensitive)",
-      )
+        fixturePath:
-    })
+          "test/fixtures/valid/existing-heading-case-insensitive/existing-heading-case-insensitive.md",
+      },
+      {
+        name: "should be valid with an existing heading fragment",
+        fixturePath:
+          "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
+      },
+      {
+        name: 'should be valid with an existing heading fragment with accents (e.g: "é")',
+        fixturePath:
+          "test/fixtures/valid/existing-heading-with-accents/existing-heading-with-accents.md",
+      },
+      {
+        name: "should only parse markdown files for fragments checking",
+        fixturePath:
+          "test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md",
+      },
+      {
+        name: 'should be valid with valid heading "like" line number fragment',
+        fixturePath:
+          "test/fixtures/valid/valid-heading-like-number-fragment/valid-heading-like-number-fragment.md",
+      },
+      {
+        name: "should be valid with valid line number fragment",
+        fixturePath:
+          "test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md",
+      },
+      {
+        name: "should be valid with an existing file",
+        fixturePath: "test/fixtures/valid/existing-file.md",
+      },
+      {
+        name: "should be valid with an existing image",
+        fixturePath: "test/fixtures/valid/existing-image.md",
+      },
+      {
+        name: "should ignore absolute paths",
+        fixturePath: "test/fixtures/valid/ignore-absolute-paths.md",
+      },
+      {
+        name: "should ignore external links",
+        fixturePath: "test/fixtures/valid/ignore-external-links.md",
+      },
+      {
+        name: "should ignore checking fragment in own file",
+        fixturePath:
+          "test/fixtures/valid/ignore-fragment-checking-in-own-file.md",
+      },
+    ]
 
-    await t.test("with a non-existing file", async () => {
+    for (const { name, fixturePath } of testCases) {
-      const lintResults = await validateMarkdownLint(
+      await t.test(name, async () => {
-        "test/fixtures/invalid/non-existing-file.md",
+        const lintResults = await validateMarkdownLint(fixturePath)
-      )
+        assert.equal(lintResults?.length, 0)
-      assert.equal(lintResults?.length, 1)
+      })
-      assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
+    }
-      assert.equal(
-        lintResults?.[0]?.ruleDescription,
-        relativeLinksRule.description,
-      )
-      assert.equal(
-        lintResults?.[0]?.errorDetail,
-        '"./index.test.js" should exist in the file system',
-      )
-    })
-
-    await t.test("with a non-existing image", async () => {
-      const lintResults = await validateMarkdownLint(
-        "test/fixtures/invalid/non-existing-image.md",
-      )
-      assert.equal(lintResults?.length, 1)
-      assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
-      assert.equal(
-        lintResults?.[0]?.ruleDescription,
-        relativeLinksRule.description,
-      )
-      assert.equal(
-        lintResults?.[0]?.errorDetail,
-        '"./image.png" should exist in the file system',
-      )
-    })
   })
 })

test/utils.test.js

@@ -4,6 +4,10 @@ const assert = require("node:assert/strict")
 const {
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
+  getMarkdownIdOrAnchorNameFragments,
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
 } = require("../src/utils.js")
 
 test("utils", async (t) => {
@@ -34,4 +38,42 @@ test("utils", async (t) => {
       ["Hello", "World", "Hello, world!"],
     )
   })
+
+  await t.test("getMarkdownIdOrAnchorNameFragments", async () => {
+    assert.deepStrictEqual(
+      getMarkdownIdOrAnchorNameFragments(
+        '<a name="anchorName" id="anchorId">Link</a>',
+      ),
+      ["#anchorId"],
+    )
+    assert.deepStrictEqual(
+      getMarkdownIdOrAnchorNameFragments('<a name="anchorName">Link</a>'),
+      ["#anchorName"],
+    )
+    assert.deepStrictEqual(
+      getMarkdownIdOrAnchorNameFragments("<a>Link</a>"),
+      [],
+    )
+    assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>"), [])
+    assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a id=>"), [])
+  })
+
+  await t.test("isValidIntegerString", async () => {
+    assert.strictEqual(isValidIntegerString("1"), true)
+    assert.strictEqual(isValidIntegerString("45"), true)
+    assert.strictEqual(isValidIntegerString("1abc"), false)
+    assert.strictEqual(isValidIntegerString("1.0"), false)
+  })
+
+  await t.test("getNumberOfLines", async () => {
+    assert.strictEqual(getNumberOfLines(""), 1)
+    assert.strictEqual(getNumberOfLines("Hello"), 1)
+    assert.strictEqual(getNumberOfLines("Hello\nWorld"), 2)
+    assert.strictEqual(getNumberOfLines("Hello\nWorld\n"), 3)
+    assert.strictEqual(getNumberOfLines("Hello\nWorld\n\n"), 4)
+  })
+
+  await t.test("getLineNumberStringFromFragment", async () => {
+    assert.strictEqual(getLineNumberStringFromFragment("#L50"), "50")
+  })
 })