Merge pull request #3317 from obsidian-tasks-group/add-frontmatter-command

feat: add new command 'Add all Query File Defaults properties'

Author: claremacrae

docs/Queries/Query File Defaults.md

@@ -37,8 +37,8 @@ To try this out:
     - Press `<Return>` or `<Enter>` to add the property.
 3. Now you can modify these `TQ_*` properties to change the behaviour of Tasks searches in this file.
 
-> [!info]
-> We plan to streamline the addition of these properties to notes.
+> [!tip]
+> Use the command **Tasks: Add all Query File Defaults properties** to add all the available `TQ_*` properties to the active note.
 
 #### Widening property names in Obsidian
 
@@ -85,33 +85,32 @@ These are all the properties currently supported by Tasks, as Query File Default
 ```yaml
 ---
 TQ_explain:
+TQ_extra_instructions:
 TQ_short_mode:
-TQ_show_tree:
-TQ_show_tags:
-TQ_show_id:
-TQ_show_depends_on:
-TQ_show_priority:
-TQ_show_recurrence_rule:
-TQ_show_on_completion:
-TQ_show_created_date:
-TQ_show_start_date:
-TQ_show_scheduled_date:
-TQ_show_due_date:
+TQ_show_backlink:
 TQ_show_cancelled_date:
+TQ_show_created_date:
+TQ_show_depends_on:
 TQ_show_done_date:
-TQ_show_urgency:
-TQ_show_backlink:
+TQ_show_due_date:
 TQ_show_edit_button:
+TQ_show_id:
+TQ_show_on_completion:
 TQ_show_postpone_button:
+TQ_show_priority:
+TQ_show_recurrence_rule:
+TQ_show_scheduled_date:
+TQ_show_start_date:
+TQ_show_tags:
 TQ_show_task_count:
-TQ_extra_instructions:
+TQ_show_tree:
+TQ_show_urgency:
 ---
 ```
 <!-- endSnippet -->
 
 > [!tip]
-> We hope in the future to add an Obsidian Command to add all supported Query
-> File Defaults properties to the current file automatically.
+> Use the command **Tasks: Add all Query File Defaults properties** to add all these properties to the active note.
 
 ### Types of Query File Defaults property values
 

docs/images/query-file-defaults-file-properties-controls.png

@@ -1,35 +1,35 @@
 ---
 TQ_explain: false
+TQ_extra_instructions: |-
+  # press shift-return to add new lines
+  # not done
+  # sort by done date
+  # ignore global query
 TQ_short_mode: false
-TQ_show_tree: true
-TQ_show_tags: true
-TQ_show_id: true
-TQ_show_depends_on: true
-TQ_show_priority: true
-TQ_show_recurrence_rule: true
-TQ_show_on_completion: true
-TQ_show_created_date: true
-TQ_show_start_date: true
-TQ_show_scheduled_date: true
-TQ_show_due_date: true
+TQ_show_backlink: true
 TQ_show_cancelled_date: true
+TQ_show_created_date: true
+TQ_show_depends_on: true
 TQ_show_done_date: true
-TQ_show_urgency: true
-TQ_show_backlink: true
+TQ_show_due_date: true
 TQ_show_edit_button: true
+TQ_show_id: true
+TQ_show_on_completion: true
 TQ_show_postpone_button: true
+TQ_show_priority: true
+TQ_show_recurrence_rule: true
+TQ_show_scheduled_date: true
+TQ_show_start_date: true
+TQ_show_tags: true
 TQ_show_task_count: true
+TQ_show_tree: true
+TQ_show_urgency: true
 TQ_sort_by:
   - description
 TQ_group_by:
   - status.type
   - happens reverse
   - function task.tags.sort().join(' ')
-TQ_extra_instructions: |-
-  # press shift-return to add new lines
-  # not done
-  # sort by done date
-  # ignore global query
 ---
 
 # Placeholder examples to capture in tests and docs

resources/sample_vaults/Tasks-Demo/Manual Testing/Frontmatter/Placeholder examples to capture in tests and docs.md

