theoludwig/markdownlint-rule-relative-links
1
0
Fork 0
mirror of https://github.com/theoludwig/markdownlint-rule-relative-links.git synced 2026-02-10 23:09:47 +01:00
Code Issues Releases Activity

chore: migrate from ESLint/Prettier to Oxc

Browse Source
This commit is contained in:
Théo LUDWIG
2026-02-05 17:29:13 +01:00
parent 075742e867
commit 12a22980ce
13 changed files with 561 additions and 2223 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/lint.yml vendored
View File

@@ -21,8 +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"
- run: "node --run lint:oxlint"
- run: "node --run lint:oxfmt"

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

3
.prettierrc.json
View File

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

2
CONTRIBUTING.md
View File

@@ -4,7 +4,7 @@ Thanks a lot for your interest in contributing to **markdownlint-rule-relative-l
## Code of Conduct
**markdownlint-rule-relative-links** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
**markdownlint-rule-relative-links** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
## Open Development

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

2580
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

53
package.json
View File

@@ -1,41 +1,37 @@
{
"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"
},
@@ -45,18 +41,17 @@
"devDependencies": {
"@types/markdown-it": "14.1.2",
"@types/node": "25.2.1",
"editorconfig-checker": "6.1.1",
"eslint": "9.39.2",
"eslint-config-conventions": "21.2.0",
"eslint-plugin-promise": "7.2.1",
"eslint-plugin-unicorn": "62.0.0",
"eslint-plugin-import-x": "4.16.1",
"globals": "17.3.0",
"markdownlint": "0.40.0",
"markdownlint-cli2": "0.20.0",
"prettier": "3.8.1",
"oxfmt": "0.28.0",
"oxlint": "1.43.0",
"oxlint-tsgolint": "0.11.4",
"semantic-release": "25.0.3",
"typescript-eslint": "8.54.0",
"typescript": "5.9.3"
}
},
"engines": {
"node": ">=22.0.0"
},
"public": true
}

12
src/index.js
View File

@@ -116,8 +116,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()
@@ -136,9 +135,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) {
@@ -153,10 +150,7 @@ const relativeLinksRule = {
continue
}
const lineNumberFragment = Number.parseInt(
lineNumberFragmentString,
10,
)
const lineNumberFragment = Number.parseInt(lineNumberFragmentString, 10)
const numberOfLines = getNumberOfLines(fileContent)
if (lineNumberFragment > numberOfLines) {
onError({

8
src/utils.js
View File

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

65
test/index.test.js
View File

@@ -35,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',
],
@@ -59,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",
@@ -121,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',
],
@@ -163,28 +149,15 @@ test("ensure the rule validates correctly", async (t) => {
},
]
for (const {
name,
fixturePath,
errors,
config = defaultConfig,
} of testCases) {
for (const { name, fixturePath, errors, config = defaultConfig } of testCases) {
await t.test(name, async () => {
const lintResults =
(await validateMarkdownLint(fixturePath, config)) ?? []
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`)
})
}
})
@@ -203,8 +176,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: "é")',
@@ -228,8 +200,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",
@@ -249,8 +220,7 @@ 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",
@@ -265,8 +235,7 @@ test("ensure the rule validates correctly", async (t) => {
for (const { name, fixturePath, config = defaultConfig } of testCases) {
await t.test(name, async () => {
const lintResults =
(await validateMarkdownLint(fixturePath, config)) ?? []
const lintResults = (await validateMarkdownLint(fixturePath, config)) ?? []
const errorsDetails = lintResults.map((result) => {
return result.errorDetail
})

34
test/utils.test.js
View File

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

1
tsconfig.json
View File

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