Merge pull request #3193 from obsidian-tasks-group/fix-variant-selectors

fix: Handle any hidden VS16 character on all emojis

Author: claremacrae

src/TaskSerializer/DefaultTaskSerializer.ts

@@ -60,10 +60,13 @@ function dateFieldRegex(symbols: string) {
 }
 
 function fieldRegex(symbols: string, valueRegexString: string) {
-    let source = symbols;
+    // \uFE0F? allows an optional Variant Selector 16 on emojis.
+    let source = symbols + '\uFE0F?';
     if (valueRegexString !== '') {
         source += ' *' + valueRegexString;
     }
+    // The regexes end with `$` because they will be matched and
+    // removed from the end until none are left.
     source += '$';
     return new RegExp(source, 'u');
 }
@@ -93,10 +96,7 @@ export const DEFAULT_SYMBOLS: DefaultTaskSerializerSymbols = {
     dependsOnSymbol: '⛔',
     idSymbol: '🆔',
     TaskFormatRegularExpressions: {
-        // The following regex's end with `$` because they will be matched and
-        // removed from the end until none are left.
-        // \uFE0F? allows an optional Variant Selector 16 on emojis.
-        priorityRegex: fieldRegex('([🔺⏫🔼🔽⏬])\uFE0F?', ''),
+        priorityRegex: fieldRegex('([🔺⏫🔼🔽⏬])', ''),
         startDateRegex: dateFieldRegex('🛫'),
         createdDateRegex: dateFieldRegex('➕'),
         scheduledDateRegex: dateFieldRegex('[⏳⌛]'),
@@ -105,7 +105,7 @@ export const DEFAULT_SYMBOLS: DefaultTaskSerializerSymbols = {
         cancelledDateRegex: dateFieldRegex('❌'),
         recurrenceRegex: fieldRegex('🔁', '([a-zA-Z0-9, !]+)'),
         onCompletionRegex: fieldRegex('🏁', '([a-zA-Z]+)'),
-        dependsOnRegex: fieldRegex('⛔\uFE0F?', '(' + taskIdSequenceRegex.source + ')'),
+        dependsOnRegex: fieldRegex('⛔', '(' + taskIdSequenceRegex.source + ')'),
         idRegex: fieldRegex('🆔', '(' + taskIdRegex.source + ')'),
     },
 } as const;

tests/TaskSerializer/DefaultTaskSerializer.test.ts

@@ -66,16 +66,16 @@ describe('validate emoji regular expressions', () => {
         expect(generateRegexApprovalTest()).toMatchInlineSnapshot(`
             "
             priorityRegex: /([🔺⏫🔼🔽⏬])\\ufe0f?$/u
-            startDateRegex: /🛫 *(\\d{4}-\\d{2}-\\d{2})$/u
-            createdDateRegex: /➕ *(\\d{4}-\\d{2}-\\d{2})$/u
-            scheduledDateRegex: /[⏳⌛] *(\\d{4}-\\d{2}-\\d{2})$/u
-            dueDateRegex: /[📅📆🗓] *(\\d{4}-\\d{2}-\\d{2})$/u
-            doneDateRegex: /✅ *(\\d{4}-\\d{2}-\\d{2})$/u
-            cancelledDateRegex: /❌ *(\\d{4}-\\d{2}-\\d{2})$/u
-            recurrenceRegex: /🔁 *([a-zA-Z0-9, !]+)$/u
-            onCompletionRegex: /🏁 *([a-zA-Z]+)$/u
+            startDateRegex: /🛫\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            createdDateRegex: /➕\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            scheduledDateRegex: /[⏳⌛]\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            dueDateRegex: /[📅📆🗓]\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            doneDateRegex: /✅\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            cancelledDateRegex: /❌\\ufe0f? *(\\d{4}-\\d{2}-\\d{2})$/u
+            recurrenceRegex: /🔁\\ufe0f? *([a-zA-Z0-9, !]+)$/u
+            onCompletionRegex: /🏁\\ufe0f? *([a-zA-Z]+)$/u
             dependsOnRegex: /⛔\\ufe0f? *([a-zA-Z0-9-_]+( *, *[a-zA-Z0-9-_]+ *)*)$/u
-            idRegex: /🆔 *([a-zA-Z0-9-_]+)$/u
+            idRegex: /🆔\\ufe0f? *([a-zA-Z0-9-_]+)$/u
             "
         `);
     });
@@ -122,6 +122,15 @@ describe.each(symbolMap)("DefaultTaskSerializer with '$taskFormat' symbols", ({
                 expect(taskDetails).toMatchTaskDetails({ ['scheduledDate']: moment('2021-06-20', 'YYYY-MM-DD') });
             });
 
+            it('should parse a scheduledDate - with Variation Selector', () => {
+                // This test showed the existence of https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3179
+                const input = '⏳️ 2024-11-18';
+                expect(hasVariantSelector16(input)).toBe(true);
+
+                const taskDetails = deserialize(input);
+                expect(taskDetails).toMatchTaskDetails({ ['scheduledDate']: moment('2024-11-18', 'YYYY-MM-DD') });
+            });
+
             it('should parse a dueDate - with non-standard emoji 1', () => {
                 const taskDetails = deserialize('📆 2021-06-20');
                 expect(taskDetails).toMatchTaskDetails({ ['dueDate']: moment('2021-06-20', 'YYYY-MM-DD') });