mirror of
https://github.com/theoludwig/markdownlint-rule-relative-links.git
synced 2026-02-20 03:09:05 +01:00
Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
f48932001a
|
|||
|
c744c4872a
|
|||
|
211c71d75b
|
|||
|
12a22980ce
|
|||
|
075742e867
|
|||
|
5c19f57f9d
|
|||
|
f404ffcd0e
|
|||
|
257d65e6f5
|
|||
|
bc89a30309
|
|||
|
|
3ebc40c2ad | ||
|
|
8a449ad181 | ||
|
9bb5ffe0ae
|
|||
|
876384344c
|
|||
|
70bdb7013e
|
|||
|
db57d67b0b
|
2
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
2
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
@@ -5,4 +5,4 @@ title: "[Question]"
|
||||
labels: "question"
|
||||
---
|
||||
|
||||
### Question
|
||||
## Question
|
||||
|
||||
16
.github/workflows/lint.yml
vendored
16
.github/workflows/lint.yml
vendored
@@ -10,10 +10,10 @@ jobs:
|
||||
lint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
- uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
@@ -21,15 +21,7 @@ jobs:
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- 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"
|
||||
- run: "node --run lint:oxlint"
|
||||
- run: "node --run lint:oxfmt"
|
||||
|
||||
9
.github/workflows/release.yml
vendored
9
.github/workflows/release.yml
vendored
@@ -4,6 +4,10 @@ on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
permissions:
|
||||
id-token: "write" # OIDC
|
||||
contents: "read"
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: "ubuntu-latest"
|
||||
@@ -13,13 +17,13 @@ jobs:
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
- uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
@@ -34,4 +38,3 @@ jobs:
|
||||
run: "node --run release"
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
13
.github/workflows/test.yml
vendored
13
.github/workflows/test.yml
vendored
@@ -8,12 +8,19 @@ on:
|
||||
|
||||
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.2.2"
|
||||
- uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
@@ -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"],
|
||||
}
|
||||
17
.markdownlint-cli2.mjs
Normal file
17
.markdownlint-cli2.mjs
Normal file
@@ -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
|
||||
4
.oxfmtrc.json
Normal file
4
.oxfmtrc.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"$schema": "./node_modules/oxfmt/configuration_schema.json",
|
||||
"semi": false
|
||||
}
|
||||
10
.oxlintrc.json
Normal file
10
.oxlintrc.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
||||
"extends": ["node_modules/eslint-config-conventions/.oxlintrc.json"],
|
||||
"env": {
|
||||
"builtin": true,
|
||||
"browser": true,
|
||||
"node": true,
|
||||
"shared-node-browser": true
|
||||
}
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"semi": false
|
||||
}
|
||||
48
README.md
48
README.md
@@ -51,12 +51,13 @@ awesome.md:3 relative-links Relative links should be valid ["./invalid.txt" shou
|
||||
- Support images (e.g: ``).
|
||||
- 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
|
||||
|
||||
@@ -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,6 +109,25 @@ 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
|
||||
@@ -114,8 +138,8 @@ node --run lint:markdown
|
||||
|
||||
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)
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
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,
|
||||
},
|
||||
},
|
||||
})
|
||||
6454
package-lock.json
generated
6454
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
68
package.json
68
package.json
@@ -1,62 +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",
|
||||
"types": "src/index.d.ts",
|
||||
"type": "module",
|
||||
"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": ">=22.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
"lint:markdown": "markdownlint-cli2",
|
||||
"lint:eslint": "eslint . --max-warnings 0",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"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"
|
||||
},
|
||||
"dependencies": {
|
||||
"markdown-it": "14.1.0"
|
||||
"markdown-it": "14.1.1",
|
||||
"mime": "4.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@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"
|
||||
}
|
||||
"@types/node": "25.3.0",
|
||||
"eslint-config-conventions": "21.2.2",
|
||||
"markdownlint": "0.40.0",
|
||||
"markdownlint-cli2": "0.21.0",
|
||||
"oxfmt": "0.34.0",
|
||||
"oxlint": "1.49.0",
|
||||
"oxlint-tsgolint": "0.14.1",
|
||||
"semantic-release": "25.0.3",
|
||||
"typescript": "5.9.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=22.0.0"
|
||||
},
|
||||
"public": true
|
||||
}
|
||||
|
||||
5
src/index.d.ts
vendored
5
src/index.d.ts
vendored
@@ -1,5 +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 }
|
||||
|
||||
61
src/index.js
61
src/index.js
@@ -1,5 +1,6 @@
|
||||
import { pathToFileURL } from "node:url"
|
||||
import { fileURLToPath, pathToFileURL } from "node:url"
|
||||
import fs from "node:fs"
|
||||
import mime from "mime"
|
||||
|
||||
import { filterTokens } from "./markdownlint-rule-helpers/helpers.js"
|
||||
import {
|
||||
@@ -12,6 +13,8 @@ import {
|
||||
lineFragmentRe,
|
||||
} from "./utils.js"
|
||||
|
||||
export { markdownIt } from "./utils.js"
|
||||
|
||||
/** @typedef {import('markdownlint').Rule} MarkdownLintRule */
|
||||
|
||||
/**
|
||||
@@ -49,22 +52,43 @@ const relativeLinksRule = {
|
||||
}
|
||||
}
|
||||
|
||||
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))
|
||||
}
|
||||
|
||||
const detail = `"${hrefSrc}"`
|
||||
|
||||
if (
|
||||
type === "image" &&
|
||||
url.protocol !== "file:" &&
|
||||
url.protocol !== "http:" &&
|
||||
url.protocol !== "https:"
|
||||
) {
|
||||
onError({
|
||||
lineNumber,
|
||||
detail: `${detail} should be an image`,
|
||||
})
|
||||
continue
|
||||
}
|
||||
|
||||
if (url.protocol !== "file:") {
|
||||
continue
|
||||
}
|
||||
|
||||
if (!fs.existsSync(url)) {
|
||||
onError({
|
||||
lineNumber,
|
||||
@@ -73,6 +97,15 @@ const relativeLinksRule = {
|
||||
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") {
|
||||
@@ -106,8 +139,7 @@ const relativeLinksRule = {
|
||||
|
||||
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()
|
||||
@@ -126,9 +158,7 @@ const relativeLinksRule = {
|
||||
|
||||
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) {
|
||||
@@ -143,10 +173,7 @@ const relativeLinksRule = {
|
||||
continue
|
||||
}
|
||||
|
||||
const lineNumberFragment = Number.parseInt(
|
||||
lineNumberFragmentString,
|
||||
10,
|
||||
)
|
||||
const lineNumberFragment = Number.parseInt(lineNumberFragmentString, 10)
|
||||
const numberOfLines = getNumberOfLines(fileContent)
|
||||
if (lineNumberFragment > numberOfLines) {
|
||||
onError({
|
||||
|
||||
10
src/utils.js
10
src/utils.js
@@ -2,7 +2,7 @@ import MarkdownIt from "markdown-it"
|
||||
|
||||
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+)$/
|
||||
|
||||
@@ -23,10 +23,7 @@ export 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, "-"),
|
||||
)
|
||||
)
|
||||
@@ -96,8 +93,7 @@ export 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
|
||||
}
|
||||
|
||||
3
test/fixtures/config-dependent/absolute-paths.md
vendored
Normal file
3
test/fixtures/config-dependent/absolute-paths.md
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
# Valid
|
||||
|
||||

|
||||
5
test/fixtures/invalid/invalid-image.md
vendored
Normal file
5
test/fixtures/invalid/invalid-image.md
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
# Invalid
|
||||
|
||||

|
||||
|
||||

|
||||
1
test/fixtures/not-an-image.txt
vendored
Normal file
1
test/fixtures/not-an-image.txt
vendored
Normal file
@@ -0,0 +1 @@
|
||||
not an image
|
||||
3
test/fixtures/valid/ignore-external-image.md
vendored
Normal file
3
test/fixtures/valid/ignore-external-image.md
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
# Valid
|
||||
|
||||

|
||||
@@ -3,21 +3,29 @@ import assert from "node:assert/strict"
|
||||
|
||||
import * as markdownlint from "markdownlint/promise"
|
||||
|
||||
import relativeLinksRule from "../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 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 be an image',
|
||||
],
|
||||
},
|
||||
]
|
||||
|
||||
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,26 @@ 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: ".",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "should ignore external image links",
|
||||
fixturePath: "test/fixtures/valid/ignore-external-image.md",
|
||||
},
|
||||
]
|
||||
|
||||
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
|
||||
})
|
||||
|
||||
@@ -12,18 +12,13 @@ import {
|
||||
|
||||
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=>"), [])
|
||||
})
|
||||
|
||||
@@ -8,7 +8,6 @@
|
||||
"allowJs": true,
|
||||
"noEmit": true,
|
||||
"rootDir": ".",
|
||||
"baseUrl": ".",
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"allowUnusedLabels": false,
|
||||
|
||||
Reference in New Issue
Block a user