Merge pull request #3450 from obsidian-tasks-group/fix-continuations-in-placeholders

fix: Support line continuations in TQ_extra_instructions & placeholders

Author: claremacrae

docs/Queries/Query File Defaults.md

@@ -60,6 +60,7 @@ When editing `TQ_extra_instructions` in Obsidian's File properties editor, you c
 > - `TQ_extra_instructions` is especially useful when you have more than one Tasks search block in a file, and you want the same instructions to be present in all the searches.
 > - Before this feature, if those standard instructions changed, you had to remember to update every search.
 > - Now you can put those standard instructions in `TQ_extra_instructions`, and only update them in one place.
+> - Since Tasks X.Y.Z, `TQ_extra_instructions` does support [[Line Continuations]].
 
 > [!note]
 > The `TQ_extra_instructions` property isn't an array. It's a single string value, and the `|-` allows it to span multiple lines.
@@ -248,6 +249,3 @@ The `type` values are explained in the [Property types](https://help.obsidian.md
 - Tasks searches in **Canvas cards** cannot use [[Query File Defaults]], because the [Canvas format](https://jsoncanvas.org) does not support frontmatter/properties.
   - The workaround is to use the Canvas [Convert to file](https://help.obsidian.md/Plugins/Canvas#Add+text+cards) facility to convert cards which contain Tasks queries to a separate Markdown note, embedded in the canvas.
   - You can then add Query File Defaults to the new note.
-- The property `TQ_extra_instructions` can contain any kind of Tasks instruction, including placeholders.
-  - But it does not work with [[Line Continuations]].
-  - The workaround is to write any long instructions all on one line when placed in `TQ_extra_instructions`.

docs/What is New/Changelog.md

@@ -13,6 +13,7 @@ _In recent [Tasks releases](https://github.com/obsidian-tasks-group/obsidian-tas
 ## 7.x releases
 
 - X.Y.Z:
+  - [[Line Continuations]] can now be used in the [[Query File Defaults]] property `TQ_extra_instructions`.
   - [[Check your Statuses]] report now contains samples of each status, and a convenient search to test them.
 - 7.19.0:
   - New setting to [[Recurring Tasks#Remove scheduled date on recurrence|remove scheduled date on recurrence]].

src/Query/Query.ts

@@ -184,6 +184,11 @@ ${source}`;
             const queryContext = makeQueryContext(tasksFile);
             try {
                 expandedSource = expandPlaceholders(source, queryContext);
+                if (expandedSource !== source) {
+                    expandedSource = continueLines(expandedSource)
+                        .map((statement) => statement.anyContinuationLinesRemoved)
+                        .join('\n');
+                }
             } catch (error) {
                 if (error instanceof Error) {
                     this._error = error.message;

tests/Query/Query.test.ts

@@ -876,18 +876,16 @@ group by folder
                 `);
             });
 
-            it('does not work with continuation lines in multi-line property with query.file.property via placeholder', () => {
+            it('should work with continuation lines in multi-line property with query.file.property via placeholder', () => {
                 const propertyValue = `path \\
   includes query_using_properties
 `;
                 const query = makeQueryFromPropertyWithValue('task_instructions_with_continuation_line', propertyValue);
 
-                expect(query.error).not.toBeUndefined();
-                expect(query.error).toMatchInlineSnapshot(`
-                    "do not understand query
-                    Problem statement:
-                        {{query.file.property('task_instructions_with_continuation_line')}}: statement 1 after expansion of placeholder =>
-                        path \\
+                expect(query.error).toBeUndefined();
+                expect(query.explainQuery()).toMatchInlineSnapshot(`
+                    "{{query.file.property('task_instructions_with_continuation_line')}} =>
+                    path includes query_using_properties
                     "
                 `);
             });

tests/Scripting/Includes.test.ts

@@ -155,26 +155,10 @@ return "Hello World";`;
 
         const expectedStatement = 'group by function return "Hello World";';
 
-        it('includes placeholder DOES NOT YET SUPPORT line continuations in include value', () => {
-            // TODO Teach '{{includes.x}}' to support line continuations
-            // Just as TQ_extra_instructions (in Query File Defaults) does not work with line continuations,
-            // so includes in placeholders do not.
-            // This is because line continuations are applied only once, before the placeholders
-            // are expanded.
-
+        it('includes placeholder supports line continuations in include value', () => {
             const source = '{{includes.instruction_with_continuation_lines}}';
-            const query = createQuery(source, includes);
-            expect(query.error).toMatchInlineSnapshot(`
-                "Could not interpret the following instruction as a Boolean combination:
-                    return "Hello World";
-
-                The error message is:
-                    All filters in a Boolean instruction must be inside one of these pairs of delimiter characters: (...) or [...] or {...} or "...". Combinations of those delimiters are no longer supported.
-                Problem statement:
-                    {{includes.instruction_with_continuation_lines}}: statement 2 after expansion of placeholder =>
-                    return "Hello World";
-                "
-            `);
+            const query = createValidQuery(source, includes);
+            expectExpandedStatementToBe(query.grouping[0].statement, expectedStatement);
         });
 
         it('include instruction supports line continuations in include value', () => {