Merge pull request #3426 from ilandikov/refactor-prepare-includes

refactor: prepare includes

Author: claremacrae

src/Config/Settings.ts

@@ -61,6 +61,7 @@ export const TASK_FORMATS = {
 export type TASK_FORMATS = typeof TASK_FORMATS; // For convenience to make some typing easier
 
 export interface Settings {
+    includes: Record<string, string>;
     globalQuery: string;
     globalFilter: string;
     removeGlobalFilter: boolean;
@@ -96,6 +97,7 @@ export interface Settings {
 }
 
 const defaultSettings: Settings = {
+    includes: {},
     globalQuery: '',
     globalFilter: '',
     removeGlobalFilter: false,

src/Scripting/QueryContext.ts

@@ -1,3 +1,4 @@
+import { getSettings } from '../Config/Settings';
 import type { Task } from '../Task/Task';
 import type { TasksFile } from './TasksFile';
 
@@ -24,6 +25,7 @@ export interface QueryContext {
         allTasks: Readonly<Task[]>;
         searchCache: Record<string, any>; // Added caching capability
     };
+    includes: Record<string, string>;
 }
 
 /**
@@ -57,5 +59,6 @@ export function makeQueryContextWithTasks(tasksFile: TasksFile, allTasks: Readon
             allTasks: allTasks,
             searchCache: {}, // Added for caching
         },
+        includes: { ...getSettings().includes },
     };
 }

tests/Scripting/Includes.test.ts

@@ -0,0 +1,28 @@
+import { getSettings, resetSettings, updateSettings } from '../../src/Config/Settings';
+import { Query } from '../../src/Query/Query';
+import { TasksFile } from '../../src/Scripting/TasksFile';
+
+afterEach(() => {
+    resetSettings();
+});
+
+describe('include tests', () => {
+    it('should accept whole-line include placeholder', () => {
+        updateSettings({ includes: { not_done: 'not done' } });
+
+        const source = '{{includes.not_done}}';
+        const query = new Query(source, new TasksFile('stuff.md'));
+
+        expect(query.error).toBeUndefined();
+        expect(query.filters.length).toEqual(1);
+        expect(query.filters[0].statement.anyPlaceholdersExpanded).toEqual('not done');
+    });
+});
+
+describe('include settings tests', () => {
+    it('should have an empty include field', () => {
+        const settings = getSettings();
+
+        expect(settings.includes).toEqual({});
+    });
+});