feat: usage of ESM modules imports (instead of CommonJS)

Fixes #10

BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: minimum supported Node.js >= 22.0.0

.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.2"
+        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.2"
+        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.2"
+        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,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"
-  ]
-}

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

@@ -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
 
@@ -107,7 +107,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",
+    "lint:eslint": "eslint . --max-warnings 0",
+    "lint:prettier": "prettier . --check",
+    "lint:typescript": "tsc --noEmit",
     "test": "node --test",
-    "release": "semantic-release",
-    "postinstall": "husky",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "release": "semantic-release"
   },
   "dependencies": {
     "markdown-it": "14.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": "22.10.2",
+    "editorconfig-checker": "6.0.0",
+    "eslint": "9.17.0",
+    "eslint-config-conventions": "18.0.0",
+    "eslint-plugin-promise": "7.2.1",
+    "eslint-plugin-unicorn": "56.0.1",
+    "eslint-plugin-import-x": "4.6.1",
+    "globals": "15.14.0",
+    "markdownlint": "0.37.2",
+    "markdownlint-cli2": "0.17.0",
+    "prettier": "3.4.2",
+    "semantic-release": "24.2.0",
+    "typescript-eslint": "8.18.2",
+    "typescript": "5.7.2"
   }
 }

src/index.d.ts

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

src/index.js

@@ -1,10 +1,8 @@
-"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,
@@ -12,14 +10,14 @@ const {
   getNumberOfLines,
   getLineNumberStringFromFragment,
   lineFragmentRe,
-} = require("./utils.js")
+} 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"],
@@ -172,4 +170,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 })
 
-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(
@@ -40,7 +40,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 +88,7 @@ const idHTMLAttributeRegex = getHtmlAttributeRe("id")
  * @param {string} content
  * @returns {string[]}
  */
-const getMarkdownIdOrAnchorNameFragments = (content) => {
+export const getMarkdownIdOrAnchorNameFragments = (content) => {
   const tokens = markdownIt.parse(content, {})
 
   /** @type {string[]} */
@@ -128,7 +128,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 +138,7 @@ const isValidIntegerString = (value) => {
  * @param {string} content
  * @returns {number}
  */
-const getNumberOfLines = (content) => {
+export const getNumberOfLines = (content) => {
   return content.split("\n").length
 }
 
@@ -148,16 +148,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/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 from "../src/index.js"
 
 /**
  *
@@ -11,7 +11,7 @@ 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,

test/utils.test.js

@@ -1,14 +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,
   isValidIntegerString,
   getNumberOfLines,
   getLineNumberStringFromFragment,
-} = require("../src/utils.js")
+} from "../src/utils.js"
 
 test("utils", async (t) => {
   await t.test("convertHeadingToHTMLFragment", async () => {

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,