.github/workflows/lint.yml

@@ -10,10 +10,10 @@ jobs:
   lint:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.2.2"
+      - uses: "actions/checkout@v4.1.7"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.1.0"
+        uses: "actions/setup-node@v4.0.3"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -30,6 +30,6 @@ jobs:
   commitlint:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.2.2"
+      - uses: "actions/checkout@v4.1.7"
 
-      - uses: "wagoid/commitlint-github-action@v6.2.0"
+      - uses: "wagoid/commitlint-github-action@v6.1.2"

.github/workflows/release.yml

@@ -13,13 +13,13 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.2.2"
+      - uses: "actions/checkout@v4.1.7"
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.1.0"
+        uses: "actions/setup-node@v4.0.3"
         with:
           node-version: "lts/*"
           cache: "npm"

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
   test:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.2.2"
+      - uses: "actions/checkout@v4.1.7"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.1.0"
+        uses: "actions/setup-node@v4.0.3"
         with:
           node-version: "lts/*"
           cache: "npm"

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "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

@@ -1,15 +0,0 @@
-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

README.md

@@ -66,7 +66,7 @@ Contributions are welcome to improve the rule, and to alleviate these limitation
 
 ## Prerequisites
 
-[Node.js](https://nodejs.org/) >= 22.0.0
+[Node.js](https://nodejs.org/) >= 16.0.0
 
 ## Installation
 
@@ -80,22 +80,18 @@ 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.mjs`
+`.markdownlint-cli2.jsonc`
 
-```js
+```json
-import relativeLinksRule from "markdownlint-rule-relative-links"
+{
-
+  "config": {
-const config = {
+    "default": true,
-  config: {
+    "relative-links": true
-    default: true,
-    "relative-links": true,
   },
-  globs: ["**/*.md"],
+  "globs": ["**/*.md"],
-  ignores: ["**/node_modules"],
+  "ignores": ["**/node_modules"],
-  customRules: [relativeLinksRule],
+  "customRules": ["markdownlint-rule-relative-links"]
 }
-
-export default config
 ```
 
 `package.json`

package.json

@@ -18,8 +18,6 @@
     "markdownlint-rule"
   ],
   "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "type": "module",
   "files": [
     "src"
   ],
@@ -28,7 +26,7 @@
     "provenance": true
   },
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=16.0.0"
   },
   "scripts": {
     "lint:editorconfig": "editorconfig-checker",
@@ -44,19 +42,19 @@
   },
   "devDependencies": {
     "@types/markdown-it": "14.1.2",
-    "@types/node": "22.10.2",
+    "@types/node": "22.9.0",
     "editorconfig-checker": "6.0.0",
-    "eslint": "9.17.0",
+    "eslint": "9.14.0",
-    "eslint-config-conventions": "18.0.0",
+    "eslint-config-conventions": "17.0.0",
-    "eslint-plugin-promise": "7.2.1",
+    "eslint-plugin-promise": "7.1.0",
-    "eslint-plugin-unicorn": "56.0.1",
+    "eslint-plugin-unicorn": "56.0.0",
-    "eslint-plugin-import-x": "4.6.1",
+    "eslint-plugin-import-x": "4.4.0",
-    "globals": "15.14.0",
+    "globals": "15.12.0",
-    "markdownlint": "0.37.2",
+    "markdownlint": "0.36.1",
-    "markdownlint-cli2": "0.17.0",
+    "markdownlint-cli2": "0.15.0",
-    "prettier": "3.4.2",
+    "prettier": "3.3.3",
-    "semantic-release": "24.2.0",
+    "semantic-release": "23.1.1",
-    "typescript-eslint": "8.18.2",
+    "typescript-eslint": "8.13.0",
-    "typescript": "5.7.2"
+    "typescript": "5.6.3"
   }
 }

src/index.d.ts

@@ -1,5 +0,0 @@
-import type { Rule } from "markdownlint"
-
-declare const relativeLinksRule: Rule
-
-export default relativeLinksRule

src/index.js

@@ -1,8 +1,10 @@
-import { pathToFileURL } from "node:url"
+"use strict"
-import fs from "node:fs"
 
