feat!: stricter validation of image links (check if the file is an image)

BREAKING CHANGE: links like ![Image](./not-an-image.txt) will now report
an error

.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/ISSUE_TEMPLATE/QUESTION.md

@@ -5,4 +5,4 @@ title: "[Question]"
 labels: "question"
 ---
 
-### Question
+## Question

.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@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.2"
+        uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -21,9 +21,7 @@ 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:markdown"
+      - run: "node --run lint:typescript"
+      - run: "node --run lint:oxlint"
+      - run: "node --run lint:oxfmt"

.github/workflows/release.yml

@@ -2,7 +2,11 @@ name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main]
+
+permissions:
+  id-token: "write" # OIDC
+  contents: "read"
 
 jobs:
   release:
@@ -13,13 +17,13 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.2"
+        uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -31,7 +35,6 @@ 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,23 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   test:
-    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on:
+          - "ubuntu-latest"
+          - "windows-latest"
+          - "macos-latest"
+    runs-on: "${{ matrix.runs-on }}"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.2"
+        uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -22,4 +29,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,3 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:staged
-npm run lint:javascript
-npm run test

.lintstagedrc.json

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

.markdownlint-cli2.jsonc

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

.markdownlint-cli2.mjs

@@ -0,0 +1,17 @@
+import relativeLinksRule from "./src/index.js"
+
+const config = {
+  config: {
+    extends: "markdownlint/style/prettier",
+    default: true,
+    "relative-links": {
+      root_path: ".",
+    },
+    "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

.oxfmtrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "semi": false
+}

.oxlintrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["node_modules/eslint-config-conventions/.oxlintrc.json"]
+}

.prettierrc.json

@@ -1,3 +0,0 @@
-{
-  "semi": false
-}

.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/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"
-  }
-}

README.md

@@ -51,12 +51,13 @@ awesome.md:3 relative-links Relative links should be valid ["./invalid.txt" shou
 - Support images (e.g: `![Image](./image.png)`).
 - 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`).
+- If necessary, absolute paths can be validated too, with [`root_path` configuration option](#absolute-paths).
 
 ### Limitations
 
 - 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" />`).
 
-Contributions are welcome to improve the rule, and to alleviate these limitations. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
+Contributions are welcome to improve the rule, and to alleviate these limitations. See [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
 
 ### Related links
 
@@ -66,7 +67,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 +81,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"],
-  "ignores": ["**/node_modules"],
-  "customRules": ["markdownlint-rule-relative-links"]
+  globs: ["**/*.md"],
+  ignores: ["**/node_modules"],
+  customRules: [relativeLinksRule],
 }
+
+export default config
 ```
 
 `package.json`
@@ -104,18 +109,37 @@ We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markd
 }
 ```
 
+### Absolute paths
+
+GitHub (and, likely, other similar platforms) resolves absolute paths in Markdown links relative to the repository root.
+
+To validate such links, add `root_path` option to the configuration:
+
+```js
+  config: {
+    default: true,
+    "relative-links": {
+      root_path: ".",
+    },
+  },
+```
+
+After this change, all absolute paths will be converted to relative paths, and will be resolved relative to the specified directory.
+
+For example, if you run markdownlint from a subdirectory (if `package.json` is located in a subdirectory), you should set `root_path` to `".."`.
+
 ## Usage
 
 ```sh
-npm run lint:markdown
+node --run lint:markdown
 ```
 
 ## 💡 Contributing
 
 Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
 
-The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+The steps to contribute can be found in the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
 
 ## 📄 License
 
-[MIT](./LICENSE)
+[MIT](/LICENSE)

package.json

@@ -1,71 +1,58 @@
 {
   "name": "markdownlint-rule-relative-links",
   "version": "0.0.0-development",
-  "public": true,
   "description": "Custom rule for markdownlint to validate relative links.",
-  "author": "Théo LUDWIG <contact@theoludwig.fr>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/theoludwig/markdownlint-rule-relative-links.git"
-  },
-  "bugs": {
-    "url": "https://github.com/theoludwig/markdownlint-rule-relative-links/issues"
-  },
-  "homepage": "https://github.com/theoludwig/markdownlint-rule-relative-links#readme",
   "keywords": [
     "markdownlint",
     "markdownlint-rule"
   ],
