9 Commits

Author SHA1 Message Date
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
bf9403ad84 style: fix prettier 2024-04-06 20:14:59 +02:00
9675c7a275 fix: update markdown-it to v14.1.0
This allows to use the same version as markdownlint v0.34.0.
2024-04-06 20:10:13 +02:00
5af131b840 fix: link fragment with accents should be valid if the heading exists
Fixes a regression introduced in v2.3.0, which needed to lower case/manage case insensitive heading.
2024-01-31 21:56:55 +01:00
31 changed files with 3315 additions and 4816 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: push:
branches: [develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [main, develop]
jobs: jobs:
lint: lint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.1.1" - uses: "actions/checkout@v4.1.7"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.1" uses: "actions/setup-node@v4.0.3"
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@ -21,9 +21,15 @@ jobs:
- name: "Install dependencies" - name: "Install dependencies"
run: "npm clean-install" run: "npm clean-install"
- run: 'npm run lint:commit -- --to "${{ github.sha }}"' - run: "node --run lint:editorconfig"
- run: "npm run lint:editorconfig" - run: "node --run lint:markdown"
- run: "npm run lint:markdown" - run: "node --run lint:eslint"
- run: "npm run lint:eslint" - run: "node --run lint:prettier"
- run: "npm run lint:prettier" - run: "node --run lint:typescript"
- run: "npm run lint:javascript"
commitlint:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v4.1.7"
- uses: "wagoid/commitlint-github-action@v6.1.2"

View File

@ -2,7 +2,7 @@ name: "Release"
on: on:
push: push:
branches: [master] branches: [main]
jobs: jobs:
release: release:
@ -13,13 +13,13 @@ jobs:
pull-requests: "write" pull-requests: "write"
id-token: "write" id-token: "write"
steps: steps:
- uses: "actions/checkout@v4.1.1" - uses: "actions/checkout@v4.1.7"
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.0.1" uses: "actions/setup-node@v4.0.3"
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@ -31,7 +31,7 @@ jobs:
run: "npm audit signatures" run: "npm audit signatures"
- name: "Release" - name: "Release"
run: "npm run release" run: "node --run release"
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@ -4,16 +4,16 @@ on:
push: push:
branches: [develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [main, develop]
jobs: jobs:
test: test:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.1.1" - uses: "actions/checkout@v4.1.7"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.1" uses: "actions/setup-node@v4.0.3"
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@ -22,4 +22,4 @@ jobs:
run: "npm clean-install" run: "npm clean-install"
- name: "Test" - name: "Test"
run: "npm run test" run: "node --run test"

4
.gitignore vendored
View File

@ -20,10 +20,6 @@ npm-debug.log*
# IDE - VSCode # IDE - VSCode
.vscode/* .vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
# misc # misc
.DS_Store .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"
]
}

4
.npmrc
View File

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

View File

@ -1,18 +1,8 @@
{ {
"branches": ["master"], "branches": ["main", { "name": "beta", "prerelease": true }],
"plugins": [ "plugins": [
[ "@semantic-release/commit-analyzer",
"@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator",
{
"preset": "conventionalcommits"
}
],
[
"@semantic-release/release-notes-generator",
{
"preset": "conventionalcommits"
}
],
"@semantic-release/npm", "@semantic-release/npm",
"@semantic-release/github" "@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

@ -107,7 +107,7 @@ We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markd
## Usage ## Usage
```sh ```sh
npm run lint:markdown node --run lint:markdown
``` ```
## 💡 Contributing ## 💡 Contributing

13
eslint.config.mjs 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,
},
},
})

7729
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -26,46 +26,35 @@
"provenance": true "provenance": true
}, },
"engines": { "engines": {
"node": ">=16.0.0", "node": ">=16.0.0"
"npm": ">=9.0.0"
}, },
"scripts": { "scripts": {
"lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2", "lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore", "lint:eslint": "eslint . --max-warnings 0",
"lint:prettier": "prettier . --check --ignore-path .gitignore", "lint:prettier": "prettier . --check",
"lint:javascript": "tsc --project jsconfig.json --noEmit", "lint:typescript": "tsc --noEmit",
"lint:staged": "lint-staged",
"test": "node --test", "test": "node --test",
"release": "semantic-release", "release": "semantic-release"
"postinstall": "husky",
"prepublishOnly": "pinst --disable",
"postpublish": "pinst --enable"
}, },
"dependencies": { "dependencies": {
"markdown-it": "14.0.0" "markdown-it": "14.1.0"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "18.6.0", "@types/markdown-it": "14.1.2",
"@commitlint/config-conventional": "18.6.0", "@types/node": "22.9.0",
"@types/markdown-it": "13.0.7", "editorconfig-checker": "6.0.0",
"@types/node": "20.11.10", "eslint": "9.14.0",
"editorconfig-checker": "5.1.2", "eslint-config-conventions": "17.0.0",
"eslint": "8.56.0", "eslint-plugin-promise": "7.1.0",
"eslint-config-conventions": "13.1.0", "eslint-plugin-unicorn": "56.0.0",
"eslint-config-prettier": "9.1.0", "eslint-plugin-import-x": "4.4.0",
"eslint-plugin-import": "2.29.1", "globals": "15.12.0",
"eslint-plugin-prettier": "5.1.3", "markdownlint": "0.36.1",
"eslint-plugin-promise": "6.1.1", "markdownlint-cli2": "0.15.0",
"eslint-plugin-unicorn": "50.0.1", "prettier": "3.3.3",
"husky": "9.0.7", "semantic-release": "23.1.1",
"lint-staged": "15.2.0", "typescript-eslint": "8.13.0",
"markdownlint": "0.33.0", "typescript": "5.6.3"
"markdownlint-cli2": "0.12.1",
"pinst": "3.0.0",
"prettier": "3.2.4",
"semantic-release": "23.0.0",
"typescript": "5.3.3"
} }
} }

View File

@ -11,6 +11,7 @@ const {
isValidIntegerString, isValidIntegerString,
getNumberOfLines, getNumberOfLines,
getLineNumberStringFromFragment, getLineNumberStringFromFragment,
lineFragmentRe,
} = require("./utils.js") } = require("./utils.js")
/** @typedef {import('markdownlint').Rule} MarkdownLintRule */ /** @typedef {import('markdownlint').Rule} MarkdownLintRule */
@ -22,6 +23,7 @@ const customRule = {
names: ["relative-links"], names: ["relative-links"],
description: "Relative links should be valid", description: "Relative links should be valid",
tags: ["links"], tags: ["links"],
parser: "markdownit",
function: (params, onError) => { function: (params, onError) => {
filterTokens(params, "inline", (token) => { filterTokens(params, "inline", (token) => {
const children = token.children ?? [] const children = token.children ?? []
@ -124,7 +126,7 @@ const customRule = {
fragmentsHTML.push(...idOrAnchorNameHTMLFragments) fragmentsHTML.push(...idOrAnchorNameHTMLFragments)
if (!fragmentsHTML.includes(url.hash.toLowerCase())) { 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,
@ -132,6 +134,10 @@ const customRule = {
const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString) const hasOnlyDigits = isValidIntegerString(lineNumberFragmentString)
if (!hasOnlyDigits) { if (!hasOnlyDigits) {
if (lineFragmentRe.test(url.hash)) {
continue
}
onError({ onError({
lineNumber, lineNumber,
detail: `${detail} should have a valid fragment identifier`, detail: `${detail} should have a valid fragment identifier`,
@ -151,6 +157,8 @@ const customRule = {
}) })
continue continue
} }
continue
} }
onError({ onError({

View File

@ -15,7 +15,7 @@
* @returns {void} * @returns {void}
*/ */
const filterTokens = (params, type, handler) => { const filterTokens = (params, type, handler) => {
for (const token of params.tokens) { for (const token of params.parsers.markdownit.tokens) {
if (token.type === type) { if (token.type === type) {
handler(token) handler(token)
} }

View File

@ -4,6 +4,8 @@ const { getHtmlAttributeRe } = require("./markdownlint-rule-helpers/helpers.js")
const markdownIt = new MarkdownIt({ html: true }) const markdownIt = new MarkdownIt({ html: true })
const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/
/** /**
* Converts a Markdown heading into an HTML fragment according to the rules * Converts a Markdown heading into an HTML fragment according to the rules
* used by GitHub. * used by GitHub.
@ -151,6 +153,7 @@ const getLineNumberStringFromFragment = (fragment) => {
} }
module.exports = { module.exports = {
lineFragmentRe,
convertHeadingToHTMLFragment, convertHeadingToHTMLFragment,
getMarkdownHeadings, getMarkdownHeadings,
getMarkdownIdOrAnchorNameFragments, getMarkdownIdOrAnchorNameFragments,

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

@ -0,0 +1,3 @@
# Awesome
## Développement

View File

@ -0,0 +1,3 @@
# Valid
[Link fragment](./awesome.md#développement)

View File

@ -1,3 +1,3 @@
# Valid # 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

@ -26,95 +26,141 @@ test("ensure the rule validates correctly", async (t) => {
await t.test("should be invalid", async (t) => { await t.test("should be invalid", async (t) => {
const testCases = [ const testCases = [
{ {
name: "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",
error: '"./awesome.md#" should have a valid fragment identifier', errors: ['"./awesome.md#" should have a valid fragment identifier'],
}, },
{ {
name: "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",
error: 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: "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",
error: 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',
],
}, },
{ {
name: "with invalid heading with #L fragment", 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: 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",
error: '"./awesome.md#L7abc" should have a valid fragment identifier', errors: [
'"./awesome.md#L7abc" should have a valid fragment identifier',
],
}, },
{ {
name: "with a invalid line number fragment", 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: fixturePath:
"test/fixtures/invalid/invalid-line-number-fragment/invalid-line-number-fragment.md", "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', '"./awesome.md#L7" should have a valid fragment identifier, "./awesome.md#L7" should have at least 7 lines to be valid',
],
}, },
{ {
name: "with a non-existing anchor name fragment", name: "should be invalid with a non-existing anchor name fragment",
fixturePath: fixturePath:
"test/fixtures/invalid/non-existing-anchor-name-fragment/non-existing-anchor-name-fragment.md", "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', '"./awesome.md#non-existing-anchor-name-fragment" should have a valid fragment identifier',
],
}, },
{ {
name: "with a non-existing element id fragment", name: "should be invalid with a non-existing element id fragment",
fixturePath: fixturePath:
"test/fixtures/invalid/non-existing-element-id-fragment/non-existing-element-id-fragment.md", "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', '"./awesome.md#non-existing-element-id-fragment" should have a valid fragment identifier',
],
}, },
{ {
name: "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",
error: errors: [
'"./awesome.md#non-existing-heading" should have a valid fragment identifier', '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
],
}, },
{ {
name: "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",
error: errors: [
'"../image.png#" should not have a fragment identifier as it is an image', '"../image.png#" should not have a fragment identifier as it is an image',
],
}, },
{ {
name: "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",
error: 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',
],
}, },
{ {
name: "with a non-existing file", name: "should be invalid with a non-existing file",
fixturePath: "test/fixtures/invalid/non-existing-file.md", 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: "with a non-existing image", name: "should be invalid with a non-existing image",
fixturePath: "test/fixtures/invalid/non-existing-image.md", 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 () => { await t.test(name, async () => {
const lintResults = await validateMarkdownLint(fixturePath) const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
assert.equal(lintResults?.length, 1) const errorsDetails = lintResults.map((result) => {
assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names) assert.deepEqual(result.ruleNames, relativeLinksRule.names)
assert.equal( assert.deepEqual(
lintResults?.[0]?.ruleDescription, result.ruleDescription,
relativeLinksRule.description, relativeLinksRule.description,
)
return result.errorDetail
})
assert.deepStrictEqual(
errorsDetails,
errors,
`${fixturePath}: Expected errors`,
) )
assert.equal(lintResults?.[0]?.errorDetail, error)
}) })
} }
}) })
@ -122,46 +168,51 @@ test("ensure the rule validates correctly", async (t) => {
await t.test("should be valid", async (t) => { await t.test("should be valid", async (t) => {
const testCases = [ const testCases = [
{ {
name: "with an existing anchor name fragment", name: "should be valid with an existing anchor name fragment",
fixturePath: fixturePath:
"test/fixtures/valid/existing-anchor-name-fragment/existing-anchor-name-fragment.md", "test/fixtures/valid/existing-anchor-name-fragment/existing-anchor-name-fragment.md",
}, },
{ {
name: "with an existing element id fragment", name: "should be valid with an existing element id fragment",
fixturePath: fixturePath:
"test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md", "test/fixtures/valid/existing-element-id-fragment/existing-element-id-fragment.md",
}, },
{ {
name: "with an existing heading fragment (case insensitive)", name: "should be valid with an existing heading fragment",
fixturePath:
"test/fixtures/valid/existing-heading-case-insensitive/existing-heading-case-insensitive.md",
},
{
name: "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: "é")',
fixturePath:
"test/fixtures/valid/existing-heading-with-accents/existing-heading-with-accents.md",
},
{ {
name: "should only parse markdown files for fragments checking", name: "should only parse markdown files for fragments checking",
fixturePath: fixturePath:
"test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md", "test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md",
}, },
{ {
name: 'with valid heading "like" line number fragment', 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: fixturePath:
"test/fixtures/valid/valid-heading-like-number-fragment/valid-heading-like-number-fragment.md", "test/fixtures/valid/valid-heading-like-number-fragment/valid-heading-like-number-fragment.md",
}, },
{ {
name: "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: "with an existing file", name: "should be valid with an existing file",
fixturePath: "test/fixtures/valid/existing-file.md", fixturePath: "test/fixtures/valid/existing-file.md",
}, },
{ {
name: "with an existing image", name: "should be valid with an existing image",
fixturePath: "test/fixtures/valid/existing-image.md", fixturePath: "test/fixtures/valid/existing-image.md",
}, },
{ {
@ -181,8 +232,15 @@ test("ensure the rule validates correctly", async (t) => {
for (const { name, fixturePath } of testCases) { for (const { name, fixturePath } of testCases) {
await t.test(name, async () => { await t.test(name, async () => {
const lintResults = await validateMarkdownLint(fixturePath) const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
assert.equal(lintResults?.length, 0) const errorsDetails = lintResults.map((result) => {
return result.errorDetail
})
assert.equal(
errorsDetails.length,
0,
`${fixturePath}: Expected no errors, got ${errorsDetails.join(", ")}`,
)
}) })
} }
}) })

View File

@ -2,8 +2,8 @@
"compilerOptions": { "compilerOptions": {
"lib": ["ESNext"], "lib": ["ESNext"],
"target": "ESNext", "target": "ESNext",
"module": "CommonJS", "module": "NodeNext",
"moduleResolution": "Node", "moduleResolution": "NodeNext",
"checkJs": true, "checkJs": true,
"allowJs": true, "allowJs": true,
"noEmit": true, "noEmit": true,
@ -20,6 +20,6 @@
"noUncheckedIndexedAccess": true, "noUncheckedIndexedAccess": true,
"noUnusedLocals": true, "noUnusedLocals": true,
"noUnusedParameters": true, "noUnusedParameters": true,
"forceConsistentCasingInFileNames": true, "forceConsistentCasingInFileNames": true
}, }
} }