-import { filterTokens } from "./markdownlint-rule-helpers/helpers.js"
+const { pathToFileURL } = require("node:url")
-import {
+const fs = require("node:fs")
+
+const { filterTokens } = require("./markdownlint-rule-helpers/helpers.js")
+const {
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
   getMarkdownIdOrAnchorNameFragments,
@@ -10,14 +12,14 @@ import {
   getNumberOfLines,
   getLineNumberStringFromFragment,
   lineFragmentRe,
-} from "./utils.js"
+} = require("./utils.js")
 
 /** @typedef {import('markdownlint').Rule} MarkdownLintRule */
 
 /**
  * @type {MarkdownLintRule}
  */
-const relativeLinksRule = {
+const customRule = {
   names: ["relative-links"],
   description: "Relative links should be valid",
   tags: ["links"],
@@ -170,4 +172,4 @@ const relativeLinksRule = {
   },
 }
 
-export default relativeLinksRule
+module.exports = customRule

src/markdownlint-rule-helpers/helpers.js

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

src/utils.js

@@ -1,10 +1,10 @@
-import MarkdownIt from "markdown-it"
+const MarkdownIt = require("markdown-it")
 
-import { getHtmlAttributeRe } from "./markdownlint-rule-helpers/helpers.js"
+const { getHtmlAttributeRe } = require("./markdownlint-rule-helpers/helpers.js")
 
 const markdownIt = new MarkdownIt({ html: true })
 
-export const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/
+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 @@ export 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.
  */
-export const convertHeadingToHTMLFragment = (inlineText) => {
+const convertHeadingToHTMLFragment = (inlineText) => {
   return (
     "#" +
     encodeURIComponent(
@@ -40,7 +40,7 @@ const ignoredTokens = new Set(["heading_open", "heading_close"])
  * @param {string} content
  * @returns {string[]}
  */
-export const getMarkdownHeadings = (content) => {
+const getMarkdownHeadings = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -88,7 +88,7 @@ const idHTMLAttributeRegex = getHtmlAttributeRe("id")
  * @param {string} content
  * @returns {string[]}
  */
-export const getMarkdownIdOrAnchorNameFragments = (content) => {
+const getMarkdownIdOrAnchorNameFragments = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -128,7 +128,7 @@ export const getMarkdownIdOrAnchorNameFragments = (content) => {
  * @example isValidIntegerString("1abc") // false
  * @example isValidIntegerString("1.0") // false
  */
-export const isValidIntegerString = (value) => {
+const isValidIntegerString = (value) => {
   const regex = /^\d+$/
   return regex.test(value)
 }
@@ -138,7 +138,7 @@ export const isValidIntegerString = (value) => {
  * @param {string} content
  * @returns {number}
  */
-export const getNumberOfLines = (content) => {
+const getNumberOfLines = (content) => {
   return content.split("\n").length
 }
 
@@ -148,6 +148,16 @@ export const getNumberOfLines = (content) => {
  * @returns {string}
  * @example getLineNumberStringFromFragment("#L50") // 50
  */
-export const getLineNumberStringFromFragment = (fragment) => {
+const getLineNumberStringFromFragment = (fragment) => {
   return fragment.slice(2)
 }
+
+module.exports = {
+  lineFragmentRe,
+  convertHeadingToHTMLFragment,
+  getMarkdownHeadings,
+  getMarkdownIdOrAnchorNameFragments,
+  isValidIntegerString,
+  getNumberOfLines,
+  getLineNumberStringFromFragment,
+}

test/index.test.js

@@ -1,9 +1,9 @@
-import { test } from "node:test"
+const { test } = require("node:test")
-import assert from "node:assert/strict"
+const assert = require("node:assert/strict")
 
-import * as markdownlint from "markdownlint/promise"
+const { markdownlint } = require("markdownlint").promises
 
-import relativeLinksRule from "../src/index.js"
+const relativeLinksRule = require("../src/index.js")
 
 /**
  *
@@ -11,7 +11,7 @@ import relativeLinksRule from "../src/index.js"
  * @returns
  */
 const validateMarkdownLint = async (fixtureFile) => {
-  const lintResults = await markdownlint.lint({
+  const lintResults = await markdownlint({
     files: [fixtureFile],
     config: {
       default: false,

test/utils.test.js

@@ -1,14 +1,14 @@
-import { test } from "node:test"
+const { test } = require("node:test")
-import assert from "node:assert/strict"
+const assert = require("node:assert/strict")
 
-import {
+const {
   convertHeadingToHTMLFragment,
   getMarkdownHeadings,
   getMarkdownIdOrAnchorNameFragments,
   isValidIntegerString,
   getNumberOfLines,
   getLineNumberStringFromFragment,
-} from "../src/utils.js"
+} = require("../src/utils.js")
 
 test("utils", async (t) => {
   await t.test("convertHeadingToHTMLFragment", async () => {