10 Commits

20 changed files with 2124 additions and 4786 deletions

View File

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

View File

@@ -10,10 +10,10 @@ jobs:
lint: lint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.2.2" - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.1.0" uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@@ -21,15 +21,7 @@ jobs:
- name: "Install dependencies" - name: "Install dependencies"
run: "npm clean-install" run: "npm clean-install"
- run: "node --run lint:editorconfig"
- run: "node --run lint:markdown" - run: "node --run lint:markdown"
- run: "node --run lint:eslint"
- run: "node --run lint:prettier"
- run: "node --run lint:typescript" - run: "node --run lint:typescript"
- run: "node --run lint:oxlint"
commitlint: - run: "node --run lint:oxfmt"
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v4.2.2"
- uses: "wagoid/commitlint-github-action@v6.2.0"

View File

@@ -4,6 +4,10 @@ on:
push: push:
branches: [main] branches: [main]
permissions:
id-token: "write" # OIDC
contents: "read"
jobs: jobs:
release: release:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
@@ -13,13 +17,13 @@ jobs:
pull-requests: "write" pull-requests: "write"
id-token: "write" id-token: "write"
steps: steps:
- uses: "actions/checkout@v4.2.2" - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
with: with:
fetch-depth: 0 fetch-depth: 0
persist-credentials: false persist-credentials: false
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.1.0" uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@@ -34,4 +38,3 @@ jobs:
run: "node --run release" run: "node --run release"
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@@ -8,12 +8,19 @@ on:
jobs: jobs:
test: test:
runs-on: "ubuntu-latest" strategy:
fail-fast: false
matrix:
runs-on:
- "ubuntu-latest"
- "windows-latest"
- "macos-latest"
runs-on: "${{ matrix.runs-on }}"
steps: steps:
- uses: "actions/checkout@v4.2.2" - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.1.0" uses: "actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238" # v6.2.0
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"

View File

@@ -1,18 +1,17 @@
import relativeLinksRule, { markdownIt } from "./src/index.js" import relativeLinksRule from "./src/index.js"
const config = { const config = {
config: { config: {
extends: "markdownlint/style/prettier", extends: "markdownlint/style/prettier",
default: true, default: true,
"relative-links": true, "relative-links": {
root_path: ".",
},
"no-inline-html": false, "no-inline-html": false,
}, },
globs: ["**/*.md"], globs: ["**/*.md"],
ignores: ["**/node_modules", "**/test/fixtures/**"], ignores: ["**/node_modules", "**/test/fixtures/**"],
customRules: [relativeLinksRule], customRules: [relativeLinksRule],
markdownItFactory: () => {
return markdownIt
},
} }
export default config export default config

4
.oxfmtrc.json Normal file
View File

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

4
.oxlintrc.json Normal file
View File

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

View File

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

View File

