docs: markdownItFactory is not necessary

Ref: https://github.com/theoludwig/markdownlint-rule-relative-links/issues/13

.commitlintrc.json

@@ -1 +0,0 @@
-{ "extends": ["@commitlint/config-conventional"] }

.eslintrc.json

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

.github/workflows/lint.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   lint:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -21,9 +21,15 @@ jobs:
       - name: "Install dependencies"
         run: "npm clean-install"
 
-      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-      - run: "npm run lint:editorconfig"
-      - run: "npm run lint:markdown"
-      - run: "npm run lint:eslint"
-      - run: "npm run lint:prettier"
-      - run: "npm run lint:javascript"
+      - run: "node --run lint:editorconfig"
+      - run: "node --run lint:markdown"
+      - run: "node --run lint:eslint"
+      - run: "node --run lint:prettier"
+      - run: "node --run lint:typescript"
+
+  commitlint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4.2.2"
+
+      - uses: "wagoid/commitlint-github-action@v6.2.0"

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   release:
@@ -13,13 +13,13 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -31,7 +31,7 @@ jobs:
         run: "npm audit signatures"
 
       - name: "Release"
-        run: "npm run release"
+        run: "node --run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   test:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -22,4 +22,4 @@ jobs:
         run: "npm clean-install"
 
       - name: "Test"
-        run: "npm run test"
+        run: "node --run test"

.gitignore

@@ -20,10 +20,6 @@ npm-debug.log*
 
 # IDE - VSCode
 .vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
 
 # misc
 .DS_Store

.husky/commit-msg

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

.husky/pre-commit

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

.lintstagedrc.json

@@ -1,6 +0,0 @@
-{
-  "*": ["editorconfig-checker"],
-  "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
-  "*.{json,jsonc,yml,yaml}": ["prettier --write"],
-  "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
-}

.markdownlint-cli2.jsonc

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

.markdownlint-cli2.mjs

@@ -0,0 +1,15 @@
+import relativeLinksRule from "./src/index.js"
+
+const config = {
+  config: {
+    extends: "markdownlint/style/prettier",
+    default: true,
+    "relative-links": true,
+    "no-inline-html": false,
+  },
+  globs: ["**/*.md"],
+  ignores: ["**/node_modules", "**/test/fixtures/**"],
+  customRules: [relativeLinksRule],
+}
+
+export default config

.npmrc

@@ -1,2 +1,2 @@
-save-exact=true
-provenance=true
+save-exact = true
+provenance = true

.releaserc.json

@@ -1,18 +1,8 @@
 {
-  "branches": ["master"],
+  "branches": ["main", { "name": "beta", "prerelease": true }],
   "plugins": [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
     "@semantic-release/npm",
     "@semantic-release/github"
   ]

.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  "recommendations": [
-    "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint"
-  ]
-}

.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.configPath": ".prettierrc.json",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
-  }
-}

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

@@ -66,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/) >= 22.0.0
 
 ## Installation
 
