Merge pull request #3661 from ilandikov/feat-copy-results-improvements

feat: copy results improvements

Author: claremacrae

resources/sample_vaults/Tasks-Demo/Test Data/mixed_list_markers.md

@@ -0,0 +1,4 @@
+- [ ] hyphen
+* [ ] asterisk
++ [ ] plus
+1. [ ] numbered task

src/Query/Group/TaskGroup.ts

@@ -106,7 +106,7 @@ export class TaskGroup {
         for (const heading of this.groupHeadings) {
             // These headings mimic the behaviour of QueryRenderer,
             // which uses 'h4', 'h5' and 'h6' for nested groups.
-            const headingPrefix = '#'.repeat(4 + heading.nestingLevel);
+            const headingPrefix = '#'.repeat(Math.min(4 + heading.nestingLevel, 6));
             output += `${headingPrefix} ${heading.displayName}\n\n`;
         }
 

src/Query/QueryResult.ts

@@ -1,3 +1,4 @@
+import type { Task } from '../Task/Task';
 import { TaskGroups } from './Group/TaskGroups';
 import type { TaskGroup } from './Group/TaskGroup';
 import { SearchInfo } from './SearchInfo';
@@ -48,4 +49,46 @@ export class QueryResult {
         result._searchErrorMessage = message;
         return result;
     }
+
+    public asMarkdown(): string {
+        let markdown = '';
+
+        markdown += this.taskGroups.groups // force line break
+            .map((group) => this.toString(group))
+            .join('');
+
+        return markdown;
+    }
+
+    private toString(group: TaskGroup): string {
+        let output = '\n';
+
+        for (const heading of group.groupHeadings) {
+            // These headings mimic the behaviour of QueryRenderer,
+            // which uses 'h4', 'h5' and 'h6' for nested groups.
+            const headingPrefix = '#'.repeat(Math.min(4 + heading.nestingLevel, 6));
+            output += `${headingPrefix} ${heading.displayName}\n\n`;
+        }
+
+        output += this.tasksAsStringOfLines(group.tasks);
+        return output;
+    }
+
+    private tasksAsStringOfLines(tasks: Task[]): string {
+        let output = '';
+        for (const task of tasks) {
+            output += this.toFileLineString(task) + '\n';
+        }
+        return output;
+    }
+
+    /**
+     * 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
+     */
+    public toFileLineString(task: Task): string {
+        return `- [${task.status.symbol}] ${task.toString()}`;
+    }
 }

src/Renderer/QueryResultsRenderer.ts

@@ -202,7 +202,7 @@ export class QueryResultsRenderer {
         const measureRender = new PerformanceTracker(`Render: ${this.query.queryId} - ${this.filePath}`);
         measureRender.start();
 
-        this.addCopyButton(content, queryResult.taskGroups);
+        this.addCopyButton(content, queryResult);
 
         await this.addAllTaskGroups(queryResult.taskGroups, content, queryRendererParameters);
 
@@ -237,12 +237,12 @@ export class QueryResultsRenderer {
         content.appendChild(explanationsBlock);
     }
 
-    private addCopyButton(content: HTMLDivElement, taskGroups: TaskGroups) {
+    private addCopyButton(content: HTMLDivElement, queryResult: QueryResult) {
         const copyButton = createAndAppendElement('button', content);
         copyButton.textContent = 'Copy results';
         copyButton.classList.add('plugin-tasks-copy-button');
         copyButton.addEventListener('click', async () => {
-            await navigator.clipboard.writeText(taskGroups.toString());
+            await navigator.clipboard.writeText(queryResult.asMarkdown());
             new Notice('Results copied to clipboard');
         });
     }

tests/Obsidian/AllCacheSampleData.ts

@@ -54,6 +54,7 @@ export type MockDataName =
     | 'links_everywhere'
     | 'list_statuses'
     | 'list_styles'
+    | 'mixed_list_markers'
     | 'multi_line_task_and_list_item'
     | 'multiple_headings'
     | 'no_heading'
@@ -166,6 +167,7 @@ export const AllMockDataNames: MockDataName[] = [
     'links_everywhere',
     'list_statuses',
     'list_styles',
+    'mixed_list_markers',
     'multi_line_task_and_list_item',
     'multiple_headings',
     'no_heading',

tests/Obsidian/__test_data__/metadataCache/resolvedLinks.json

@@ -228,6 +228,7 @@
   },
   "Test Data/list_statuses.md": {},
   "Test Data/list_styles.md": {},
+  "Test Data/mixed_list_markers.md": {},
   "Test Data/multi_line_task_and_list_item.md": {},
   "Test Data/multiple_headings.md": {},
   "Test Data/no_heading.md": {},

tests/Obsidian/__test_data__/metadataCache/unresolvedLinks.json

@@ -162,6 +162,7 @@
   "Test Data/links_everywhere.md": {},
   "Test Data/list_statuses.md": {},
   "Test Data/list_styles.md": {},
+  "Test Data/mixed_list_markers.md": {},
   "Test Data/multi_line_task_and_list_item.md": {},
   "Test Data/multiple_headings.md": {},
   "Test Data/no_heading.md": {},

tests/Obsidian/__test_data__/mixed_list_markers.json

@@ -0,0 +1,137 @@
+{
+  "cachedMetadata": {
+    "listItems": [
+      {
+        "parent": -1,
+        "position": {
+          "end": {
+            "col": 12,
+            "line": 0,
+            "offset": 12
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        },
+        "task": " "
+      },
+      {
+        "parent": -1,
+        "position": {
+          "end": {
+            "col": 14,
+            "line": 1,
+            "offset": 27
+          },
+          "start": {
+            "col": 0,
+            "line": 1,
+            "offset": 13
+          }
+        },
+        "task": " "
+      },
+      {
+        "parent": -2,
+        "position": {
+          "end": {
+            "col": 10,
+            "line": 2,
+            "offset": 38
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 28
+          }
+        },
+        "task": " "
+      },
+      {
+        "parent": -3,
+        "position": {
+          "end": {
+            "col": 20,
+            "line": 3,
+            "offset": 59
+          },
+          "start": {
+            "col": 0,
+            "line": 3,
+            "offset": 39
+          }
+        },
+        "task": " "
+      }
+    ],
+    "sections": [
+      {
+        "position": {
+          "end": {
+            "col": 12,
+            "line": 0,
+            "offset": 12
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        },
+        "type": "list"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 14,
+            "line": 1,
+            "offset": 27
+          },
+          "start": {
+            "col": 0,
+            "line": 1,
+            "offset": 13
+          }
+        },
+        "type": "list"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 10,
+            "line": 2,
+            "offset": 38
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 28
+          }
+        },
+        "type": "list"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 20,
+            "line": 3,
+            "offset": 59
+          },
+          "start": {
+            "col": 0,
+            "line": 3,
+            "offset": 39
+          }
+        },
+        "type": "list"
+      }
+    ]
+  },
+  "fileContents": "- [ ] hyphen\n* [ ] asterisk\n+ [ ] plus\n1. [ ] numbered task\n",
+  "filePath": "Test Data/mixed_list_markers.md",
+  "getAllTags": [],
+  "parseFrontMatterTags": null,
+  "resolveLinkToPath": {}
+}