feat: Remove 'No sorting...' & 'No grouping...' from explain output

claremacrae · claremacrae · commit e4dbafa11743 · 2025-02-04T13:08:23.000Z
diff --git a/src/Query/Explain/Explainer.ts b/src/Query/Explain/Explainer.ts
@@ -58,15 +58,15 @@ export class Explainer {
 
     public explainGroups(query: Query) {
         if (query.grouping.length === 0) {
-            return this.indent('No grouping instructions supplied.\n');
+            return '';
         }
 
         return query.grouping.map((group) => group.statement.explainStatement(this.indentation)).join('\n\n') + '\n';
     }
 
     public explainSorters(query: Query) {
         if (query.sorting.length === 0) {
-            return this.indent('No sorting instructions supplied.\n');
+            return '';
         }
 
         return query.sorting.map((sort) => sort.statement.explainStatement(this.indentation)).join('\n\n') + '\n';
diff --git a/tests/Config/DebugSettings.test.ts b/tests/Config/DebugSettings.test.ts
@@ -37,8 +37,6 @@ describe('DebugSettings', () => {
         expect(query.explainQuery()).toMatchInlineSnapshot(`
             "No filters supplied. All tasks will match the query.
 
-            No grouping instructions supplied.
-
             sort by status
 
             NOTE: All sort instructions, including default sort order, are disabled, due to 'ignoreSortInstructions' setting.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_boolean_combinations.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_boolean_combinations.approved.explanation.text
@@ -7,7 +7,3 @@ Explanation of this Tasks code block query:
       due before tomorrow =>
         due date is before 2022-10-22 (Saturday 22nd October 2022)
       is recurring
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_expands_dates.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_expands_dates.approved.explanation.text
@@ -8,7 +8,3 @@ Explanation of this Tasks code block query:
 
   due before tomorrow =>
     due date is before 2022-10-22 (Saturday 22nd October 2022)
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_explains_task_block_with_global_query_active.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_explains_task_block_with_global_query_active.approved.explanation.text
@@ -2,10 +2,6 @@ Explanation of the global query:
 
   heading includes tasks
 
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
-
   At most 50 tasks.
 
 Explanation of this Tasks code block query:
@@ -16,7 +12,3 @@ Explanation of this Tasks code block query:
     due date is between:
       2022-10-24 (Monday 24th October 2022) and
       2022-10-30 (Sunday 30th October 2022) inclusive
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_line_continuation_-_double_slash.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_line_continuation_-_double_slash.approved.explanation.text
@@ -2,7 +2,3 @@ Explanation of this Tasks code block query:
 
   description includes \\ =>
   description includes \
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_line_continuation_-_single_slash.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_line_continuation_-_single_slash.approved.explanation.text
@@ -7,7 +7,3 @@ Explanation of this Tasks code block query:
     OR (At least one of):
       priority is highest
       priority is lowest
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_nested_boolean_combinations.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_nested_boolean_combinations.approved.explanation.text
@@ -20,7 +20,3 @@ Explanation of this Tasks code block query:
           description includes 7
         NOT:
           description includes 7
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_placeholders.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_placeholders.approved.explanation.text
@@ -20,7 +20,3 @@ Explanation of this Tasks code block query:
 
   description includes Some Cryptic String {{! Inline comments are removed before search }} =>
   description includes Some Cryptic String
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Explain/DocsSamplesForExplain.test.explain_regular_expression.approved.explanation.text b/tests/Query/Explain/DocsSamplesForExplain.test.explain_regular_expression.approved.explanation.text
@@ -2,7 +2,3 @@ Explanation of this Tasks code block query:
 
   path regex matches /^Root/Sub-Folder/Sample File\.md/i =>
     using regex:     '^Root\/Sub-Folder\/Sample File\.md' with flag 'i'
-
-  No grouping instructions supplied.
-
-  No sorting instructions supplied.
diff --git a/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_filters-date-examples.approved.explanation.text b/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_filters-date-examples.approved.explanation.text
@@ -31,7 +31,3 @@ due 14 October =>
 
 due May =>
   due date is on 2023-05-01 (Monday 1st May 2023)
-
-No grouping instructions supplied.
-
-No sorting instructions supplied.
diff --git a/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_last-this-next-week-month-quarter-year.approved.explanation.text b/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_last-this-next-week-month-quarter-year.approved.explanation.text
@@ -72,7 +72,3 @@ due next year =>
     2024-12-31 (Tuesday 31st December 2024) inclusive
 
 description includes ------------------------------
-
-No grouping instructions supplied.
-
-No sorting instructions supplied.
diff --git a/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_last-this-next-weekday.approved.explanation.text b/tests/Query/Filter/ReferenceDocs/FilterReference/DateFieldReference.test.explain_date_reference_last-this-next-weekday.approved.explanation.text
@@ -102,7 +102,3 @@ due next sunday =>
   due date is on 2023-04-23 (Sunday 23rd April 2023)
 
 description includes ------------------------------
-
-No grouping instructions supplied.
-
-No sorting instructions supplied.
diff --git a/tests/Query/Filter/TextField.test.explains_regular_expression_searches_bulk_test.approved.txt b/tests/Query/Filter/TextField.test.explains_regular_expression_searches_bulk_test.approved.txt
@@ -106,8 +106,4 @@ tags regex does not match /(home|town)/ =>
 tags regex matches /(home|pc_mac|town)/ =>
   using regex:     '(home|pc_mac|town)' with no flags
 
-No grouping instructions supplied.
-
-No sorting instructions supplied.
-
 Error: None
diff --git a/tests/Query/Query.test.ts b/tests/Query/Query.test.ts
@@ -817,8 +817,6 @@ Problem statement:
 
                     {{query.file.property('task_instruction')}} =>
                     group by filename
-
-                    No sorting instructions supplied.
                     "
                 `);
             });
@@ -831,10 +829,6 @@ Problem statement:
                 expect(query.explainQuery()).toMatchInlineSnapshot(`
                     "{{query.file.property('task_instruction_with_spaces')}} =>
                     path includes query_using_properties
-
-                    No grouping instructions supplied.
-
-                    No sorting instructions supplied.
                     "
                 `);
             });
