Merge pull request #3682 from ilandikov/feat-copy-tree-results

feat: copy tree results

Author: claremacrae

src/Query/QueryResult.ts

@@ -50,6 +50,11 @@ export class QueryResult {
         return result;
     }
 
+    /**
+     * This doesn't support nested results and list items.
+     * TODO reimplement this with {@link MarkdownQueryResultsRenderer}
+     *
+     */
     public asMarkdown(): string {
         let markdown = '';
 

src/Renderer/HtmlQueryResultsRenderer.ts

@@ -2,12 +2,14 @@ import { type App, type Component, Notice, type TFile } from 'obsidian';
 import { postponeButtonTitle, shouldShowPostponeButton } from '../DateTime/Postponer';
 import { QueryLayout } from '../Layout/QueryLayout';
 import { TaskLayout } from '../Layout/TaskLayout';
+import { State } from '../Obsidian/Cache';
 import type { GroupDisplayHeading } from '../Query/Group/GroupDisplayHeading';
 import type { QueryResult } from '../Query/QueryResult';
 import type { ListItem } from '../Task/ListItem';
 import type { Task } from '../Task/Task';
 import { PostponeMenu } from '../ui/Menus/PostponeMenu';
 import { showMenu } from '../ui/Menus/TaskEditingMenu';
+import { MarkdownQueryResultsRenderer } from './MarkdownQueryResultsRenderer';
 import type { QueryRendererParameters } from './QueryResultsRenderer';
 import { QueryResultsRendererBase, type QueryResultsRendererGetters } from './QueryResultsRendererBase';
 import { TaskLineRenderer, type TextRenderer, createAndAppendElement } from './TaskLineRenderer';
@@ -38,6 +40,8 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
 
     private readonly queryRendererParameters: QueryRendererParameters;
 
+    private readonly markdownRenderer: MarkdownQueryResultsRenderer;
+
     constructor(
         renderMarkdown: (
             app: App,
@@ -67,6 +71,12 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
             taskLayoutOptions: this.getters.query().taskLayoutOptions,
             queryLayoutOptions: this.getters.query().queryLayoutOptions,
         });
+
+        this.markdownRenderer = new MarkdownQueryResultsRenderer(getters);
+    }
+
+    protected beginRender(): void {
+        return;
     }
 
     protected renderSearchResultsHeader(queryResult: QueryResult): void {
@@ -77,12 +87,12 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
         this.addTaskCount(queryResult);
     }
 