@@ -1,27 +1,27 @@
 ---
 TQ_explain: false
+TQ_extra_instructions: |-
+  # press shift-return to add new lines
+  not done
 TQ_short_mode: false
-TQ_show_tree: false
-TQ_show_tags: false
-TQ_show_id: false
-TQ_show_depends_on: false
-TQ_show_priority: false
-TQ_show_recurrence_rule: false
-TQ_show_on_completion: false
-TQ_show_created_date: false
-TQ_show_start_date: false
-TQ_show_scheduled_date: false
-TQ_show_due_date: false
+TQ_show_backlink: false
 TQ_show_cancelled_date: false
+TQ_show_created_date: false
+TQ_show_depends_on: false
 TQ_show_done_date: false
-TQ_show_urgency: false
-TQ_show_backlink: false
+TQ_show_due_date: false
 TQ_show_edit_button: false
+TQ_show_id: false
+TQ_show_on_completion: false
 TQ_show_postpone_button: false
+TQ_show_priority: false
+TQ_show_recurrence_rule: false
+TQ_show_scheduled_date: false
+TQ_show_start_date: false
+TQ_show_tags: false
 TQ_show_task_count: false
-TQ_extra_instructions: |-
-  # press shift-return to add new lines
-  not done
+TQ_show_tree: false
+TQ_show_urgency: false
 ---
 
 # query_file_defaults_all_options_false

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

@@ -1,25 +1,25 @@
 ---
 TQ_explain:
+TQ_extra_instructions:
 TQ_short_mode:
-TQ_show_tree:
-TQ_show_tags:
-TQ_show_id:
-TQ_show_depends_on:
-TQ_show_priority:
-TQ_show_recurrence_rule:
-TQ_show_on_completion:
-TQ_show_created_date:
-TQ_show_start_date:
-TQ_show_scheduled_date:
-TQ_show_due_date:
+TQ_show_backlink:
 TQ_show_cancelled_date:
+TQ_show_created_date:
+TQ_show_depends_on:
 TQ_show_done_date:
-TQ_show_urgency:
-TQ_show_backlink:
+TQ_show_due_date:
 TQ_show_edit_button:
+TQ_show_id:
+TQ_show_on_completion:
 TQ_show_postpone_button:
+TQ_show_priority:
+TQ_show_recurrence_rule:
+TQ_show_scheduled_date:
+TQ_show_start_date:
+TQ_show_tags:
 TQ_show_task_count:
-TQ_extra_instructions:
+TQ_show_tree:
+TQ_show_urgency:
 ---
 
 # query_file_defaults_all_options_null

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

@@ -1,27 +1,27 @@
 ---
 TQ_explain: true
+TQ_extra_instructions: |-
+  # press shift-return to add new lines
+  not done
 TQ_short_mode: true
-TQ_show_tree: true
-TQ_show_tags: true
-TQ_show_id: true
-TQ_show_depends_on: true
-TQ_show_priority: true
-TQ_show_recurrence_rule: true
-TQ_show_on_completion: true
-TQ_show_created_date: true
-TQ_show_start_date: true
-TQ_show_scheduled_date: true
-TQ_show_due_date: true
+TQ_show_backlink: true
 TQ_show_cancelled_date: true
+TQ_show_created_date: true
+TQ_show_depends_on: true
 TQ_show_done_date: true
-TQ_show_urgency: true
-TQ_show_backlink: true
+TQ_show_due_date: true
 TQ_show_edit_button: true
+TQ_show_id: true
+TQ_show_on_completion: true
 TQ_show_postpone_button: true
+TQ_show_priority: true
+TQ_show_recurrence_rule: true
+TQ_show_scheduled_date: true
+TQ_show_start_date: true
+TQ_show_tags: true
 TQ_show_task_count: true
-TQ_extra_instructions: |-
-  # press shift-return to add new lines
-  not done
+TQ_show_tree: true
+TQ_show_urgency: true
 ---
 
 # query_file_defaults_all_options_true

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

