Merge pull request #1001 from pjkaufman/master

Fix Custom Table Parser Not Respecting Escaped Pipes
platers · Jan 27, 2024 · 5ed5733 · 5ed5733
2 parents d3515fe + e695410
commit 5ed5733
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 2 deletions.
diff --git a/__tests__/get-all-tables-in-text.test.ts b/__tests__/get-all-tables-in-text.test.ts
@@ -198,7 +198,7 @@ const getTablesInTextTestCases: tablesInTextTestCase[] = [
       ---
       date: 06/16/2022
       type: topic
-      tags: 
+      tags:
       keywords: []
       status: WIP
       ---
@@ -218,6 +218,20 @@ const getTablesInTextTestCases: tablesInTextTestCase[] = [
     expectedTablesInText: 0,
     expectedPositions: [],
   },
+  { // accounts for https://github.com/platers/obsidian-linter/issues/999
+    name: 'handle tables with a escaped pipes in them',
+    text: dedent`
+      | 1 | 2 |
+      | --- | --- |
+      | 3 | 4 |
+
+      | [[2024-01-25\\|Thursday]] | [[2024-01-26\\|Friday]] |
+      | --- | --- |
+      | 3 | 4 |
+    `,
+    expectedTablesInText: 2,
+    expectedPositions: [{startIndex: 35, endIndex: 112}, {startIndex: 0, endIndex: 33}],
+  },
 ];
 
 describe('Get All Tables in Text', () => {

diff --git a/__tests__/paragraph-blank-lines.test.ts b/__tests__/paragraph-blank-lines.test.ts
@@ -390,5 +390,26 @@ ruleTest({
         [^5]: D
       `,
     },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/999
+      testName: 'Make sure that tables with escaped pipes in them are ignored',
+      before: dedent`
+        | 1 | 2 |
+        | --- | --- |
+        | 3 | 4 |
+
+        | [[2024-01-25\\|Thursday]] | [[2024-01-26\\|Friday]] |
+        | --- | --- |
+        | 3 | 4 |
+      `,
+      after: dedent`
+        | 1 | 2 |
+        | --- | --- |
+        | 3 | 4 |
+
+        | [[2024-01-25\\|Thursday]] | [[2024-01-26\\|Friday]] |
+        | --- | --- |
+        | 3 | 4 |
+      `,
+    },
   ],
 });
diff --git a/src/utils/mdast.ts b/src/utils/mdast.ts
@@ -909,7 +909,7 @@ export function getAllTablesInText(text: string): {startIndex: number, endIndex:
 
     // if the delimiter row and the first row do not have the same amount of cells,
     // we are not dealing with a table
-    if (firstLine.split('|').length !== delimiterLine.split('|').length) {
+    if (countTableDelimiters(firstLine) !== countTableDelimiters(delimiterLine)) {
       continue;
     }
 
@@ -958,6 +958,29 @@ function isInvalidTableSeparatorRow(fullRow: string, separatorMatch: string): bo
   return /[^\s>]/.test(nonSeparatorContent);
 }
 
+function countTableDelimiters(line: string): number {
+  let previousCharIsEscapeChar = false;
+  let numEscapeCharsInARow = 0;
+  let numDelimiters = 0;
+  let currentChar = '';
+  for (let i = 0; i < line.length; i++) {
+    currentChar = line[i];
+    if (currentChar === '\\') {
+      numEscapeCharsInARow++;
+      previousCharIsEscapeChar = numEscapeCharsInARow % 2 == 1;
+    } else {
+      numEscapeCharsInARow = 0;
+      if (currentChar === '|' && !previousCharIsEscapeChar) {
+        numDelimiters++;
+      }
+
+      previousCharIsEscapeChar = false;
+    }
+  }
+
+  return numDelimiters;
+}
+
 export function getAllCustomIgnoreSectionsInText(text: string): {startIndex: number, endIndex: number}[] {
   let iteratorIndex = 0;