-  "main": "src/index.js",
+  "homepage": "https://github.com/theoludwig/markdownlint-rule-relative-links#readme",
+  "bugs": {
+    "url": "https://github.com/theoludwig/markdownlint-rule-relative-links/issues"
+  },
+  "license": "MIT",
+  "author": "Théo LUDWIG <contact@theoludwig.fr>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/theoludwig/markdownlint-rule-relative-links.git"
+  },
   "files": [
     "src"
   ],
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=9.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",
+    "lint:typescript": "tsc --noEmit",
+    "lint:oxlint": "oxlint . --deny-warnings --report-unused-disable-directives",
+    "lint:oxfmt": "oxfmt . --check",
+    "oxfmt": "oxfmt .",
     "test": "node --test",
-    "release": "semantic-release",
-    "postinstall": "husky",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "release": "semantic-release"
   },
   "dependencies": {
-    "markdown-it": "14.1.0"
+    "markdown-it": "14.1.0",
+    "mime": "4.1.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "19.2.2",
-    "@commitlint/config-conventional": "19.2.2",
-    "@types/markdown-it": "14.1.1",
-    "@types/node": "20.12.12",
-    "editorconfig-checker": "5.1.5",
-    "eslint": "8.57.0",
-    "eslint-config-conventions": "14.2.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-promise": "6.2.0",
-    "eslint-plugin-unicorn": "53.0.0",
-    "husky": "9.0.11",
-    "lint-staged": "15.2.5",
-    "markdownlint": "0.34.0",
-    "markdownlint-cli2": "0.13.0",
-    "pinst": "3.0.0",
-    "prettier": "3.2.5",
-    "semantic-release": "23.1.1",
-    "typescript": "5.4.5"
-  }
+    "@types/markdown-it": "14.1.2",
+    "@types/node": "25.2.1",
+    "eslint-config-conventions": "21.2.0",
+    "markdownlint": "0.40.0",
+    "markdownlint-cli2": "0.20.0",
+    "oxfmt": "0.28.0",
+    "oxlint": "1.43.0",
+    "oxlint-tsgolint": "0.11.4",
+    "semantic-release": "25.0.3",
+    "typescript": "5.9.3"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "public": true
 }

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,10 +1,9 @@
-"use strict"
+import { fileURLToPath, pathToFileURL } from "node:url"
+import fs from "node:fs"
+import mime from "mime"
 
-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,
@@ -12,14 +11,16 @@ const {
   getNumberOfLines,
   getLineNumberStringFromFragment,
   lineFragmentRe,
-} = require("./utils.js")
+} 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"],
@@ -51,17 +52,25 @@ const customRule = {
           }
         }
 
