refactor: Rename some symbols to dependsOn... in Serializer code

Author: claremacrae

src/TaskSerializer/DataviewTaskSerializer.ts

@@ -76,7 +76,7 @@ export const DATAVIEW_SYMBOLS = {
     cancelledDateSymbol: 'cancelled::',
     recurrenceSymbol: 'repeat::',
     idSymbol: 'id::',
-    blockedBySymbol: 'blockedBy::',
+    dependsOnSymbol: 'blockedBy::',
     TaskFormatRegularExpressions: {
         priorityRegex: toInlineFieldRegex(/priority:: *(highest|high|medium|low|lowest)/),
         startDateRegex: toInlineFieldRegex(/start:: *(\d{4}-\d{2}-\d{2})/),
@@ -86,7 +86,7 @@ export const DATAVIEW_SYMBOLS = {
         doneDateRegex: toInlineFieldRegex(/completion:: *(\d{4}-\d{2}-\d{2})/),
         cancelledDateRegex: toInlineFieldRegex(/cancelled:: *(\d{4}-\d{2}-\d{2})/),
         recurrenceRegex: toInlineFieldRegex(/repeat:: *([a-zA-Z0-9, !]+)/),
-        blockedByRegex: toInlineFieldRegex(/blockedBy:: *([a-z0-9]+( *, *[a-z0-9]+ *)*)$/),
+        dependsOnRegex: toInlineFieldRegex(/blockedBy:: *([a-z0-9]+( *, *[a-z0-9]+ *)*)$/),
         idRegex: toInlineFieldRegex(/id:: *([a-z0-9]+)/),
     },
 } as const;

src/TaskSerializer/DefaultTaskSerializer.ts

@@ -30,7 +30,7 @@ export interface DefaultTaskSerializerSymbols {
     readonly cancelledDateSymbol: string;
     readonly recurrenceSymbol: string;
     readonly idSymbol: string;
-    readonly blockedBySymbol: string;
+    readonly dependsOnSymbol: string;
     readonly TaskFormatRegularExpressions: {
         priorityRegex: RegExp;
         startDateRegex: RegExp;
@@ -41,7 +41,7 @@ export interface DefaultTaskSerializerSymbols {
         cancelledDateRegex: RegExp;
         recurrenceRegex: RegExp;
         idRegex: RegExp;
-        blockedByRegex: RegExp;
+        dependsOnRegex: RegExp;
     };
 }
 
@@ -66,7 +66,7 @@ export const DEFAULT_SYMBOLS: DefaultTaskSerializerSymbols = {
     doneDateSymbol: '✅',
     cancelledDateSymbol: '❌',
     recurrenceSymbol: '🔁',
-    blockedBySymbol: '⛔️',
+    dependsOnSymbol: '⛔️',
     idSymbol: '🆔',
     TaskFormatRegularExpressions: {
         // The following regex's end with `$` because they will be matched and
@@ -79,7 +79,7 @@ export const DEFAULT_SYMBOLS: DefaultTaskSerializerSymbols = {
         doneDateRegex: /✅ *(\d{4}-\d{2}-\d{2})$/u,
         cancelledDateRegex: /❌ *(\d{4}-\d{2}-\d{2})$/u,
         recurrenceRegex: /🔁 ?([a-zA-Z0-9, !]+)$/iu,
-        blockedByRegex: /⛔️ *([a-z0-9]+( *, *[a-z0-9]+ *)*)$/iu,
+        dependsOnRegex: /⛔️ *([a-z0-9]+( *, *[a-z0-9]+ *)*)$/iu,
         idRegex: /🆔 *([a-z0-9]+)$/iu,
     },
 } as const;
@@ -130,7 +130,7 @@ export class DefaultTaskSerializer implements TaskSerializer {
             cancelledDateSymbol,
             recurrenceSymbol,
             dueDateSymbol,
-            blockedBySymbol,
+            dependsOnSymbol,
             idSymbol,
         } = this.symbols;
 
@@ -172,7 +172,7 @@ export class DefaultTaskSerializer implements TaskSerializer {
                 return symbolAndStringValue(shortMode, recurrenceSymbol, task.recurrence.toText());
             case TaskLayoutComponent.BlockedBy: {
                 if (task.blockedBy.length === 0) return '';
-                return symbolAndStringValue(shortMode, blockedBySymbol, task.blockedBy.join(','));
+                return symbolAndStringValue(shortMode, dependsOnSymbol, task.blockedBy.join(','));
             }
             case TaskLayoutComponent.Id:
                 return symbolAndStringValue(shortMode, idSymbol, task.id);
@@ -233,7 +233,7 @@ export class DefaultTaskSerializer implements TaskSerializer {
         let recurrenceRule: string = '';
         let recurrence: Recurrence | null = null;
         let id: string = '';
-        let blockedBy: string[] | [] = [];
+        let dependsOn: string[] | [] = [];
         // Tags that are removed from the end while parsing, but we want to add them back for being part of the description.
         // In the original task description they are possibly mixed with other components
         // (e.g. #tag1 <due date> #tag2), they do not have to all trail all task components,
@@ -323,11 +323,11 @@ export class DefaultTaskSerializer implements TaskSerializer {
                 matched = true;
             }
 
-            const blockedByMatch = line.match(TaskFormatRegularExpressions.blockedByRegex);
+            const dependsOnMatch = line.match(TaskFormatRegularExpressions.dependsOnRegex);
 
-            if (blockedByMatch != null) {
-                line = line.replace(TaskFormatRegularExpressions.blockedByRegex, '').trim();
-                blockedBy = blockedByMatch[1]
+            if (dependsOnMatch != null) {
+                line = line.replace(TaskFormatRegularExpressions.dependsOnRegex, '').trim();
+                dependsOn = dependsOnMatch[1]
                     .replace(' ', '')
                     .split(',')
                     .filter((item) => item !== '');
@@ -364,7 +364,7 @@ export class DefaultTaskSerializer implements TaskSerializer {
             cancelledDate,
             recurrence,
             id,
-            blockedBy,
+            blockedBy: dependsOn,
             tags: Task.extractHashtags(line),
         };
     }

tests/TaskSerializer/DefaultTaskSerializer.test.ts

@@ -33,7 +33,7 @@ describe.each(symbolMap)("DefaultTaskSerializer with '$taskFormat' symbols", ({
         dueDateSymbol,
         doneDateSymbol,
         idSymbol,
-        blockedBySymbol,
+        dependsOnSymbol,
     } = symbols;
 
     describe('deserialize', () => {
@@ -73,13 +73,13 @@ describe.each(symbolMap)("DefaultTaskSerializer with '$taskFormat' symbols", ({
         });
 
         it('should parse depends on one task', () => {
-            const id = `${blockedBySymbol} 123456`;
+            const id = `${dependsOnSymbol} 123456`;
             const taskDetails = deserialize(id);
             expect(taskDetails).toMatchTaskDetails({ blockedBy: ['123456'] });
         });
 
         it('should parse depends on two tasks', () => {
-            const id = `${blockedBySymbol} 123456,abc123`;
+            const id = `${dependsOnSymbol} 123456,abc123`;
             const taskDetails = deserialize(id);
             expect(taskDetails).toMatchTaskDetails({ blockedBy: ['123456', 'abc123'] });
         });
@@ -141,7 +141,7 @@ describe.each(symbolMap)("DefaultTaskSerializer with '$taskFormat' symbols", ({
         it('should serialize depends on', () => {
             const task = new TaskBuilder().description('').dependsOn(['123456', 'abc123']).build();
             const serialized = serialize(task);
-            expect(serialized).toEqual(` ${blockedBySymbol} 123456,abc123`);
+            expect(serialized).toEqual(` ${dependsOnSymbol} 123456,abc123`);
         });
 
         it('should serialize id', () => {