@@ -860,8 +854,6 @@ group by folder
 
                     {{query.file.property('task_instructions')}}: statement 3 after expansion of placeholder =>
                     group by filename
-
-                    No sorting instructions supplied.
                     "
                 `);
             });
@@ -911,10 +903,6 @@ filter by function \\
                         return roots.includes(task.file.root);
                      =>
                     filter by function if (!query.file.hasProperty('root_dirs_to_search')) { throw Error('Please set the "root_dirs_to_search" list property, with each value ending in a backslash...'); } const roots = query.file.property('root_dirs_to_search'); return roots.includes(task.file.root);
-
-                    No grouping instructions supplied.
-
-                    No sorting instructions supplied.
                     "
                 `);
 
@@ -1541,10 +1529,6 @@ describe('Query', () => {
             const query = new Query(source);
             expect(query.explainQuery()).toMatchInlineSnapshot(`
                 "description includes hello
-
-                No grouping instructions supplied.
-
-                No sorting instructions supplied.
                 "
             `);
         });
@@ -1824,10 +1808,6 @@ with \ backslash)`;
                   OR (At least one of):
                     description includes line 1
                     description includes line 1 continued with \\ backslash
-
-                No grouping instructions supplied.
-
-                No sorting instructions supplied.
                 "
             `);
             expect(queryUpperCase.explainQuery()).toMatchInlineSnapshot(`
@@ -1839,10 +1819,6 @@ with \ backslash)`;
                   OR (At least one of):
                     description includes line 1
                     description includes line 1 continued with \\ backslash
-
-                No grouping instructions supplied.
-
-                No sorting instructions supplied.
                 "
             `);
         });
diff --git a/tests/Query/QueryRendererHelper.test.ts b/tests/Query/QueryRendererHelper.test.ts
@@ -22,10 +22,6 @@ describe('explain', () => {
             "Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -42,10 +38,6 @@ describe('explain', () => {
             Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -60,17 +52,9 @@ describe('explain', () => {
 
               description includes hello
 
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
-
             Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -86,25 +70,13 @@ describe('explain', () => {
 
               description includes hello
 
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
-
             Explanation of the query file defaults (from properties/frontmatter in the query's file):
 
               not done
 
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
-
             Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -123,17 +95,9 @@ describe('explain', () => {
 
               description includes hello
 
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
-
             Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -147,10 +111,6 @@ describe('explain', () => {
             "Explanation of this Tasks code block query:
 
               No filters supplied. All tasks will match the query.
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });
@@ -167,17 +127,9 @@ describe('explain', () => {
 
               description includes I came from the tasks_query_extra_instructions property
 
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
-
             Explanation of this Tasks code block query:
 
               description includes I came from the code block
-
-              No grouping instructions supplied.
-
-              No sorting instructions supplied.
             "
         `);
     });

Original file line number	Diff line number	Diff line change
`@@ -58,15 +58,15 @@ export class Explainer {`
`58`	`58`
`59`	`59`	`public explainGroups(query: Query) {`
`60`	`60`	`if (query.grouping.length === 0) {`
`61`		`- return this.indent('No grouping instructions supplied.\n');`
	`61`	`+ return '';`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`return query.grouping.map((group) => group.statement.explainStatement(this.indentation)).join('\n\n') + '\n';`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`public explainSorters(query: Query) {`
`68`	`68`	`if (query.sorting.length === 0) {`
`69`		`- return this.indent('No sorting instructions supplied.\n');`
	`69`	`+ return '';`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`return query.sorting.map((sort) => sort.statement.explainStatement(this.indentation)).join('\n\n') + '\n';`