mirror of
				https://github.com/theoludwig/markdownlint-rule-relative-links.git
				synced 2025-11-01 00:49:07 +01:00 
			
		
		
		
	feat: support columns numbers (and line range) in links fragments
Fixes #7
This commit is contained in:
		@@ -29,92 +29,126 @@ test("ensure the rule validates correctly", async (t) => {
 | 
			
		||||
        name: "should be invalid with an empty id fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/empty-id-fragment/empty-id-fragment.md",
 | 
			
		||||
        error: '"./awesome.md#" should have a valid fragment identifier',
 | 
			
		||||
        errors: ['"./awesome.md#" should have a valid fragment identifier'],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a name fragment other than for an anchor",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/ignore-name-fragment-if-not-an-anchor/ignore-name-fragment-if-not-an-anchor.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#name-should-be-ignored" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing id fragment (data-id !== id)",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/ignore-not-an-id-fragment/ignore-not-an-id-fragment.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#not-an-id-should-be-ignored" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with invalid heading with #L fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/invalid-heading-with-L-fragment/invalid-heading-with-L-fragment.md",
 | 
			
		||||
        error: '"./awesome.md#L7abc" should have a valid fragment identifier',
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#L7abc" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a invalid line column range number fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/invalid-line-column-range-number-fragment/invalid-line-column-range-number-fragment.md",
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#L12-not-a-line-link" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#l7" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L7extra" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30Cextra" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30L12" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C12" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C11-" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C11-L" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C11-L31C" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#L30C11-C31" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#C30" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#C11-C31" should have a valid fragment identifier',
 | 
			
		||||
          '"./awesome.md#C11-L4C31" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a invalid line number fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/invalid-line-number-fragment/invalid-line-number-fragment.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#L7" should have a valid fragment identifier, "./awesome.md#L7" should have at least 7 lines to be valid',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing anchor name fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/non-existing-anchor-name-fragment/non-existing-anchor-name-fragment.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#non-existing-anchor-name-fragment" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing element id fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/non-existing-element-id-fragment/non-existing-element-id-fragment.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#non-existing-element-id-fragment" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing heading fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/non-existing-heading-fragment/non-existing-heading-fragment.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"./awesome.md#non-existing-heading" should have a valid fragment identifier',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a link to an image with a empty fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/ignore-empty-fragment-checking-for-image.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"../image.png#" should not have a fragment identifier as it is an image',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a link to an image with a fragment",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/invalid/ignore-fragment-checking-for-image.md",
 | 
			
		||||
        error:
 | 
			
		||||
        errors: [
 | 
			
		||||
          '"../image.png#non-existing-fragment" should not have a fragment identifier as it is an image',
 | 
			
		||||
        ],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing file",
 | 
			
		||||
        fixturePath: "test/fixtures/invalid/non-existing-file.md",
 | 
			
		||||
        error: '"./index.test.js" should exist in the file system',
 | 
			
		||||
        errors: ['"./index.test.js" should exist in the file system'],
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should be invalid with a non-existing image",
 | 
			
		||||
        fixturePath: "test/fixtures/invalid/non-existing-image.md",
 | 
			
		||||
        error: '"./image.png" should exist in the file system',
 | 
			
		||||
        errors: ['"./image.png" should exist in the file system'],
 | 
			
		||||
      },
 | 
			
		||||
    ]
 | 
			
		||||
 | 
			
		||||
    for (const { name, fixturePath, error } of testCases) {
 | 
			
		||||
    for (const { name, fixturePath, errors } of testCases) {
 | 
			
		||||
      await t.test(name, async () => {
 | 
			
		||||
        const lintResults = await validateMarkdownLint(fixturePath)
 | 
			
		||||
        assert.equal(lintResults?.length, 1)
 | 
			
		||||
        assert.deepEqual(lintResults?.[0]?.ruleNames, relativeLinksRule.names)
 | 
			
		||||
        assert.equal(
 | 
			
		||||
          lintResults?.[0]?.ruleDescription,
 | 
			
		||||
          relativeLinksRule.description,
 | 
			
		||||
        )
 | 
			
		||||
        assert.equal(lintResults?.[0]?.errorDetail, error)
 | 
			
		||||
        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
 | 
			
		||||
        const errorsDetails = lintResults.map((result) => {
 | 
			
		||||
          assert.deepEqual(result.ruleNames, relativeLinksRule.names)
 | 
			
		||||
          assert.deepEqual(
 | 
			
		||||
            result.ruleDescription,
 | 
			
		||||
            relativeLinksRule.description,
 | 
			
		||||
          )
 | 
			
		||||
          return result.errorDetail
 | 
			
		||||
        })
 | 
			
		||||
        assert.deepStrictEqual(errorsDetails, errors)
 | 
			
		||||
      })
 | 
			
		||||
    }
 | 
			
		||||
  })
 | 
			
		||||
@@ -151,6 +185,11 @@ test("ensure the rule validates correctly", async (t) => {
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/valid/only-parse-markdown-files-for-fragments/only-parse-markdown-files-for-fragments.md",
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: "should support lines and columns range numbers in link fragments",
 | 
			
		||||
        fixturePath:
 | 
			
		||||
          "test/fixtures/valid/valid-line-column-range-number-fragment/valid-line-column-range-number-fragment.md",
 | 
			
		||||
      },
 | 
			
		||||
      {
 | 
			
		||||
        name: 'should be valid with valid heading "like" line number fragment',
 | 
			
		||||
        fixturePath:
 | 
			
		||||
@@ -186,8 +225,15 @@ test("ensure the rule validates correctly", async (t) => {
 | 
			
		||||
 | 
			
		||||
    for (const { name, fixturePath } of testCases) {
 | 
			
		||||
      await t.test(name, async () => {
 | 
			
		||||
        const lintResults = await validateMarkdownLint(fixturePath)
 | 
			
		||||
        assert.equal(lintResults?.length, 0)
 | 
			
		||||
        const lintResults = (await validateMarkdownLint(fixturePath)) ?? []
 | 
			
		||||
        const errorsDetails = lintResults.map((result) => {
 | 
			
		||||
          return result.errorDetail
 | 
			
		||||
        })
 | 
			
		||||
        assert.equal(
 | 
			
		||||
          errorsDetails.length,
 | 
			
		||||
          0,
 | 
			
		||||
          `Expected no errors, got ${errorsDetails.join(", ")}`,
 | 
			
		||||
        )
 | 
			
		||||
      })
 | 
			
		||||
    }
 | 
			
		||||
  })
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user