-    protected renderErrorMessage(errorMessage: string) {
+    protected renderErrorMessage(errorMessage: string): void {
         const container = createAndAppendElement('div', this.content);
         container.innerHTML = '<pre>' + `Tasks query: ${errorMessage.replace(/\n/g, '<br>')}` + '</pre>';
     }
 
-    protected renderLoadingMessage() {
+    protected renderLoadingMessage(): void {
         this.content.textContent = 'Loading Tasks ...';
     }
 
@@ -92,12 +102,14 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
         explanationsBlock.textContent = explanation;
     }
 
-    private addCopyButton(queryResult: QueryResult) {
+    private addCopyButton(_queryResult: QueryResult) {
         const copyButton = createAndAppendElement('button', this.content);
         copyButton.textContent = 'Copy results';
         copyButton.classList.add('plugin-tasks-copy-button');
         copyButton.addEventListener('click', async () => {
-            await navigator.clipboard.writeText(queryResult.asMarkdown());
+            // TODO reimplement this using QueryResult.asMarkdown() when it supports trees and list items.
+            await this.markdownRenderer.renderQuery(State.Warm, this.queryRendererParameters.allTasks());
+            await navigator.clipboard.writeText(this.markdownRenderer.markdown);
             new Notice('Results copied to clipboard');
         });
     }
@@ -126,7 +138,7 @@ export class HtmlQueryResultsRenderer extends QueryResultsRendererBase {
         this.ulElementStack.pop();
     }
 
-    protected beginListItem() {
+    protected beginListItem(): void {
         const taskList = this.currentULElement();
         this.lastLIElement = createAndAppendElement('li', taskList);
     }

src/Renderer/MarkdownQueryResultsRenderer.ts

@@ -0,0 +1,114 @@
+import type { GroupDisplayHeading } from '../Query/Group/GroupDisplayHeading';
+import type { QueryResult } from '../Query/QueryResult';
+import type { ListItem } from '../Task/ListItem';
+import type { Task } from '../Task/Task';
+import { QueryResultsRendererBase, type QueryResultsRendererGetters } from './QueryResultsRendererBase';
+
+/**
+ * @example
+ *   const markdownRenderer = new MarkdownQueryResultsRenderer(getters);
+ *   await markdownRenderer.renderQuery(State.Warm, allTasks);
+ *   const markdown = markdownRenderer.markdown;
+ *
+ */
+export class MarkdownQueryResultsRenderer extends QueryResultsRendererBase {
+    private readonly markdownLines: string[] = [];
+    private taskIndentationLevel = 0;
+
+    constructor(getters: QueryResultsRendererGetters) {
+        super(getters);
+    }
+
+    get markdown(): string {
+        return this.markdownLines.join('\n');
+    }
+
+    protected beginRender(): void {
+        this.markdownLines.length = 0;
+        this.taskIndentationLevel = 0;
+    }
+
+    protected renderSearchResultsHeader(_queryResult: QueryResult): void {
+        return;
+    }
+
+    protected renderSearchResultsFooter(_queryResult: QueryResult): void {
+        return;
+    }
+
+    protected renderLoadingMessage(): void {
+        return;
+    }
+
+    protected renderExplanation(_explanation: string | null): void {
+        return;
+    }
+
+    protected renderErrorMessage(_errorMessage: string): void {
+        return;
+    }
+
+    protected beginTaskList(): void {
+        this.taskIndentationLevel += 1;
+    }
+
+    protected endTaskList(): void {
+        this.taskIndentationLevel -= 1;
+
+        const isOutermostList = this.taskIndentationLevel === 0;
+        if (isOutermostList) {
+            this.addEmptyLine();
+        }
+    }
+
+    private addEmptyLine() {
+        this.markdownLines.push('');
+    }
+
+    protected beginListItem(): void {
+        return;
+    }
+
+    protected addTask(task: Task, _taskIndex: number): Promise<void> {
+        this.markdownLines.push(this.formatTask(task));
+        return Promise.resolve();
+    }
+
+    /**
+     * This is a duplicate of Task.toFileLineString() because tasks rendered in search results
+     * do not necessarily have the same indentation and list markers as the source task lines.
+     *
+     * @param task
+     */
+    private formatTask(task: Task): string {
+        return `${this.listItemIndentation()}- [${task.status.symbol}] ${task.toString()}`;
+    }
+
+    protected addListItem(listItem: ListItem, _listItemIndex: number): Promise<void> {
+        this.markdownLines.push(this.formatListItem(listItem));
+        return Promise.resolve();
+    }
+
+    /**
+     * This is based on ListItem.toFileLineString() because tasks rendered in search results
+     * do not necessarily have the same indentation and list markers as the source lines.
+     *
+     * @param listItem
+     */
+    private formatListItem(listItem: ListItem): string {
+        const statusCharacterToString = listItem.statusCharacter ? `[${listItem.statusCharacter}] ` : '';
+        return `${this.listItemIndentation()}- ${statusCharacterToString}${listItem.description}`;
+    }
+
+    private listItemIndentation() {
+        const indentationLevel = Math.max(0, this.taskIndentationLevel - 1);
+        return '    '.repeat(indentationLevel);
+    }
+
+    protected addGroupHeading(group: GroupDisplayHeading): Promise<void> {
+        const headingPrefix = '#'.repeat(Math.min(4 + group.nestingLevel, 6));
+        this.markdownLines.push(`${headingPrefix} ${group.displayName}`);
+        this.addEmptyLine();
+        return Promise.resolve();
+    }
+}

src/Renderer/QueryResultsRendererBase.ts

@@ -35,6 +35,8 @@ export abstract class QueryResultsRendererBase {
     }
 
     public async renderQuery(state: State | State.Warm, tasks: Task[]) {
+        this.beginRender();
+
         // Don't log anything here, for any state, as it generates huge amounts of
         // console messages in large vaults, if Obsidian was opened with any
         // notes with tasks code blocks in Reading or Live Preview mode.
@@ -50,6 +52,13 @@ export abstract class QueryResultsRendererBase {
         }
     }
 
+    /**
+     * This is called at the start of every render, implement this if you want to reset some state for each render.
+     *
+     * @protected
+     */
+    protected abstract beginRender(): void;
+
     private async renderQuerySearchResults(tasks: Task[]) {
         const queryResult = this.explainAndPerformSearch(tasks);