@@ -0,0 +1,21 @@
+import { type App, Notice, type TFile } from 'obsidian';
+import { QueryFileDefaults } from '../Query/QueryFileDefaults';
+
+export async function ensureQueryFileDefaultsInFrontmatter(app: App, file: TFile) {
+    await app.fileManager.processFrontMatter(file, (frontmatter) => {
+        const requiredKeys = new QueryFileDefaults().allPropertyNamesSorted();
+        let updated = false;
+        requiredKeys.forEach((key) => {
+            if (!(key in frontmatter)) {
+                frontmatter[key] = null;
+                updated = true;
+            }
+        });
+
+        if (!updated) {
+            new Notice('All supported properties are already present.');
+        } else {
+            new Notice('Properties updated successfully.');
+        }
+    });
+}

src/Commands/AddQueryFileDefaultsProperties.ts

@@ -1,8 +1,9 @@
-import type { App, Editor, MarkdownFileInfo, MarkdownView, View } from 'obsidian';
+import type { App, Editor, MarkdownFileInfo, MarkdownView, TFile, View } from 'obsidian';
 import type TasksPlugin from '../main';
 import { createOrEdit } from './CreateOrEdit';
 
 import { toggleDone } from './ToggleDone';
+import { ensureQueryFileDefaultsInFrontmatter } from './AddQueryFileDefaultsProperties';
 
 export class Commands {
     private readonly plugin: TasksPlugin;
@@ -30,5 +31,30 @@ export class Commands {
             icon: 'check-in-circle',
             editorCheckCallback: toggleDone,
         });
+
+        plugin.addCommand({
+            id: 'add-query-file-defaults-properties',
+            name: 'Add all Query File Defaults properties',
+            icon: 'settings',
+            checkCallback: (checking: boolean) => {
+                const activeFile = this.app.workspace.getActiveFile();
+                if (!activeFile) {
+                    return false;
+                }
+                if (activeFile.extension !== 'md') {
+                    return false;
+                }
+
+                if (!checking) {
+                    this.ensureQueryFileDefaultsFrontmatter(activeFile).catch(console.error);
+                }
+                return true;
+            },
+        });
+    }
+
+    async ensureQueryFileDefaultsFrontmatter(file: TFile): Promise<void> {
+        const { app } = this;
+        await ensureQueryFileDefaultsInFrontmatter(app, file);
     }
 }

src/Commands/index.ts

@@ -160,6 +160,14 @@ export class QueryFileDefaults {
         return new Query(this.source(queryFile), queryFile);
     }
 
+    public allPropertyNames(): string[] {
+        return queryProperties.map((prop) => prop.name);
+    }
+
+    public allPropertyNamesSorted(): string[] {
+        return this.allPropertyNames().sort((a, b) => a.localeCompare(b));
+    }
+
     /**
      * Return text that creates MetaBind widgets for users to edit query file defaults.
      */

src/Query/QueryFileDefaults.ts

@@ -1,23 +1,23 @@
 ---
 TQ_explain:
+TQ_extra_instructions:
 TQ_short_mode:
-TQ_show_tree:
-TQ_show_tags:
-TQ_show_id:
-TQ_show_depends_on:
-TQ_show_priority:
-TQ_show_recurrence_rule:
-TQ_show_on_completion:
-TQ_show_created_date:
-TQ_show_start_date:
-TQ_show_scheduled_date:
-TQ_show_due_date:
+TQ_show_backlink:
 TQ_show_cancelled_date:
+TQ_show_created_date:
+TQ_show_depends_on:
 TQ_show_done_date:
-TQ_show_urgency:
-TQ_show_backlink:
+TQ_show_due_date:
 TQ_show_edit_button:
+TQ_show_id:
+TQ_show_on_completion:
 TQ_show_postpone_button:
+TQ_show_priority:
+TQ_show_recurrence_rule:
+TQ_show_scheduled_date:
+TQ_show_start_date:
+TQ_show_tags:
 TQ_show_task_count:
-TQ_extra_instructions:
+TQ_show_tree:
+TQ_show_urgency:
 ---