Merge pull request #3696 from ilandikov/feat-copy-results-includes-explanation

feat: render explanation in Markdown

Author: claremacrae

src/Renderer/MarkdownQueryResultsRenderer.ts

@@ -40,8 +40,10 @@ export class MarkdownQueryResultsRenderer extends QueryResultsRendererBase {
         return;
     }
 
-    protected renderExplanation(_explanation: string | null): void {
-        return;
+    protected renderExplanation(explanation: string | null): void {
+        if (explanation) {
+            this.markdownLines.push(explanation);
+        }
     }
 
     protected renderErrorMessage(_errorMessage: string): void {

tests/Renderer/MarkdownQueryResultsRenderer.test.ts

@@ -249,4 +249,20 @@ group by id
             "
         `);
     });
+
+    it('should render the explanation', async () => {
+        const tasks = readTasksFromSimulatedFile('callout_labelled');
+
+        const markdown = await renderMarkdown('explain\ndescription includes indented', tasks);
+
+        expect(markdown).toMatchInlineSnapshot(`
+            "
+            Explanation of this Tasks code block query:
+
+              description includes indented
+
+            - [ ] #task Task indented in 'callout_labelled'
+            "
+        `);
+    });
 });