feat: All tasks are now accessible in scripting, as query.allTasks

Author: claremacrae

src/Query/SearchInfo.ts

@@ -1,5 +1,5 @@
 import type { Task } from '../Task/Task';
-import { type QueryContext, makeQueryContext } from '../Scripting/QueryContext';
+import { type QueryContext, makeQueryContextWithTasks } from '../Scripting/QueryContext';
 
 /**
  * SearchInfo contains selected data passed in from the {@link Query} being executed.
@@ -30,6 +30,6 @@ export class SearchInfo {
      * @return A QueryContext, or undefined if the path to the query file is unknown.
      */
     public queryContext(): QueryContext | undefined {
-        return this.queryPath ? makeQueryContext(this.queryPath) : undefined;
+        return this.queryPath ? makeQueryContextWithTasks(this.queryPath, this.allTasks) : undefined;
     }
 }

src/Scripting/QueryContext.ts

@@ -1,3 +1,4 @@
+import type { Task } from '../Task/Task';
 import { TasksFile } from './TasksFile';
 
 /**
@@ -18,6 +19,7 @@ import { TasksFile } from './TasksFile';
 export interface QueryContext {
     query: {
         file: TasksFile;
+        allTasks: Readonly<Task[]>;
     };
 }
 
@@ -32,6 +34,17 @@ export function makeQueryContext(path: string): QueryContext {
     return {
         query: {
             file: tasksFile,
+            allTasks: [],
+        },
+    };
+}
+
+export function makeQueryContextWithTasks(path: string, allTasks: Readonly<Task[]>): QueryContext {
+    const tasksFile = new TasksFile(path);
+    return {
+        query: {
+            file: tasksFile,
+            allTasks: allTasks,
         },
     };
 }

tests/Scripting/QueryContext.test.ts

@@ -4,6 +4,8 @@ import { FolderField } from '../../src/Query/Filter/FolderField';
 import { PathField } from '../../src/Query/Filter/PathField';
 import { RootField } from '../../src/Query/Filter/RootField';
 import { makeQueryContext } from '../../src/Scripting/QueryContext';
+import { FunctionField } from '../../src/Query/Filter/FunctionField';
+import { SearchInfo } from '../../src/Query/SearchInfo';
 
 describe('QueryContext', () => {
     describe('values should all match their corresponding filters', () => {
@@ -34,5 +36,20 @@ describe('QueryContext', () => {
             const filter = new FilenameField().createFilterOrErrorMessage(instruction);
             expect(filter).toMatchTask(task);
         });
+
+        it('allTasks', () => {
+            // Arrange
+            // An artificial example, just to demonstrate that query.allTasks is accessible via scripting
+            const instruction = 'group by function query.allTasks.length';
+            const grouper = new FunctionField().createGrouperFromLine(instruction);
+            expect(grouper).not.toBeNull();
+            const searchInfo = new SearchInfo(path, [task]);
+
+            // Act
+            const group: string[] = grouper!.grouper(task, searchInfo);
+
+            // Assert
+            expect(group).toEqual(['1']);
+        });
     });
 });