@@ -80,18 +80,22 @@ There are various ways [markdownlint](https://github.com/DavidAnson/markdownlint
 
 We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) over [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) for compatibility with the [vscode-markdownlint](https://github.com/DavidAnson/vscode-markdownlint) extension.
 
-`.markdownlint-cli2.jsonc`
+`.markdownlint-cli2.mjs`
 
-```json
-{
-  "config": {
-    "default": true,
-    "relative-links": true
+```js
+import relativeLinksRule from "markdownlint-rule-relative-links"
+
+const config = {
+  config: {
+    default: true,
+    "relative-links": true,
   },
-  "globs": ["**/*.{md,mdx}"],
-  "ignores": ["**/node_modules"],
-  "customRules": ["markdownlint-rule-relative-links"]
+  globs: ["**/*.md"],
+  ignores: ["**/node_modules"],
+  customRules: [relativeLinksRule],
 }
+
+export default config
 ```
 
 `package.json`
@@ -107,7 +111,7 @@ We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markd
 ## Usage
 
 ```sh
-npm run lint:markdown
+node --run lint:markdown
 ```
 
 ## 💡 Contributing

eslint.config.js

@@ -0,0 +1,13 @@
+import typescriptESLint from "typescript-eslint"
+import configConventions from "eslint-config-conventions"
+
+export default typescriptESLint.config(...configConventions, {
+  files: ["**/*.ts", "**/*.tsx"],
+  languageOptions: {
+    parser: typescriptESLint.parser,
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})

package.json

@@ -18,6 +18,8 @@
     "markdownlint-rule"
   ],
   "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
   "files": [
     "src"
   ],
@@ -26,46 +28,35 @@
     "provenance": true
   },
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=9.0.0"
+    "node": ">=22.0.0"
   },
   "scripts": {
-    "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
     "lint:markdown": "markdownlint-cli2",
-    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
-    "lint:prettier": "prettier . --check --ignore-path .gitignore",
-    "lint:javascript": "tsc --project jsconfig.json --noEmit",
-    "lint:staged": "lint-staged",
-    "test": "node --test --experimental-test-coverage",
-    "release": "semantic-release",
-    "postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "lint:eslint": "eslint . --max-warnings 0",
+    "lint:prettier": "prettier . --check",
+    "lint:typescript": "tsc --noEmit",
+    "test": "node --test",
+    "release": "semantic-release"
   },
   "dependencies": {
-    "markdown-it": "14.0.0"
+    "markdown-it": "14.1.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.4.4",
-    "@commitlint/config-conventional": "18.4.4",
-    "@types/markdown-it": "13.0.7",
-    "@types/node": "20.11.0",
-    "editorconfig-checker": "5.1.2",
-    "eslint": "8.56.0",
-    "eslint-config-conventions": "13.1.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "50.0.1",
-    "husky": "8.0.3",
-    "lint-staged": "15.2.0",
-    "markdownlint": "0.33.0",
-    "markdownlint-cli2": "0.11.0",
-    "pinst": "3.0.0",
-    "prettier": "3.1.1",
-    "semantic-release": "22.0.12",
-    "typescript": "5.3.3"
+    "@types/markdown-it": "14.1.2",
+    "@types/node": "22.15.17",
+    "editorconfig-checker": "6.0.1",
+    "eslint": "9.26.0",
+    "eslint-config-conventions": "19.2.0",
+    "eslint-plugin-promise": "7.2.1",
+    "eslint-plugin-unicorn": "59.0.1",
+    "eslint-plugin-import-x": "4.11.1",
+    "globals": "16.1.0",
+    "markdownlint": "0.38.0",
+    "markdownlint-cli2": "0.18.0",
+    "prettier": "3.5.3",
+    "semantic-release": "24.2.3",
+    "typescript-eslint": "8.32.0",
+    "typescript": "5.8.3"
   }
 }

src/index.d.ts

@@ -0,0 +1,8 @@
+import type MarkdownIt from "markdown-it"
+import type { Rule } from "markdownlint"
+
+declare const relativeLinksRule: Rule
+export default relativeLinksRule
+
+declare const markdownIt: MarkdownIt
+export { markdownIt }

src/index.js

@@ -1,24 +1,29 @@
-"use strict"
+import { pathToFileURL } from "node:url"
+import fs from "node:fs"
 
-const { pathToFileURL } = require("node:url")
-const fs = require("node:fs")
-
-const { filterTokens } = require("./markdownlint-rule-helpers/helpers.js")
-const {
+import { filterTokens } from "./markdownlint-rule-helpers/helpers.js"
+import {
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
   getMarkdownIdOrAnchorNameFragments,
-} = require("./utils.js")
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
+  lineFragmentRe,
+} from "./utils.js"
+
+export { markdownIt } from "./utils.js"
 
 /** @typedef {import('markdownlint').Rule} MarkdownLintRule */
 
 /**
  * @type {MarkdownLintRule}
  */
-const customRule = {
+const relativeLinksRule = {
   names: ["relative-links"],
   description: "Relative links should be valid",
   tags: ["links"],
+  parser: "markdownit",
   function: (params, onError) => {
     filterTokens(params, "inline", (token) => {
       const children = token.children ?? []
@@ -72,7 +77,7 @@ const customRule = {
 
         if (url.hash.length <= 0) {
           if (hrefSrc.includes("#")) {
-            if (type !== "link_open") {
+            if (type === "image") {
               onError({
                 lineNumber,
                 detail: `${detail} should not have a fragment identifier as it is an image`,
@@ -89,7 +94,7 @@ const customRule = {
           continue
         }
 
-        if (type !== "link_open") {
+        if (type === "image") {
           onError({
             lineNumber,
             detail: `${detail} should not have a fragment identifier as it is an image`,
@@ -97,6 +102,10 @@ const customRule = {
           continue
         }
 
+        if (!url.pathname.endsWith(".md")) {
+          continue
+        }
+
         const fileContent = fs.readFileSync(url, { encoding: "utf8" })
         const headings = getMarkdownHeadings(fileContent)
         const idOrAnchorNameHTMLFragments =
@@ -118,6 +127,40 @@ const customRule = {
         fragmentsHTML.push(...idOrAnchorNameHTMLFragments)
 
         if (!fragmentsHTML.includes(url.hash)) {
+          if (url.hash.startsWith("#L")) {
+            const lineNumberFragmentString = getLineNumberStringFromFragment(
+              url.hash,
+            )
+
+            const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
+            if (!hasOnlyDigits) {
+              if (lineFragmentRe.test(url.hash)) {
+                continue
+              }
+
+              onError({
+                lineNumber,
+                detail: `${detail} should have a valid fragment identifier`,
+              })
+              continue
+            }
+
+            const lineNumberFragment = Number.parseInt(
+              lineNumberFragmentString,
+              10,
+            )
+            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
+            }
+
+            continue
+          }
+
           onError({
             lineNumber,
             detail: `${detail} should have a valid fragment identifier`,
@@ -129,4 +172,4 @@ const customRule = {
   },
 }
 
-module.exports = customRule
+export default relativeLinksRule

src/markdownlint-rule-helpers/helpers.js

@@ -14,8 +14,8 @@
  * @param {(token: MarkdownItToken) => void} handler Callback function.
  * @returns {void}
  */
-const filterTokens = (params, type, handler) => {
-  for (const token of params.tokens) {
+export const filterTokens = (params, type, handler) => {
+  for (const token of params.parsers.markdownit.tokens) {
     if (token.type === type) {
       handler(token)
     }
@@ -28,11 +28,6 @@ const filterTokens = (params, type, handler) => {
  * @param {string} name HTML attribute name.
  * @returns {RegExp} Regular Expression for matching.
  */
-const getHtmlAttributeRe = (name) => {
+export const getHtmlAttributeRe = (name) => {
   return new RegExp(`\\s${name}\\s*=\\s*['"]?([^'"\\s>]*)`, "iu")
 }
-
-module.exports = {
-  filterTokens,
-  getHtmlAttributeRe,
-}

src/utils.js

@@ -1,6 +1,10 @@
-const MarkdownIt = require("markdown-it")
+import MarkdownIt from "markdown-it"
 
-const { getHtmlAttributeRe } = require("./markdownlint-rule-helpers/helpers.js")
+import { getHtmlAttributeRe } from "./markdownlint-rule-helpers/helpers.js"
+
+export const markdownIt = new MarkdownIt({ html: true })
+
+export const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/
 
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
@@ -10,7 +14,7 @@ const { getHtmlAttributeRe } = require("./markdownlint-rule-helpers/helpers.js")
  * @param {string} inlineText Inline token for heading.
  * @returns {string} Fragment string for heading.
  */
-const convertHeadingToHTMLFragment = (inlineText) => {
+export const convertHeadingToHTMLFragment = (inlineText) => {
   return (
     "#" +
     encodeURIComponent(
@@ -36,8 +40,7 @@ const ignoredTokens = new Set(["heading_open", "heading_close"])
  * @param {string} content
  * @returns {string[]}
  */
-const getMarkdownHeadings = (content) => {
-  const markdownIt = new MarkdownIt({ html: true })
+export const getMarkdownHeadings = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -85,8 +88,7 @@ const idHTMLAttributeRegex = getHtmlAttributeRe("id")
  * @param {string} content
  * @returns {string[]}
  */
-const getMarkdownIdOrAnchorNameFragments = (content) => {
-  const markdownIt = new MarkdownIt({ html: true })
+export const getMarkdownIdOrAnchorNameFragments = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -114,8 +116,38 @@ const getMarkdownIdOrAnchorNameFragments = (content) => {
   return result
 }
 
-module.exports = {
-  convertHeadingToHTMLFragment,
-  getMarkdownHeadings,
-  getMarkdownIdOrAnchorNameFragments,
+/**
+ * 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
+ */
+export 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}
+ */
+export 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
+ */
+export const getLineNumberStringFromFragment = (fragment) => {
+  return fragment.slice(2)
 }

test/fixtures/invalid/invalid-heading-case-sensitive/awesome.md

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

test/fixtures/invalid/invalid-heading-case-sensitive/invalid-heading-case-sensitive.md

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

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-column-range-number-fragment/awesome.md

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

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

@@ -0,0 +1,31 @@
+# Invalid
+
+[Invalid](./awesome.md#L12-not-a-line-link)
+
+[Invalid](./awesome.md#l7)
+
+[Invalid](./awesome.md#L)
+
+[Invalid](./awesome.md#L7extra)
+
+[Invalid](./awesome.md#L30C)
+
+[Invalid](./awesome.md#L30Cextra)
+
+[Invalid](./awesome.md#L30L12)
+
+[Invalid](./awesome.md#L30C12)
+
+[Invalid](./awesome.md#L30C11-)
+
+[Invalid](./awesome.md#L30C11-L)
+
+[Invalid](./awesome.md#L30C11-L31C)
+
+[Invalid](./awesome.md#L30C11-C31)
+
+[Invalid](./awesome.md#C30)
+
+[Invalid](./awesome.md#C11-C31)
+
+[Invalid](./awesome.md#C11-L4C31)

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/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/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-column-range-number-fragment/awesome.md

@@ -0,0 +1,3 @@
+# Awesome
+
+## L12 Not A Line Link

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

@@ -0,0 +1,11 @@
+# Valid
+
+[Valid](./awesome.md#l12-not-a-line-link)
+
+[Valid](./awesome.md#L30-L31)
+
+[Valid](./awesome.md#L3C24-L88)
+
+[Valid](./awesome.md#L304-L314C98)
+
+[Valid](./awesome.md#L200C4-L3244C2)

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

@@ -1,9 +1,9 @@
-const { test } = require("node:test")
-const assert = require("node:assert/strict")
+import { test } from "node:test"
+import assert from "node:assert/strict"
 
-const { markdownlint } = require("markdownlint").promises
+import * as markdownlint from "markdownlint/promise"
 
-const relativeLinksRule = require("../src/index.js")
+import relativeLinksRule, { markdownIt } from "../src/index.js"
 
 /**
  *
@@ -11,13 +11,16 @@ const relativeLinksRule = require("../src/index.js")
  * @returns
  */
 const validateMarkdownLint = async (fixtureFile) => {
-  const lintResults = await markdownlint({
+  const lintResults = await markdownlint.lint({
     files: [fixtureFile],
     config: {
       default: false,
       "relative-links": true,
     },
     customRules: [relativeLinksRule],
+    markdownItFactory: () => {
+      return markdownIt
+    },
   })
   return lintResults[fixtureFile]
 }
@@ -26,82 +29,141 @@ test("ensure the rule validates correctly", async (t) => {
   await t.test("should be invalid", async (t) => {
     const testCases = [
       {
-        name: "with an empty id fragment",
+        name: "should be invalid with an empty id fragment",
         fixturePath:
           "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
-        error: '"./awesome.md#" should have a valid fragment identifier',
+        errors: ['"./awesome.md#" should have a valid fragment identifier'],
       },
       {
-        name: "with a name fragment other than for an anchor",
+        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:
+        errors: [
           '"./awesome.md#name-should-be-ignored" should have a valid fragment identifier',
+        ],
       },
       {
-        name: "with a non-existing id fragment (data-id !== id)",
+        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:
+        errors: [
           '"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier',
+        ],
       },
       {
-        name: "with a non-existing anchor name fragment",
+        name: "should be invalid with uppercase letters in fragment (case sensitive)",
+        fixturePath:
+          "test/fixtures/invalid/invalid-heading-case-sensitive/invalid-heading-case-sensitive.md",
+        errors: [
+          '"./awesome.md#ExistIng-Heading" 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",
+        errors: [
+          '"./awesome.md#L7abc" should have a valid fragment identifier',
+        ],
+      },
+      {
+        name: "should be invalid with a invalid line column range number fragment",
+        fixturePath:
+          "test/fixtures/invalid/invalid-line-column-range-number-fragment/invalid-line-column-range-number-fragment.md",
+        errors: [
+          '"./awesome.md#L12-not-a-line-link" should have a valid fragment identifier',
+          '"./awesome.md#l7" should have a valid fragment identifier',
+          '"./awesome.md#L" should have a valid fragment identifier',
+          '"./awesome.md#L7extra" should have a valid fragment identifier',
+          '"./awesome.md#L30C" should have a valid fragment identifier',
+          '"./awesome.md#L30Cextra" should have a valid fragment identifier',
+          '"./awesome.md#L30L12" should have a valid fragment identifier',
+          '"./awesome.md#L30C12" should have a valid fragment identifier',
+          '"./awesome.md#L30C11-" should have a valid fragment identifier',
+          '"./awesome.md#L30C11-L" should have a valid fragment identifier',
+          '"./awesome.md#L30C11-L31C" should have a valid fragment identifier',
+          '"./awesome.md#L30C11-C31" should have a valid fragment identifier',
+          '"./awesome.md#C30" should have a valid fragment identifier',
+          '"./awesome.md#C11-C31" should have a valid fragment identifier',
+          '"./awesome.md#C11-L4C31" 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",
+        errors: [
+          '"./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:
+        errors: [
           '"./awesome.md#non-existing-anchor-name-fragment" should have a valid fragment identifier',
+        ],
       },
       {
-        name: "with a non-existing element id fragment",
+        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:
+        errors: [
           '"./awesome.md#non-existing-element-id-fragment" should have a valid fragment identifier',
+        ],
       },
       {
-        name: "with a non-existing heading fragment",
+        name: "should be invalid with a non-existing heading fragment",
         fixturePath:
           "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
-        error:
+        errors: [
           '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
+        ],
       },
       {
-        name: "with a link to an image with a empty fragment",
+        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:
+        errors: [
           '"../image.png#" should not have a fragment identifier as it is an image',
+        ],
       },
       {
-        name: "with a link to an image with a fragment",
+        name: "should be invalid with a link to an image with a fragment",
         fixturePath:
           "test/fixtures/invalid/ignore-fragment-checking-for-image.md",
-        error:
+        errors: [
           '"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image',
+        ],
       },
       {
-        name: "with a non-existing file",
+        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',
+        errors: ['"./index.test.js" should exist in the file system'],
       },
       {
-        name: "with a non-existing image",
+        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',
+        errors: ['"./image.png" should exist in the file system'],
       },
     ]
 
-    for (const { name, fixturePath, error } of testCases) {
+    for (const { name, fixturePath, errors } of testCases) {
       await t.test(name, async () => {
-        const lintResults = await validateMarkdownLint(fixturePath)
-        assert.equal(lintResults?.length, 1)
-        assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
-        assert.equal(
-          lintResults?.[0]?.ruleDescription,
-          relativeLinksRule.description,
+        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
+        const errorsDetails = lintResults.map((result) => {
+          assert.deepEqual(result.ruleNames, relativeLinksRule.names)
+          assert.deepEqual(
+            result.ruleDescription,
+            relativeLinksRule.description,
+          )
+          return result.errorDetail
+        })
+        assert.deepStrictEqual(
+          errorsDetails,
+          errors,
+          `${fixturePath}: Expected errors`,
         )
-        assert.equal(lintResults?.[0]?.errorDetail, error)
       })
     }
   })
@@ -109,26 +171,51 @@ test("ensure the rule validates correctly", async (t) => {
   await t.test("should be valid", async (t) => {
     const testCases = [
       {
-        name: "with an existing anchor name fragment",
+        name: "should be valid with an existing anchor name fragment",
         fixturePath:
           "test/fixtures/valid/existing-anchor-name-fragment/existing-anchor-name-fragment.md",
       },
       {
-        name: "with an existing element id fragment",
+        name: "should be valid with an existing element id fragment",
         fixturePath:
           "test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md",
       },
       {
-        name: "with an existing heading fragment",
+        name: "should be valid with an existing heading fragment",
         fixturePath:
           "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
       },
       {
-        name: "with an existing file",
+        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 support lines and columns range numbers in link fragments",
+        fixturePath:
+          "test/fixtures/valid/valid-line-column-range-number-fragment/valid-line-column-range-number-fragment.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: "with an existing image",
+        name: "should be valid with an existing image",
         fixturePath: "test/fixtures/valid/existing-image.md",
       },
       {
@@ -148,8 +235,15 @@ test("ensure the rule validates correctly", async (t) => {
 
     for (const { name, fixturePath } of testCases) {
       await t.test(name, async () => {
-        const lintResults = await validateMarkdownLint(fixturePath)
-        assert.equal(lintResults?.length, 0)
+        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
+        const errorsDetails = lintResults.map((result) => {
+          return result.errorDetail
+        })
+        assert.equal(
+          errorsDetails.length,
+          0,
+          `${fixturePath}: Expected no errors, got ${errorsDetails.join(", ")}`,
+        )
       })
     }
   })

test/utils.test.js

@@ -1,11 +1,14 @@
-const { test } = require("node:test")
-const assert = require("node:assert/strict")
+import { test } from "node:test"
+import assert from "node:assert/strict"
 
-const {
+import {
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
   getMarkdownIdOrAnchorNameFragments,
-} = require("../src/utils.js")
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
+} from "../src/utils.js"
 
 test("utils", async (t) => {
   await t.test("convertHeadingToHTMLFragment", async () => {
@@ -54,4 +57,23 @@ test("utils", async (t) => {
     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")
+  })
 })

tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "lib": ["ESNext"],
     "target": "ESNext",
-    "module": "CommonJS",
-    "moduleResolution": "Node",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "checkJs": true,
     "allowJs": true,
     "noEmit": true,