refactor: . Fix Task/Task.ts > Scripting/TasksDate.ts cyclic dependency

Author: claremacrae

circular-deps.txt

@@ -1,17 +1,16 @@
-Processed 151 files (7.5s) (16 warnings)
+Processed 152 files (1s) (16 warnings)
 
 1) Config/Settings.ts > Suggestor/Suggestor.ts
 2) Task/Task.ts > Config/Settings.ts > Suggestor/Suggestor.ts
 3) Task/Task.ts > Config/Settings.ts > Suggestor/Suggestor.ts > TaskSerializer/DefaultTaskSerializer.ts
 4) Task/Task.ts > Config/Settings.ts > TaskSerializer/DataviewTaskSerializer.ts
-5) Task/Task.ts > Scripting/TasksDate.ts
-6) Task/Task.ts > Task/DateFallback.ts
-7) Task/Task.ts > Task/Urgency.ts
-8) Task/Task.ts > lib/LogTasksHelper.ts
-9) Query/Query.ts > Query/Explain/Explainer.ts
-10) Query/FilterParser.ts > Query/Filter/BooleanField.ts
-11) Statuses/StatusRegistryReport.ts > Statuses/StatusSettingsReport.ts
-12) main.ts > Config/SettingsTab.ts
-13) Obsidian/Cache.ts > Obsidian/TasksEvents.ts
-14) main.ts > Renderer/QueryRenderer.ts
+5) Task/Task.ts > Task/DateFallback.ts
+6) Task/Task.ts > Task/Urgency.ts
+7) Task/Task.ts > lib/LogTasksHelper.ts
+8) Query/Query.ts > Query/Explain/Explainer.ts
+9) Query/FilterParser.ts > Query/Filter/BooleanField.ts
+10) Statuses/StatusRegistryReport.ts > Statuses/StatusSettingsReport.ts
+11) main.ts > Config/SettingsTab.ts
+12) Obsidian/Cache.ts > Obsidian/TasksEvents.ts
+13) main.ts > Renderer/QueryRenderer.ts
 

src/Commands/CreateOrEditTaskParser.ts

@@ -1,11 +1,12 @@
 import { Status } from '../Statuses/Status';
