Merge pull request #1007 from pjkaufman/master

Fix `Re-Index Footnotes` Not Working for Markdown Link Values
platers · Feb 1, 2024 · 4a0724a · 4a0724a
2 parents 4cd434c + 83ada15
commit 4a0724a
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 2 deletions.
diff --git a/__tests__/move-footnotes-to-the-bottom.test.ts b/__tests__/move-footnotes-to-the-bottom.test.ts
@@ -274,5 +274,36 @@ ruleTest({
         [^3]: D
       `,
     },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/1006
+      testName: 'Moving footnotes to the bottom of the file should properly order values even when links are present',
+      before: dedent`
+        Paragraph 1. [^4]
+        ${''}
+        Paragraph 2. [^1]
+        ${''}
+        Paragraph 3. [^2]
+        ${''}
+        Paragraph 4. [^3]
+        ${''}
+        [^1]: [1111](111)
+        [^2]: [2222](222)
+        [^3]: [3333](333)
+        [^4]: [4444](4444)
+      `,
+      after: dedent`
+        Paragraph 1. [^4]
+        ${''}
+        Paragraph 2. [^1]
+        ${''}
+        Paragraph 3. [^2]
+        ${''}
+        Paragraph 4. [^3]
+        ${''}
+        [^4]: [4444](4444)
+        [^1]: [1111](111)
+        [^2]: [2222](222)
+        [^3]: [3333](333)
+      `,
+    },
   ],
 });
diff --git a/__tests__/re-index-footnotes.test.ts b/__tests__/re-index-footnotes.test.ts
@@ -93,6 +93,36 @@ ruleTest({
         More text.
       `,
     },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/1006
+      testName: 'Re-indexing footnotes with links as the referenced values should keep the references to text correlation',
+      before: dedent`
+        Paragraph 1. [^4]
+        ${''}
+        Paragraph 2. [^1]
+        ${''}
+        Paragraph 3. [^2]
+        ${''}
+        Paragraph 4. [^3]
+        ${''}
+        [^4]: [4444](4444)
+        [^1]: [1111](111)
+        [^2]: [2222](222)
+        [^3]: [3333](333)
+      `,
+      after: dedent`
+        Paragraph 1. [^1]
+        ${''}
+        Paragraph 2. [^2]
+        ${''}
+        Paragraph 3. [^3]
+        ${''}
+        Paragraph 4. [^4]
+        ${''}
+        [^1]: [4444](4444)
+        [^2]: [1111](111)
+        [^3]: [2222](222)
+        [^4]: [3333](333)
+      `,
+    },
   ],
 });
-
diff --git a/src/rules/re-index-footnotes.ts b/src/rules/re-index-footnotes.ts
@@ -13,7 +13,7 @@ export default class ReIndexFootnotes extends RuleBuilder<ReIndexFootnotesOption
       nameKey: 'rules.re-index-footnotes.name',
       descriptionKey: 'rules.re-index-footnotes.description',
       type: RuleType.FOOTNOTE,
-      ruleIgnoreTypes: [IgnoreTypes.code, IgnoreTypes.inlineCode, IgnoreTypes.math, IgnoreTypes.yaml, IgnoreTypes.link, IgnoreTypes.wikiLink, IgnoreTypes.tag],
+      ruleIgnoreTypes: [IgnoreTypes.code, IgnoreTypes.inlineCode, IgnoreTypes.math, IgnoreTypes.yaml, IgnoreTypes.tag],
     });
   }
   get OptionsClass(): new () => ReIndexFootnotesOptions {