Merge pull request #2607 from obsidian-tasks-group/tidy-src-and-tests

refactor: Rearrange src/ and tests/ so structure is easier to see

Author: claremacrae

contributing/Code/How do I add a new field to the Task class.md

@@ -17,19 +17,19 @@ For example, It's fine to have a first release of a feature without `sort by` an
 
 ### Store the field
 
-- Add the field to [src/Task.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Task.ts)
+- Add the field to [src/Task/Task.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Task/Task.ts)
 
 ### Read and write the field
 
 - Update all supported formats in [src/TaskSerializer/](https://github.com/obsidian-tasks-group/obsidian-tasks/tree/main/src/TaskSerializer)
 
 ### Detect edits to field value
 
-- In [tests/Task.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Task.test.ts):
+- In [tests/Task/Task.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Task/Task.test.ts):
   - Add a new failing block to the `'identicalTo'` section.
   - Here is an existing example: ['should check path'](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/5b0831c36a80c4cde2d64a6cd281bb4b51e9a142/tests/Task.test.ts#L834-L840).
-- In [src/Task.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Task.ts), update `Task.identicalTo()`:
-  - Once you have a failing test in [tests/Task.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Task.test.ts), implement the check for changed value of your new field in `Task.identicalTo()`.
+- In [src/Task/Task.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Task/Task.ts), update `Task.identicalTo()`:
+  - Once you have a failing test in [tests/Task/Task.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Task/Task.test.ts), implement the check for changed value of your new field in `Task.identicalTo()`.
   - This important method is used to detect whether any edits of any kind have been made to a task, to detect whether task block results need to be updated.
   - Here is the code for the method as of 2022-11-12:
     - [Task.identicalTo() in 5b0831c36a80c4cde2d64a6cd281bb4b51e9a142](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/5b0831c36a80c4cde2d64a6cd281bb4b51e9a142/src/Task.ts#L732-L802)
@@ -70,4 +70,4 @@ Can be added in later releases
   - Update `dates.md`
 - Handling invalid dates
   - Add the new field to all sections of [resources/sample_vaults/Tasks-Demo/Manual Testing/Invalid Dates.md](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/resources/sample_vaults/Tasks-Demo/Manual%20Testing/Invalid%20Dates.md)
-  - Update the query in the 'invalid dates' section of [docs/queries/filters.md](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/docs/queries/filters.md)
+  - Update the query in the 'invalid dates' section of [docs/Queries/Filters.md](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/docs/Queries/Filters.md)

contributing/Code/How do I add a new task filter.md

@@ -27,7 +27,7 @@ For help on writing and running the tests, see [[About Testing]]
 - Add to [tests/Query/Filter](https://github.com/obsidian-tasks-group/obsidian-tasks/tree/main/tests/Query/Filter) a new test file.
   - This should focus on testing whether or not individual Task objects, with carefully selected sample date, match the filter.
   - Think about edge cases.
-- Add the new instruction(s) to  'Query parsing' test in  [tests/Query.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Query.test.ts)
+- Add the new instruction(s) to  'Query parsing' test in  [tests/Query/Query.test.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/tests/Query/Query.test.ts)
   - This verifies that the new filter instruction has been correctly wired in to the Query class.
 
 ## Update doc/

contributing/Code/How does Tasks handle status changes.md

@@ -5,8 +5,8 @@ You can toggle a task‘s status by:
 | #   | User mechanism                                                                                | Source-code location                                                                                                                                                                                                                                | Toggle behaviour                                                                                                                                                                                                                                                            |
 | --- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 1   | using the **command** (may be bound to a hotkey).                                             | [src/Commands/ToggleDone.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Commands/ToggleDone.ts)                                                                                                                           | toggles the line directly where the cursor is in the file inside Obsidian's vault.                                                                                                                                                                                          |
-| 2   | clicking on a checkbox of an **inline task** in **Live Preview**.                             | [src/LivePreviewExtension.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/LivePreviewExtension.ts)                                                                                                                         | toggles the line directly where the checkbox is on the "document" of CodeMirror (the library that Obsidian uses to show text on screen).<br>That, in turn, updates the file in Obsidian's Vault.                                                                            |
-| 3   | clicking on a checkbox of an **inline task** in **Reading mode**.                             | uses a checkbox created by `renderTaskLine()` in [src/TaskLineRenderer](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/TaskLineRenderer.ts).<br>There, the checkbox gets a click event handler.                               | The click event listener of 3. and 4. uses `replaceTaskWithTasks()` in [src/File.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/File.ts).<br>That, in turn, updates the file in Obsidian‘s Vault (like 1, but it needs to find the correct line). |
+| 2   | clicking on a checkbox of an **inline task** in **Live Preview**.                             | [src/Obsidian/LivePreviewExtension.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Obsidian/LivePreviewExtension.ts)                                                                                                                         | toggles the line directly where the checkbox is on the "document" of CodeMirror (the library that Obsidian uses to show text on screen).<br>That, in turn, updates the file in Obsidian's Vault.                                                                            |
+| 3   | clicking on a checkbox of an **inline task** in **Reading mode**.                             | uses a checkbox created by `renderTaskLine()` in [src/Renderer/TaskLineRenderer](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Renderer/TaskLineRenderer.ts).<br>There, the checkbox gets a click event handler.                               | The click event listener of 3. and 4. uses `replaceTaskWithTasks()` in [src/Obsidian/File.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Obsidian/File.ts).<br>That, in turn, updates the file in Obsidian‘s Vault (like 1, but it needs to find the correct line). |
 | 4   | clicking on a checkbox in **query results** (same for **Reading mode** and **Live Preview**). | As 3                                                                                                                                                                                                                                                | As 3                                                                                                                                                                                                                                                                        |
 | 5   | via 'Create or edit task' **modal** Status dropdown                                           | [src/ui/EditTask.svelte](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/ui/EditTask.svelte) and [src/Commands/CreateOrEdit.ts](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/src/Commands/CreateOrEdit.ts) | Not yet implemented: see [#1590](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/1590)                                                                                                                                                                        |
 

src/Api/createTaskLineModal.ts

@@ -1,5 +1,5 @@
 import type { App } from 'obsidian';
-import type { Task } from '../Task';
+import type { Task } from '../Task/Task';
 
 /**
  * Interface to remove all references to {TaskModal} in this file.

src/Api/createTaskLineModalHelper.ts

@@ -1,7 +1,7 @@
 import type { App } from 'obsidian';
-import type { Task } from '../Task';
+import type { Task } from '../Task/Task';
 import { taskFromLine } from '../Commands/CreateOrEditTaskParser';
-import { TaskModal } from '../TaskModal';
+import { TaskModal } from '../Obsidian/TaskModal';
 import type { ITaskModal, taskModalFactory } from './createTaskLineModal';
 
 /**

src/Commands/CreateOrEdit.ts

@@ -1,7 +1,7 @@
 import { App, Editor, MarkdownView, View } from 'obsidian';
-import { TaskModal } from '../TaskModal';
-import type { Task } from '../Task';
-import { DateFallback } from '../DateFallback';
+import { TaskModal } from '../Obsidian/TaskModal';
+import type { Task } from '../Task/Task';
+import { DateFallback } from '../Task/DateFallback';
 import { taskFromLine } from './CreateOrEditTaskParser';
 
 export const createOrEdit = (checking: boolean, editor: Editor, view: View, app: App, allTasks: Task[]) => {

src/Commands/CreateOrEditTaskParser.ts

@@ -1,8 +1,8 @@
-import { Status } from '../Status';
-import { Priority, Task, TaskRegularExpressions } from '../Task';
-import { DateFallback } from '../DateFallback';
-import { StatusRegistry } from '../StatusRegistry';
-import { TaskLocation } from '../TaskLocation';
+import { Status } from '../Statuses/Status';
+import { Priority, Task, TaskRegularExpressions } 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';
 

src/Commands/ToggleDone.ts

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

src/Config/CustomStatusModal.ts

@@ -1,8 +1,8 @@
 import { Modal, Notice, Setting, TextComponent } from 'obsidian';
 import type { Plugin } from 'obsidian';
-import { StatusConfiguration, StatusType } from '../StatusConfiguration';
-import { StatusValidator } from '../StatusValidator';
-import { Status } from '../Status';
+import { StatusConfiguration, StatusType } from '../Statuses/StatusConfiguration';
+import { StatusValidator } from '../Statuses/StatusValidator';
+import { Status } from '../Statuses/Status';
 
 const validator = new StatusValidator();
 

src/Config/Settings.ts

@@ -5,8 +5,8 @@ import {
 } from '../Suggestor/Suggestor';
 import { DEFAULT_SYMBOLS } from '../TaskSerializer/DefaultTaskSerializer';
 import { DATAVIEW_SYMBOLS } from '../TaskSerializer/DataviewTaskSerializer';
-import { StatusConfiguration } from '../StatusConfiguration';
-import { Status } from '../Status';
+import { StatusConfiguration } from '../Statuses/StatusConfiguration';
+import { Status } from '../Statuses/Status';
 import { DefaultTaskSerializer, type TaskSerializer } from '../TaskSerializer';
 import type { SuggestionBuilder } from '../Suggestor';
 import type { LogOptions } from '../lib/logging';