-import { Task, TaskRegularExpressions } from '../Task/Task';
+import { Task } from '../Task/Task';
 import { DateFallback } from '../Task/DateFallback';
 import { StatusRegistry } from '../Statuses/StatusRegistry';
 import { TaskLocation } from '../Task/TaskLocation';
 import { getSettings } from '../Config/Settings';
 import { GlobalFilter } from '../Config/GlobalFilter';
 import { Priority } from '../Task/Priority';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 
 function getDefaultCreatedDate() {
     const { setCreatedDate } = getSettings();

src/Commands/ToggleDone.ts

@@ -1,8 +1,9 @@
 import { Editor, type EditorPosition, type MarkdownFileInfo, MarkdownView } from 'obsidian';
 import { StatusRegistry } from '../Statuses/StatusRegistry';
 
-import { Task, TaskRegularExpressions } from '../Task/Task';
+import { Task } from '../Task/Task';
 import { TaskLocation } from '../Task/TaskLocation';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 
 export const toggleDone = (checking: boolean, editor: Editor, view: MarkdownView | MarkdownFileInfo) => {
     if (checking) {

src/Renderer/TaskLineRenderer.ts

@@ -6,9 +6,9 @@ import { replaceTaskWithTasks } from '../Obsidian/File';
 import type { TaskLayoutComponent, TaskLayoutOptions } from '../Layout/TaskLayoutOptions';
 import type { QueryLayoutOptions } from '../Layout/QueryLayoutOptions';
 import type { Task } from '../Task/Task';
-import * as taskModule from '../Task/Task';
 import { StatusMenu } from '../ui/Menus/StatusMenu';
 import { StatusRegistry } from '../Statuses/StatusRegistry';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 import { TaskFieldRenderer } from './TaskFieldRenderer';
 
 /**
@@ -309,7 +309,7 @@ export class TaskLineRenderer {
             }
 
             function toTooltipDate({ signifier, date }: { signifier: string; date: Moment }): string {
-                return `${signifier} ${date.format(taskModule.TaskRegularExpressions.dateFormat)} (${date.from(
+                return `${signifier} ${date.format(TaskRegularExpressions.dateFormat)} (${date.from(
                     window.moment().startOf('day'),
                 )})`;
             }

src/Scripting/TasksDate.ts

@@ -1,7 +1,7 @@
 import type { DurationInputArg2, Moment, unitOfTime } from 'moment';
 import { Notice } from 'obsidian';
-import { TaskRegularExpressions } from '../Task/Task';
 import { PropertyCategory } from '../lib/PropertyCategory';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 
 /**
  * TasksDate encapsulates a date, for simplifying the JavaScript expressions users need to

src/Suggestor/Suggestor.ts

@@ -3,8 +3,9 @@ import { DateParser } from '../Query/DateParser';
 import { doAutocomplete } from '../lib/DateAbbreviations';
 import { Recurrence } from '../Task/Recurrence';
 import type { DefaultTaskSerializerSymbols } from '../TaskSerializer/DefaultTaskSerializer';
-import { Task, TaskRegularExpressions } from '../Task/Task';
+import { Task } from '../Task/Task';
 import { GlobalFilter } from '../Config/GlobalFilter';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 import type { SuggestInfo, SuggestionBuilder } from '.';
 
 /**

src/Task/Task.ts

@@ -15,70 +15,7 @@ import { Urgency } from './Urgency';
 import type { Recurrence } from './Recurrence';
 import type { TaskLocation } from './TaskLocation';
 import type { Priority } from './Priority';
-
-export class TaskRegularExpressions {
-    public static readonly dateFormat = 'YYYY-MM-DD';
-    public static readonly dateTimeFormat = 'YYYY-MM-DD HH:mm';
-
-    // Matches indentation before a list marker (including > for potentially nested blockquotes or Obsidian callouts)
-    public static readonly indentationRegex = /^([\s\t>]*)/;
-
-    // Matches - * and + list markers, or numbered list markers (eg 1.)
-    public static readonly listMarkerRegex = /([-*+]|[0-9]+\.)/;
-
-    // Matches a checkbox and saves the status character inside
-    public static readonly checkboxRegex = /\[(.)\]/u;
-
-    // Matches the rest of the task after the checkbox.
-    public static readonly afterCheckboxRegex = / *(.*)/u;
-
-    // Main regex for parsing a line. It matches the following:
-    // - Indentation
-    // - List marker
-    // - Status character
-    // - Rest of task after checkbox markdown
-    // See Task.extractTaskComponents() for abstraction around this regular expression.
-    // That is private for now, but could be made public in future if needed.
-    public static readonly taskRegex = new RegExp(
-        TaskRegularExpressions.indentationRegex.source +
-            TaskRegularExpressions.listMarkerRegex.source +
-            ' +' +
-            TaskRegularExpressions.checkboxRegex.source +
-            TaskRegularExpressions.afterCheckboxRegex.source,
-        'u',
-    );
-
-    // Used with the "Create or Edit Task" command to parse indentation and status if present
-    public static readonly nonTaskRegex = new RegExp(
-        TaskRegularExpressions.indentationRegex.source +
-            TaskRegularExpressions.listMarkerRegex.source +
-            '? *(' +
-            TaskRegularExpressions.checkboxRegex.source +
-            ')?' +
-            TaskRegularExpressions.afterCheckboxRegex.source,
-        'u',
-    );
-
-    // Used with "Toggle Done" command to detect a list item that can get a checkbox added to it.
-    public static readonly listItemRegex = new RegExp(
-        TaskRegularExpressions.indentationRegex.source + TaskRegularExpressions.listMarkerRegex.source,
-    );
-
-    // Match on block link at end.
-    public static readonly blockLinkRegex = / \^[a-zA-Z0-9-]+$/u;
-
-    // Regex to match all hash tags, basically hash followed by anything but the characters in the negation.
-    // To ensure URLs are not caught it is looking of beginning of string tag and any
-    // tag that has a space in front of it. Any # that has a character in front
-    // of it will be ignored.
-    // EXAMPLE:
-    // description: '#dog #car http://www/ddd#ere #house'
-    // matches: #dog, #car, #house
-    // MAINTENANCE NOTE:
-    //  If hashTags is modified, please update 'Recognising Tags' in Tags.md in the docs.
-    public static readonly hashTags = /(^|\s)#[^ !@#$%^&*(),.?":{}|<>]+/g;
-    public static readonly hashTagsFromEnd = new RegExp(this.hashTags.source + '$');
-}
+import { TaskRegularExpressions } from './TaskRegularExpressions';
 
 /**
  * Storage for the task line, broken down in to sections.

src/Task/TaskRegularExpressions.ts

@@ -0,0 +1,63 @@
+export class TaskRegularExpressions {
+    public static readonly dateFormat = 'YYYY-MM-DD';
+    public static readonly dateTimeFormat = 'YYYY-MM-DD HH:mm';
+
+    // Matches indentation before a list marker (including > for potentially nested blockquotes or Obsidian callouts)
+    public static readonly indentationRegex = /^([\s\t>]*)/;
+
+    // Matches - * and + list markers, or numbered list markers (eg 1.)
+    public static readonly listMarkerRegex = /([-*+]|[0-9]+\.)/;
+
+    // Matches a checkbox and saves the status character inside
+    public static readonly checkboxRegex = /\[(.)\]/u;
+
+    // Matches the rest of the task after the checkbox.
+    public static readonly afterCheckboxRegex = / *(.*)/u;
+
+    // Main regex for parsing a line. It matches the following:
+    // - Indentation
+    // - List marker
+    // - Status character
+    // - Rest of task after checkbox markdown
+    // See Task.extractTaskComponents() for abstraction around this regular expression.
+    // That is private for now, but could be made public in future if needed.
+    public static readonly taskRegex = new RegExp(
+        TaskRegularExpressions.indentationRegex.source +
+            TaskRegularExpressions.listMarkerRegex.source +
+            ' +' +
+            TaskRegularExpressions.checkboxRegex.source +
+            TaskRegularExpressions.afterCheckboxRegex.source,
+        'u',
+    );
+
+    // Used with the "Create or Edit Task" command to parse indentation and status if present
+    public static readonly nonTaskRegex = new RegExp(
+        TaskRegularExpressions.indentationRegex.source +
+            TaskRegularExpressions.listMarkerRegex.source +
+            '? *(' +
+            TaskRegularExpressions.checkboxRegex.source +
+            ')?' +
+            TaskRegularExpressions.afterCheckboxRegex.source,
+        'u',
+    );
+
+    // Used with "Toggle Done" command to detect a list item that can get a checkbox added to it.
+    public static readonly listItemRegex = new RegExp(
+        TaskRegularExpressions.indentationRegex.source + TaskRegularExpressions.listMarkerRegex.source,
+    );
+
+    // Match on block link at end.
+    public static readonly blockLinkRegex = / \^[a-zA-Z0-9-]+$/u;
+
+    // Regex to match all hash tags, basically hash followed by anything but the characters in the negation.
+    // To ensure URLs are not caught it is looking of beginning of string tag and any
+    // tag that has a space in front of it. Any # that has a character in front
+    // of it will be ignored.
+    // EXAMPLE:
+    // description: '#dog #car http://www/ddd#ere #house'
+    // matches: #dog, #car, #house
+    // MAINTENANCE NOTE:
+    //  If hashTags is modified, please update 'Recognising Tags' in Tags.md in the docs.
+    public static readonly hashTags = /(^|\s)#[^ !@#$%^&*(),.?":{}|<>]+/g;
+    public static readonly hashTagsFromEnd = new RegExp(this.hashTags.source + '$');
+}

src/TaskSerializer/DefaultTaskSerializer.ts

@@ -1,8 +1,9 @@
 import type { Moment } from 'moment';
 import { type TaskLayoutComponent, TaskLayoutOptions } from '../Layout/TaskLayoutOptions';
 import { Recurrence } from '../Task/Recurrence';
-import { Task, TaskRegularExpressions } from '../Task/Task';
+import { Task } from '../Task/Task';
 import { Priority } from '../Task/Priority';
+import { TaskRegularExpressions } from '../Task/TaskRegularExpressions';
 import type { TaskDetails, TaskSerializer } from '.';
 
 /* Interface describing the symbols that {@link DefaultTaskSerializer}

tests/CustomMatchers/CustomMatchersForTaskSerializer.ts

@@ -2,9 +2,9 @@ import { diff } from 'jest-diff';
 import type { MatcherFunction } from 'expect';
 import moment from 'moment';
 import type { TaskDetails } from '../../src/TaskSerializer';
-import { TaskRegularExpressions } from '../../src/Task/Task';
 import { Recurrence } from '../../src/Task/Recurrence';
 import { Priority } from '../../src/Task/Priority';
+import { TaskRegularExpressions } from '../../src/Task/TaskRegularExpressions';
 
 declare global {
     namespace jest {