Compare commits

...

11 Commits

Author SHA1 Message Date
9bb5ffe0ae
docs: markdownItFactory is not necessary
Ref: https://github.com/theoludwig/markdownlint-rule-relative-links/issues/13
2025-05-20 21:35:43 +02:00
876384344c
feat: add support for markdownlint v0.38.0 2025-05-11 16:45:14 +02:00
70bdb7013e
style: fix prettier 2024-12-28 23:15:32 +01:00
db57d67b0b
fix: use .markdownlint-cli2.mjs for the configuration file 2024-12-28 23:13:48 +01:00
aa24db4fac
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
2024-12-28 22:52:51 +01:00
b4a04d2e8e
chore: remove not needed npm engine requirement 2024-11-11 20:34:22 +01:00
54e45d3e5d
build(deps): update latest 2024-11-11 13:24:45 +01:00
dd70d6da3a
chore: remove usage of git hooks (husky, lint-staged, commitlint) + usage of node --run 2024-09-07 00:03:10 +02:00
85f465306f
feat: stricter validation of heading fragments by being Case sensitive
Fixes #8

BREAKING CHANGE: Heading fragments is now Case sensitive.
For example "#ExistIng-Heading" is invalid as it should be "#existing-heading".
2024-05-27 22:50:43 +02:00
450cdb84f0
feat: support columns numbers (and line range) in links fragments
Fixes #7
2024-05-27 22:26:21 +02:00
2df95e97d8
build(deps): update latest 2024-05-27 21:26:05 +02:00
33 changed files with 5030 additions and 4988 deletions

View File

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

View File

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

View File

@ -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"

View File

@ -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 }}

View File

@ -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"

4
.gitignore vendored
View File

@ -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

View File

@ -1,3 +0,0 @@
#!/usr/bin/env sh
npm run lint:commit -- --edit

View File

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

View File

@ -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"
]
}

View File

@ -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"],
}

15
.markdownlint-cli2.mjs Normal file
View File

@ -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

4
.npmrc
View File

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

View File

@ -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"
]

View File

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

View File

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

View File

@ -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"],
"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

13
eslint.config.js Normal file
View File

@ -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,
},
},
})

9538
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -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.1.0",
"@commitlint/config-conventional": "19.1.0",
"@types/markdown-it": "14.0.0",
"@types/node": "20.12.5",
"editorconfig-checker": "5.1.5",
"eslint": "8.56.0",
"eslint-config-conventions": "14.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": "51.0.1",
"husky": "9.0.11",
"lint-staged": "15.2.2",
"markdownlint": "0.34.0",
"markdownlint-cli2": "0.13.0",
"pinst": "3.0.0",
"prettier": "3.2.5",
"semantic-release": "23.0.7",
"typescript": "5.4.4"
"@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"
}
}

8
src/index.d.ts vendored Normal file
View File

@ -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 }

View File

@ -1,24 +1,25 @@
"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,
isValidIntegerString,
getNumberOfLines,
getLineNumberStringFromFragment,
} = require("./utils.js")
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"],
@ -125,7 +126,7 @@ const customRule = {
fragmentsHTML.push(...idOrAnchorNameHTMLFragments)
if (!fragmentsHTML.includes(url.hash.toLowerCase())) {
if (!fragmentsHTML.includes(url.hash)) {
if (url.hash.startsWith("#L")) {
const lineNumberFragmentString = getLineNumberStringFromFragment(
url.hash,
@ -133,6 +134,10 @@ const customRule = {
const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
if (!hasOnlyDigits) {
if (lineFragmentRe.test(url.hash)) {
continue
}
onError({
lineNumber,
detail: `${detail} should have a valid fragment identifier`,
@ -152,6 +157,8 @@ const customRule = {
})
continue
}
continue
}
onError({
@ -165,4 +172,4 @@ const customRule = {
},
}
module.exports = customRule
export default relativeLinksRule

View File

@ -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,
}

View File

@ -1,8 +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 })
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
@ -12,7 +14,7 @@ const markdownIt = new MarkdownIt({ html: true })
* @param {string} inlineText Inline token for heading.
* @returns {string} Fragment string for heading.
*/
const convertHeadingToHTMLFragment = (inlineText) => {
export const convertHeadingToHTMLFragment = (inlineText) => {
return (
"#" +
encodeURIComponent(
@ -26,7 +28,7 @@ const convertHeadingToHTMLFragment = (inlineText) => {
"",
)
.replace(/ /gu, "-"),
).toLowerCase()
)
)
}
@ -38,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[]} */
@ -86,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[]} */
@ -126,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)
}
@ -136,7 +138,7 @@ const isValidIntegerString = (value) => {
* @param {string} content
* @returns {number}
*/
const getNumberOfLines = (content) => {
export const getNumberOfLines = (content) => {
return content.split("\n").length
}
@ -146,15 +148,6 @@ const getNumberOfLines = (content) => {
* @returns {string}
* @example getLineNumberStringFromFragment("#L50") // 50
*/
const getLineNumberStringFromFragment = (fragment) => {
export const getLineNumberStringFromFragment = (fragment) => {
return fragment.slice(2)
}
module.exports = {
convertHeadingToHTMLFragment,
getMarkdownHeadings,
getMarkdownIdOrAnchorNameFragments,
isValidIntegerString,
getNumberOfLines,
getLineNumberStringFromFragment,
}

View File

@ -0,0 +1 @@
# Awesome

View File

@ -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)

View File

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

View File

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

View File

@ -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)

View File

@ -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]
}
@ -29,92 +32,138 @@ test("ensure the rule validates correctly", async (t) => {
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: "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: "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: "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",
error: '"./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",
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",
error:
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: "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: "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: "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: "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: "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: "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)
})
}
})
@ -131,11 +180,6 @@ test("ensure the rule validates correctly", async (t) => {
fixturePath:
"test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md",
},
{
name: "should be valid with an existing heading fragment (case insensitive)",
fixturePath:
"test/fixtures/valid/existing-heading-case-insensitive/existing-heading-case-insensitive.md",
},
{
name: "should be valid with an existing heading fragment",
fixturePath:
@ -151,6 +195,11 @@ test("ensure the rule validates correctly", async (t) => {
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:
@ -186,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(", ")}`,
)
})
}
})

View File

@ -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 () => {

View File

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