-        if (hrefSrc == null) {
+        if (hrefSrc == null || hrefSrc.startsWith("#")) {
           continue
         }
 
-        const url = new URL(hrefSrc, pathToFileURL(params.name))
-        const isRelative =
-          url.protocol === "file:" &&
-          !hrefSrc.startsWith("/") &&
-          !hrefSrc.startsWith("#")
+        let url
 
-        if (!isRelative) {
+        if (hrefSrc.startsWith("/")) {
+          const rootPath = params.config["root_path"]
+
+          if (!rootPath) {
+            continue
+          }
+
+          url = new URL(`.${hrefSrc}`, pathToFileURL(`${rootPath}/`))
+        } else {
+          url = new URL(hrefSrc, pathToFileURL(params.name))
+        }
+
+        if (url.protocol !== "file:" && type !== "image") {
           continue
         }
 
@@ -75,6 +84,15 @@ const customRule = {
           continue
         }
 
+        const mimeType = mime.getType(fileURLToPath(url))
+        if (type === "image" && (mimeType == null || !mimeType.startsWith("image/"))) {
+          onError({
+            lineNumber,
+            detail: `${detail} should be an image`,
+          })
+          continue
+        }
+
         if (url.hash.length <= 0) {
           if (hrefSrc.includes("#")) {
             if (type === "image") {
@@ -108,8 +126,7 @@ const customRule = {
 
         const fileContent = fs.readFileSync(url, { encoding: "utf8" })
         const headings = getMarkdownHeadings(fileContent)
-        const idOrAnchorNameHTMLFragments =
-          getMarkdownIdOrAnchorNameFragments(fileContent)
+        const idOrAnchorNameHTMLFragments = getMarkdownIdOrAnchorNameFragments(fileContent)
 
         /** @type {Map<string, number>} */
         const fragments = new Map()
@@ -128,9 +145,7 @@ const customRule = {
 
         if (!fragmentsHTML.includes(url.hash)) {
           if (url.hash.startsWith("#L")) {
-            const lineNumberFragmentString = getLineNumberStringFromFragment(
-              url.hash,
-            )
+            const lineNumberFragmentString = getLineNumberStringFromFragment(url.hash)
 
             const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
             if (!hasOnlyDigits) {
@@ -145,10 +160,7 @@ const customRule = {
               continue
             }
 
-            const lineNumberFragment = Number.parseInt(
-              lineNumberFragmentString,
-              10,
-            )
+            const lineNumberFragment = Number.parseInt(lineNumberFragmentString, 10)
             const numberOfLines = getNumberOfLines(fileContent)
             if (lineNumberFragment > numberOfLines) {
               onError({
@@ -172,4 +184,4 @@ const customRule = {
   },
 }
 
-module.exports = customRule
+export default relativeLinksRule

src/markdownlint-rule-helpers/helpers.js

@@ -14,7 +14,7 @@
  * @param {(token: MarkdownItToken) => void} handler Callback function.
  * @returns {void}
  */
-const filterTokens = (params, type, handler) => {
+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,10 +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"
 
-const markdownIt = new MarkdownIt({ html: true })
+export const markdownIt = new MarkdownIt({ html: true })
 
-const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/
+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
@@ -14,7 +14,7 @@ const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/
  * @param {string} inlineText Inline token for heading.
  * @returns {string} Fragment string for heading.
  */
-const convertHeadingToHTMLFragment = (inlineText) => {
+export const convertHeadingToHTMLFragment = (inlineText) => {
   return (
     "#" +
     encodeURIComponent(
@@ -23,10 +23,7 @@ const convertHeadingToHTMLFragment = (inlineText) => {
         // RegExp source with Ruby's \p{Word} expanded into its General Categories
         // https://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb
         // https://ruby-doc.org/core-3.0.2/Regexp.html
-        .replace(
-          /[^\p{Letter}\p{Mark}\p{Number}\p{Connector_Punctuation}\- ]/gu,
-          "",
-        )
+        .replace(/[^\p{Letter}\p{Mark}\p{Number}\p{Connector_Punctuation}\- ]/gu, "")
         .replace(/ /gu, "-"),
     )
   )
@@ -40,7 +37,7 @@ const ignoredTokens = new Set(["heading_open", "heading_close"])
  * @param {string} content
  * @returns {string[]}
  */
-const getMarkdownHeadings = (content) => {
+export const getMarkdownHeadings = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -88,7 +85,7 @@ const idHTMLAttributeRegex = getHtmlAttributeRe("id")
  * @param {string} content
  * @returns {string[]}
  */
-const getMarkdownIdOrAnchorNameFragments = (content) => {
+export const getMarkdownIdOrAnchorNameFragments = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -96,8 +93,7 @@ const getMarkdownIdOrAnchorNameFragments = (content) => {
 
   for (const token of tokens) {
     const regexMatch =
-      idHTMLAttributeRegex.exec(token.content) ||
-      nameHTMLAttributeRegex.exec(token.content)
+      idHTMLAttributeRegex.exec(token.content) || nameHTMLAttributeRegex.exec(token.content)
     if (regexMatch == null) {
       continue
     }
@@ -128,7 +124,7 @@ const getMarkdownIdOrAnchorNameFragments = (content) => {
  * @example isValidIntegerString("1abc") // false
  * @example isValidIntegerString("1.0") // false
  */
-const isValidIntegerString = (value) => {
+export const isValidIntegerString = (value) => {
   const regex = /^\d+$/
   return regex.test(value)
 }
@@ -138,7 +134,7 @@ const isValidIntegerString = (value) => {
  * @param {string} content
  * @returns {number}
  */
-const getNumberOfLines = (content) => {
+export const getNumberOfLines = (content) => {
   return content.split("\n").length
 }
 
@@ -148,16 +144,6 @@ const getNumberOfLines = (content) => {
  * @returns {string}
  * @example getLineNumberStringFromFragment("#L50") // 50
  */
-const getLineNumberStringFromFragment = (fragment) => {
+export const getLineNumberStringFromFragment = (fragment) => {
   return fragment.slice(2)
 }
-
-module.exports = {
-  lineFragmentRe,
-  convertHeadingToHTMLFragment,
-  getMarkdownHeadings,
-  getMarkdownIdOrAnchorNameFragments,
-  isValidIntegerString,
-  getNumberOfLines,
-  getLineNumberStringFromFragment,
-}

test/fixtures/config-dependent/absolute-paths.md

@@ -0,0 +1,3 @@
+# Valid
+
+![Absolute Path](/test/fixtures/image.png)

test/fixtures/invalid/invalid-image.md

@@ -0,0 +1,5 @@
+# Invalid
+
+![Image](../not-an-image.txt)
+
+![Image 2](mailto:not-an-image@pictures.com)

test/fixtures/not-an-image.txt

@@ -0,0 +1 @@
+not an image

test/index.test.js

@@ -1,23 +1,31 @@
-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"
+
+const defaultConfig = {
+  "relative-links": true,
+}
 
 /**
  *
  * @param {string} fixtureFile
+ * @param {Object} config
  * @returns
  */
-const validateMarkdownLint = async (fixtureFile) => {
-  const lintResults = await markdownlint({
+const validateMarkdownLint = async (fixtureFile, config = defaultConfig) => {
+  const lintResults = await markdownlint.lint({
     files: [fixtureFile],
     config: {
       default: false,
-      "relative-links": true,
+      ...config,
     },
     customRules: [relativeLinksRule],
+    markdownItFactory: () => {
+      return markdownIt
+    },
   })
   return lintResults[fixtureFile]
 }
@@ -27,22 +35,18 @@ test("ensure the rule validates correctly", async (t) => {
     const testCases = [
       {
         name: "should be invalid with an empty id fragment",
-        fixturePath:
-          "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
+        fixturePath: "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
         errors: ['"./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",
-        errors: [
-          '"./awesome.md#name-should-be-ignored" should have a valid fragment identifier',
-        ],
+        errors: ['"./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",
+        fixturePath: "test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md",
         errors: [
           '"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier',
         ],
@@ -51,17 +55,13 @@ test("ensure the rule validates correctly", async (t) => {
         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',
-        ],
+        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',
-        ],
+        errors: ['"./awesome.md#L7abc" should have a valid fragment identifier'],
       },
       {
         name: "should be invalid with a invalid line column range number fragment",
@@ -113,22 +113,16 @@ test("ensure the rule validates correctly", async (t) => {
         name: "should be invalid with a non-existing heading fragment",
         fixturePath:
           "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
-        errors: [
-          '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
-        ],
+        errors: ['"./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",
-        errors: [
-          '"../image.png#" should not have a fragment identifier as it is an image',
-        ],
+        fixturePath: "test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md",
+        errors: ['"../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",
+        fixturePath: "test/fixtures/invalid/ignore-fragment-checking-for-image.md",
         errors: [
           '"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image',
         ],
@@ -143,24 +137,35 @@ test("ensure the rule validates correctly", async (t) => {
         fixturePath: "test/fixtures/invalid/non-existing-image.md",
         errors: ['"./image.png" should exist in the file system'],
       },
+      {
+        name: "should be invalid with incorrect absolute paths",
+        fixturePath: "test/fixtures/config-dependent/absolute-paths.md",
+        errors: ['"/test/fixtures/image.png" should exist in the file system'],
+        config: {
+          "relative-links": {
+            root_path: "test",
+          },
+        },
+      },
+      {
+        name: "should be invalid with file with an image link that is not an image",
+        fixturePath: "test/fixtures/invalid/invalid-image.md",
+        errors: [
+          '"../not-an-image.txt" should be an image',
+          '"mailto:not-an-image@pictures.com" should exist in the file system',
+        ],
+      },
     ]
 
-    for (const { name, fixturePath, errors } of testCases) {
+    for (const { name, fixturePath, errors, config = defaultConfig } of testCases) {
       await t.test(name, async () => {
-        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
+        const lintResults = (await validateMarkdownLint(fixturePath, config)) ?? []
         const errorsDetails = lintResults.map((result) => {
           assert.deepEqual(result.ruleNames, relativeLinksRule.names)
-          assert.deepEqual(
-            result.ruleDescription,
-            relativeLinksRule.description,
-          )
+          assert.deepEqual(result.ruleDescription, relativeLinksRule.description)
           return result.errorDetail
         })
-        assert.deepStrictEqual(
-          errorsDetails,
-          errors,
-          `${fixturePath}: Expected errors`,
-        )
+        assert.deepStrictEqual(errorsDetails, errors, `${fixturePath}: Expected errors`)
       })
     }
   })
@@ -179,8 +184,7 @@ test("ensure the rule validates correctly", async (t) => {
       },
       {
         name: "should be valid with an existing heading fragment",
-        fixturePath:
-          "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
+        fixturePath: "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
       },
       {
         name: 'should be valid with an existing heading fragment with accents (e.g: "é")',
@@ -204,8 +208,7 @@ test("ensure the rule validates correctly", async (t) => {
       },
       {
         name: "should be valid with valid line number fragment",
-        fixturePath:
-          "test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md",
+        fixturePath: "test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md",
       },
       {
         name: "should be valid with an existing file",
@@ -216,7 +219,7 @@ test("ensure the rule validates correctly", async (t) => {
         fixturePath: "test/fixtures/valid/existing-image.md",
       },
       {
-        name: "should ignore absolute paths",
+        name: "should ignore absolute paths if root_path is not set",
         fixturePath: "test/fixtures/valid/ignore-absolute-paths.md",
       },
       {
@@ -225,14 +228,22 @@ test("ensure the rule validates correctly", async (t) => {
       },
       {
         name: "should ignore checking fragment in own file",
-        fixturePath:
-          "test/fixtures/valid/ignore-fragment-checking-in-own-file.md",
+        fixturePath: "test/fixtures/valid/ignore-fragment-checking-in-own-file.md",
+      },
+      {
+        name: "should be valid with correct absolute paths if root_path is set",
+        fixturePath: "test/fixtures/config-dependent/absolute-paths.md",
+        config: {
+          "relative-links": {
+            root_path: ".",
+          },
+        },
       },
     ]
 
-    for (const { name, fixturePath } of testCases) {
+    for (const { name, fixturePath, config = defaultConfig } of testCases) {
       await t.test(name, async () => {
-        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
+        const lintResults = (await validateMarkdownLint(fixturePath, config)) ?? []
         const errorsDetails = lintResults.map((result) => {
           return result.errorDetail
         })

test/utils.test.js

@@ -1,29 +1,24 @@
-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,
   isValidIntegerString,
   getNumberOfLines,
   getLineNumberStringFromFragment,
-} = require("../src/utils.js")
+} from "../src/utils.js"
 
 test("utils", async (t) => {
   await t.test("convertHeadingToHTMLFragment", async () => {
-    assert.strictEqual(
-      convertHeadingToHTMLFragment("Valid Fragments"),
-      "#valid-fragments",
-    )
+    assert.strictEqual(convertHeadingToHTMLFragment("Valid Fragments"), "#valid-fragments")
     assert.strictEqual(
       convertHeadingToHTMLFragment("Valid Heading With Underscores _"),
       "#valid-heading-with-underscores-_",
     )
     assert.strictEqual(
-      convertHeadingToHTMLFragment(
-        `Valid Heading With Quotes ' And Double Quotes "`,
-      ),
+      convertHeadingToHTMLFragment(`Valid Heading With Quotes ' And Double Quotes "`),
       "#valid-heading-with-quotes--and-double-quotes-",
     )
     assert.strictEqual(
@@ -33,27 +28,22 @@ test("utils", async (t) => {
   })
 
   await t.test("getMarkdownHeadings", async () => {
-    assert.deepStrictEqual(
-      getMarkdownHeadings("# Hello\n\n## World\n\n## Hello, world!\n"),
-      ["Hello", "World", "Hello, world!"],
-    )
+    assert.deepStrictEqual(getMarkdownHeadings("# Hello\n\n## World\n\n## Hello, world!\n"), [
+      "Hello",
+      "World",
+      "Hello, world!",
+    ])
   })
 
   await t.test("getMarkdownIdOrAnchorNameFragments", async () => {
     assert.deepStrictEqual(
-      getMarkdownIdOrAnchorNameFragments(
-        '<a name="anchorName" id="anchorId">Link</a>',
-      ),
+      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 name="anchorName">Link</a>'), [
+      "#anchorName",
+    ])
+    assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>Link</a>"), [])
     assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>"), [])
     assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a id=>"), [])
   })

tsconfig.json

@@ -2,13 +2,12 @@
   "compilerOptions": {
     "lib": ["ESNext"],
     "target": "ESNext",
-    "module": "CommonJS",
-    "moduleResolution": "Node",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "checkJs": true,
     "allowJs": true,
     "noEmit": true,
     "rootDir": ".",
-    "baseUrl": ".",
     "skipLibCheck": true,
     "strict": true,
     "allowUnusedLabels": false,