@@ -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 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)`). - 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`). - 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 ### 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" />`). - 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 ### Related links
@@ -83,7 +84,7 @@ We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markd
`.markdownlint-cli2.mjs` `.markdownlint-cli2.mjs`
```js ```js
import relativeLinksRule, { markdownIt } from "markdownlint-rule-relative-links" import relativeLinksRule from "markdownlint-rule-relative-links"
const config = { const config = {
config: { config: {
@@ -93,9 +94,6 @@ const config = {
globs: ["**/*.md"], globs: ["**/*.md"],
ignores: ["**/node_modules"], ignores: ["**/node_modules"],
customRules: [relativeLinksRule], customRules: [relativeLinksRule],
markdownItFactory: () => {
return markdownIt
},
} }
export default config export default config
@@ -111,6 +109,25 @@ export default config
} }
``` ```
### 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 ## Usage
```sh ```sh
@@ -121,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. 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 ## 📄 License
[MIT](./LICENSE) [MIT](/LICENSE)

View File

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

6540
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,62 +1,58 @@
{ {
"name": "markdownlint-rule-relative-links", "name": "markdownlint-rule-relative-links",
"version": "0.0.0-development", "version": "0.0.0-development",
"public": true,
"description": "Custom rule for markdownlint to validate relative links.", "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": [ "keywords": [
"markdownlint", "markdownlint",
"markdownlint-rule" "markdownlint-rule"
], ],
"main": "src/index.js", "homepage": "https://github.com/theoludwig/markdownlint-rule-relative-links#readme",
"types": "src/index.d.ts", "bugs": {
"type": "module", "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": [ "files": [
"src" "src"
], ],
"type": "module",
"main": "src/index.js",
"types": "src/index.d.ts",
"publishConfig": { "publishConfig": {
"access": "public", "access": "public",
"provenance": true "provenance": true
}, },
"engines": {
"node": ">=22.0.0"
},
"scripts": { "scripts": {
"lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2", "lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint . --max-warnings 0",
"lint:prettier": "prettier . --check",
"lint:typescript": "tsc --noEmit", "lint:typescript": "tsc --noEmit",
"lint:oxlint": "oxlint . --deny-warnings --report-unused-disable-directives",
"lint:oxfmt": "oxfmt . --check",
"oxfmt": "oxfmt .",
"test": "node --test", "test": "node --test",
"release": "semantic-release" "release": "semantic-release"
}, },
"dependencies": { "dependencies": {
"markdown-it": "14.1.0" "markdown-it": "14.1.0",
"mime": "4.1.0"
}, },
"devDependencies": { "devDependencies": {
"@types/markdown-it": "14.1.2", "@types/markdown-it": "14.1.2",
"@types/node": "22.15.17", "@types/node": "25.2.1",
"editorconfig-checker": "6.0.1", "eslint-config-conventions": "21.2.0",
"eslint": "9.26.0", "markdownlint": "0.40.0",
"eslint-config-conventions": "19.2.0", "markdownlint-cli2": "0.20.0",
"eslint-plugin-promise": "7.2.1", "oxfmt": "0.28.0",
"eslint-plugin-unicorn": "59.0.1", "oxlint": "1.43.0",
"eslint-plugin-import-x": "4.11.1", "oxlint-tsgolint": "0.11.4",
"globals": "16.1.0", "semantic-release": "25.0.3",
"markdownlint": "0.38.0", "typescript": "5.9.3"
"markdownlint-cli2": "0.18.0", },
"prettier": "3.5.3", "engines": {
"semantic-release": "24.2.3", "node": ">=22.0.0"
"typescript-eslint": "8.32.0", },
"typescript": "5.8.3" "public": true
}
} }

View File

@@ -1,5 +1,6 @@
import { pathToFileURL } from "node:url" import { fileURLToPath, pathToFileURL } from "node:url"
import fs from "node:fs" import fs from "node:fs"
import mime from "mime"
import { filterTokens } from "./markdownlint-rule-helpers/helpers.js" import { filterTokens } from "./markdownlint-rule-helpers/helpers.js"
import { import {
@@ -51,17 +52,25 @@ const relativeLinksRule = {
} }
} }
if (hrefSrc == null) { if (hrefSrc == null || hrefSrc.startsWith("#")) {
continue continue
} }
const url = new URL(hrefSrc, pathToFileURL(params.name)) let url
const isRelative =
url.protocol === "file:" &&
!hrefSrc.startsWith("/") &&
!hrefSrc.startsWith("#")
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 continue
} }
@@ -75,6 +84,15 @@ const relativeLinksRule = {
continue 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 (url.hash.length <= 0) {
if (hrefSrc.includes("#")) { if (hrefSrc.includes("#")) {
if (type === "image") { if (type === "image") {
@@ -108,8 +126,7 @@ const relativeLinksRule = {
const fileContent = fs.readFileSync(url, { encoding: "utf8" }) const fileContent = fs.readFileSync(url, { encoding: "utf8" })
const headings = getMarkdownHeadings(fileContent) const headings = getMarkdownHeadings(fileContent)
const idOrAnchorNameHTMLFragments = const idOrAnchorNameHTMLFragments = getMarkdownIdOrAnchorNameFragments(fileContent)
getMarkdownIdOrAnchorNameFragments(fileContent)
/** @type {Map<string, number>} */ /** @type {Map<string, number>} */
const fragments = new Map() const fragments = new Map()
@@ -128,9 +145,7 @@ const relativeLinksRule = {
if (!fragmentsHTML.includes(url.hash)) { if (!fragmentsHTML.includes(url.hash)) {
if (url.hash.startsWith("#L")) { if (url.hash.startsWith("#L")) {
const lineNumberFragmentString = getLineNumberStringFromFragment( const lineNumberFragmentString = getLineNumberStringFromFragment(url.hash)
url.hash,
)
const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString) const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
if (!hasOnlyDigits) { if (!hasOnlyDigits) {
@@ -145,10 +160,7 @@ const relativeLinksRule = {
continue continue
} }
const lineNumberFragment = Number.parseInt( const lineNumberFragment = Number.parseInt(lineNumberFragmentString, 10)
lineNumberFragmentString,
10,
)
const numberOfLines = getNumberOfLines(fileContent) const numberOfLines = getNumberOfLines(fileContent)
if (lineNumberFragment > numberOfLines) { if (lineNumberFragment > numberOfLines) {
onError({ onError({

View File

@@ -23,10 +23,7 @@ export const convertHeadingToHTMLFragment = (inlineText) => {
// RegExp source with Ruby's \p{Word} expanded into its General Categories // 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://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb
// https://ruby-doc.org/core-3.0.2/Regexp.html // https://ruby-doc.org/core-3.0.2/Regexp.html
.replace( .replace(/[^\p{Letter}\p{Mark}\p{Number}\p{Connector_Punctuation}\- ]/gu, "")
/[^\p{Letter}\p{Mark}\p{Number}\p{Connector_Punctuation}\- ]/gu,
"",
)
.replace(/ /gu, "-"), .replace(/ /gu, "-"),
) )
) )
@@ -96,8 +93,7 @@ export const getMarkdownIdOrAnchorNameFragments = (content) => {
for (const token of tokens) { for (const token of tokens) {
const regexMatch = const regexMatch =
idHTMLAttributeRegex.exec(token.content) || idHTMLAttributeRegex.exec(token.content) || nameHTMLAttributeRegex.exec(token.content)
nameHTMLAttributeRegex.exec(token.content)
if (regexMatch == null) { if (regexMatch == null) {
continue continue
} }

View File

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

View File

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

1
test/fixtures/not-an-image.txt vendored Normal file
View File

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

View File

@@ -5,17 +5,22 @@ import * as markdownlint from "markdownlint/promise"
import relativeLinksRule, { markdownIt } from "../src/index.js" import relativeLinksRule, { markdownIt } from "../src/index.js"
const defaultConfig = {
"relative-links": true,
}
/** /**
* *
* @param {string} fixtureFile * @param {string} fixtureFile
* @param {Object} config
* @returns * @returns
*/ */
const validateMarkdownLint = async (fixtureFile) => { const validateMarkdownLint = async (fixtureFile, config = defaultConfig) => {
const lintResults = await markdownlint.lint({ const lintResults = await markdownlint.lint({
files: [fixtureFile], files: [fixtureFile],
config: { config: {
default: false, default: false,
"relative-links": true, ...config,
}, },
customRules: [relativeLinksRule], customRules: [relativeLinksRule],
markdownItFactory: () => { markdownItFactory: () => {
@@ -30,22 +35,18 @@ test("ensure the rule validates correctly", async (t) => {
const testCases = [ const testCases = [
{ {
name: "should be invalid with an empty id fragment", name: "should be invalid with an empty id fragment",
fixturePath: fixturePath: "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
"test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
errors: ['"./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", name: "should be invalid with a name fragment other than for an anchor",
fixturePath: fixturePath:
"test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/ignore-name-fragment-if-not-an-anchor.md", "test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/ignore-name-fragment-if-not-an-anchor.md",
errors: [ errors: ['"./awesome.md#name-should-be-ignored" should have a valid fragment identifier'],
'"./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)", name: "should be invalid with a non-existing id fragment (data-id !== id)",
fixturePath: fixturePath: "test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md",
"test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md",
errors: [ errors: [
'"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier', '"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier',
], ],
@@ -54,17 +55,13 @@ test("ensure the rule validates correctly", async (t) => {
name: "should be invalid with uppercase letters in fragment (case sensitive)", name: "should be invalid with uppercase letters in fragment (case sensitive)",
fixturePath: fixturePath:
"test/fixtures/invalid/invalid-heading-case-sensitive/invalid-heading-case-sensitive.md", "test/fixtures/invalid/invalid-heading-case-sensitive/invalid-heading-case-sensitive.md",
errors: [ errors: ['"./awesome.md#ExistIng-Heading" should have a valid fragment identifier'],
'"./awesome.md#ExistIng-Heading" should have a valid fragment identifier',
],
}, },
{ {
name: "should be invalid with invalid heading with #L fragment", name: "should be invalid with invalid heading with #L fragment",
fixturePath: fixturePath:
"test/fixtures/invalid/invalid-heading-with-L-fragment/invalid-heading-with-L-fragment.md", "test/fixtures/invalid/invalid-heading-with-L-fragment/invalid-heading-with-L-fragment.md",
errors: [ errors: ['"./awesome.md#L7abc" should have a valid fragment identifier'],
'"./awesome.md#L7abc" should have a valid fragment identifier',
],
}, },
{ {
name: "should be invalid with a invalid line column range number fragment", name: "should be invalid with a invalid line column range number fragment",
@@ -116,22 +113,16 @@ test("ensure the rule validates correctly", async (t) => {
name: "should be invalid with a non-existing heading fragment", name: "should be invalid with a non-existing heading fragment",
fixturePath: fixturePath:
"test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md", "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
errors: [ errors: ['"./awesome.md#non-existing-heading" should have a valid fragment identifier'],
'"./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", name: "should be invalid with a link to an image with a empty fragment",
fixturePath: fixturePath: "test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md",
"test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md", errors: ['"../image.png#" should not have a fragment identifier as it is an image'],
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", name: "should be invalid with a link to an image with a fragment",
fixturePath: fixturePath: "test/fixtures/invalid/ignore-fragment-checking-for-image.md",
"test/fixtures/invalid/ignore-fragment-checking-for-image.md",
errors: [ errors: [
'"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image', '"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image',
], ],
@@ -146,24 +137,35 @@ test("ensure the rule validates correctly", async (t) => {
fixturePath: "test/fixtures/invalid/non-existing-image.md", fixturePath: "test/fixtures/invalid/non-existing-image.md",
errors: ['"./image.png" should exist in the file system'], 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 () => { await t.test(name, async () => {
const lintResults = (await validateMarkdownLint(fixturePath)) ?? [] const lintResults = (await validateMarkdownLint(fixturePath, config)) ?? []
const errorsDetails = lintResults.map((result) => { const errorsDetails = lintResults.map((result) => {
assert.deepEqual(result.ruleNames, relativeLinksRule.names) assert.deepEqual(result.ruleNames, relativeLinksRule.names)
assert.deepEqual( assert.deepEqual(result.ruleDescription, relativeLinksRule.description)
result.ruleDescription,
relativeLinksRule.description,
)
return result.errorDetail return result.errorDetail
}) })
assert.deepStrictEqual( assert.deepStrictEqual(errorsDetails, errors, `${fixturePath}: Expected errors`)
errorsDetails,
errors,
`${fixturePath}: Expected errors`,
)
}) })
} }
}) })
@@ -182,8 +184,7 @@ test("ensure the rule validates correctly", async (t) => {
}, },
{ {
name: "should be valid with an existing heading fragment", name: "should be valid with an existing heading fragment",
fixturePath: fixturePath: "test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
"test/fixtures/valid/existing-heading-fragment/existing-heading-fragment.md",
}, },
{ {
name: 'should be valid with an existing heading fragment with accents (e.g: "é")', name: 'should be valid with an existing heading fragment with accents (e.g: "é")',
@@ -207,8 +208,7 @@ test("ensure the rule validates correctly", async (t) => {
}, },
{ {
name: "should be valid with valid line number fragment", name: "should be valid with valid line number fragment",
fixturePath: fixturePath: "test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md",
"test/fixtures/valid/valid-line-number-fragment/valid-line-number-fragment.md",
}, },
{ {
name: "should be valid with an existing file", name: "should be valid with an existing file",
@@ -219,7 +219,7 @@ test("ensure the rule validates correctly", async (t) => {
fixturePath: "test/fixtures/valid/existing-image.md", 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", fixturePath: "test/fixtures/valid/ignore-absolute-paths.md",
}, },
{ {
@@ -228,14 +228,22 @@ test("ensure the rule validates correctly", async (t) => {
}, },
{ {
name: "should ignore checking fragment in own file", name: "should ignore checking fragment in own file",
fixturePath: fixturePath: "test/fixtures/valid/ignore-fragment-checking-in-own-file.md",
"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 () => { await t.test(name, async () => {
const lintResults = (await validateMarkdownLint(fixturePath)) ?? [] const lintResults = (await validateMarkdownLint(fixturePath, config)) ?? []
const errorsDetails = lintResults.map((result) => { const errorsDetails = lintResults.map((result) => {
return result.errorDetail return result.errorDetail
}) })

View File

@@ -12,18 +12,13 @@ import {
test("utils", async (t) => { test("utils", async (t) => {
await t.test("convertHeadingToHTMLFragment", async () => { await t.test("convertHeadingToHTMLFragment", async () => {
assert.strictEqual( assert.strictEqual(convertHeadingToHTMLFragment("Valid Fragments"), "#valid-fragments")
convertHeadingToHTMLFragment("Valid Fragments"),
"#valid-fragments",
)
assert.strictEqual( assert.strictEqual(
convertHeadingToHTMLFragment("Valid Heading With Underscores _"), convertHeadingToHTMLFragment("Valid Heading With Underscores _"),
"#valid-heading-with-underscores-_", "#valid-heading-with-underscores-_",
) )
assert.strictEqual( assert.strictEqual(
convertHeadingToHTMLFragment( convertHeadingToHTMLFragment(`Valid Heading With Quotes ' And Double Quotes "`),
`Valid Heading With Quotes ' And Double Quotes "`,
),
"#valid-heading-with-quotes--and-double-quotes-", "#valid-heading-with-quotes--and-double-quotes-",
) )
assert.strictEqual( assert.strictEqual(
@@ -33,27 +28,22 @@ test("utils", async (t) => {
}) })
await t.test("getMarkdownHeadings", async () => { await t.test("getMarkdownHeadings", async () => {
assert.deepStrictEqual( assert.deepStrictEqual(getMarkdownHeadings("# Hello\n\n## World\n\n## Hello, world!\n"), [
getMarkdownHeadings("# Hello\n\n## World\n\n## Hello, world!\n"), "Hello",
["Hello", "World", "Hello, world!"], "World",
) "Hello, world!",
])
}) })
await t.test("getMarkdownIdOrAnchorNameFragments", async () => { await t.test("getMarkdownIdOrAnchorNameFragments", async () => {
assert.deepStrictEqual( assert.deepStrictEqual(
getMarkdownIdOrAnchorNameFragments( getMarkdownIdOrAnchorNameFragments('<a name="anchorName" id="anchorId">Link</a>'),
'<a name="anchorName" id="anchorId">Link</a>',
),
["#anchorId"], ["#anchorId"],
) )
assert.deepStrictEqual( assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments('<a name="anchorName">Link</a>'), [
getMarkdownIdOrAnchorNameFragments('<a name="anchorName">Link</a>'), "#anchorName",
["#anchorName"], ])
) assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>Link</a>"), [])
assert.deepStrictEqual(
getMarkdownIdOrAnchorNameFragments("<a>Link</a>"),
[],
)
assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>"), []) assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a>"), [])
assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a id=>"), []) assert.deepStrictEqual(getMarkdownIdOrAnchorNameFragments("<a id=>"), [])
}) })

View File

@@ -8,7 +8,6 @@
"allowJs": true, "allowJs": true,
"noEmit": true, "noEmit": true,
"rootDir": ".", "rootDir": ".",
"baseUrl": ".",
"skipLibCheck": true, "skipLibCheck": true,
"strict": true, "strict": true,
"allowUnusedLabels": false, "allowUnusedLabels": false,