Merge pull request #3318 from obsidian-tasks-group/update-types.json

feat: Teach File Properties to recognise Tasks properties

Author: claremacrae

docs/Queries/Query File Defaults.md

@@ -32,13 +32,12 @@ To try this out:
     - Run the `Properties view: Show file properties` command.
 2. Add one or more `TQ_*` properties to the file
     - Click on `Add property`.
-    - Start typing `TQ_`.
-    - Or you can paste in property names from the [[#Supported Query File Defaults property values]] section below.
+    - Start typing `TQ_`, or any part of the property names list in [[#Supported Query File Defaults property values]] below.
     - 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.
+3. Now you can modify these `TQ_*` properties to change the behaviour of all the Tasks searches in this file.
 
 > [!tip]
-> Use the command **Tasks: Add all Query File Defaults properties** to add all the available `TQ_*` properties to the active note.
+> Use the command **Tasks: Add all Query File Defaults properties** to add all the available `TQ_*` properties to the active note in one simple step.
 
 #### Widening property names in Obsidian
 
@@ -118,35 +117,34 @@ These are all the types of properties currently supported by Tasks, as Query
 File Defaults.
 
 > [!tip]
-> We plan to make Tasks add these types to the Obsidian vault automatically in
-> future.
+> The Tasks plugin automatically adds these properties to the Obsidian vault.
 
+<!-- snippet: DocsSamplesForDefaults.test.DocsSamplesForDefaults_fake-types.json.approved.json -->
 ```json
 {
   "types": {
     "TQ_explain": "checkbox",
+    "TQ_extra_instructions": "text",
     "TQ_short_mode": "checkbox",
-    "TQ_show_tree": "checkbox",
-    "TQ_show_tags": "checkbox",
-    "TQ_show_id": "checkbox",
-    "TQ_show_depends_on": "checkbox",
-    "TQ_show_priority": "checkbox",
-    "TQ_show_recurrence_rule": "checkbox",
-    "TQ_show_on_completion": "checkbox",
-    "TQ_show_created_date": "checkbox",
-    "TQ_show_start_date": "checkbox",
-    "TQ_show_scheduled_date": "checkbox",
-    "TQ_show_due_date": "checkbox",
+    "TQ_show_backlink": "checkbox",
     "TQ_show_cancelled_date": "checkbox",
+    "TQ_show_created_date": "checkbox",
+    "TQ_show_depends_on": "checkbox",
     "TQ_show_done_date": "checkbox",
-    "TQ_show_urgency": "checkbox",
-    "TQ_show_backlink": "checkbox",
+    "TQ_show_due_date": "checkbox",
     "TQ_show_edit_button": "checkbox",
+    "TQ_show_id": "checkbox",
+    "TQ_show_on_completion": "checkbox",
     "TQ_show_postpone_button": "checkbox",
+    "TQ_show_priority": "checkbox",
+    "TQ_show_recurrence_rule": "checkbox",
+    "TQ_show_scheduled_date": "checkbox",
+    "TQ_show_start_date": "checkbox",
+    "TQ_show_tags": "checkbox",
     "TQ_show_task_count": "checkbox",
-    "TQ_sort_by": "multitext",
-    "TQ_group_by": "multitext",
-    "TQ_extra_instructions": "text"
+    "TQ_show_tree": "checkbox",
+    "TQ_show_urgency": "checkbox"
   }
 }
 ```
+<!-- endSnippet -->

resources/sample_vaults/Tasks-Demo/.obsidian/types.json

@@ -16,28 +16,28 @@
     "creation date": "datetime",
     "project": "text",
     "sample_text_multiline_property": "text",
+    "TQ_group_by": "multitext",
+    "TQ_sort_by": "multitext",
     "TQ_explain": "checkbox",
+    "TQ_extra_instructions": "text",
     "TQ_short_mode": "checkbox",
-    "TQ_show_tree": "checkbox",
-    "TQ_show_tags": "checkbox",
-    "TQ_show_id": "checkbox",
-    "TQ_show_depends_on": "checkbox",
-    "TQ_show_priority": "checkbox",
-    "TQ_show_recurrence_rule": "checkbox",
-    "TQ_show_on_completion": "checkbox",
-    "TQ_show_created_date": "checkbox",
-    "TQ_show_start_date": "checkbox",
-    "TQ_show_scheduled_date": "checkbox",
-    "TQ_show_due_date": "checkbox",
+    "TQ_show_backlink": "checkbox",
     "TQ_show_cancelled_date": "checkbox",
+    "TQ_show_created_date": "checkbox",
+    "TQ_show_depends_on": "checkbox",
     "TQ_show_done_date": "checkbox",
-    "TQ_show_urgency": "checkbox",
-    "TQ_show_backlink": "checkbox",
+    "TQ_show_due_date": "checkbox",
     "TQ_show_edit_button": "checkbox",
+    "TQ_show_id": "checkbox",
+    "TQ_show_on_completion": "checkbox",
     "TQ_show_postpone_button": "checkbox",
+    "TQ_show_priority": "checkbox",
+    "TQ_show_recurrence_rule": "checkbox",
+    "TQ_show_scheduled_date": "checkbox",
+    "TQ_show_start_date": "checkbox",
+    "TQ_show_tags": "checkbox",
     "TQ_show_task_count": "checkbox",
-    "TQ_sort_by": "multitext",
-    "TQ_group_by": "multitext",
-    "TQ_extra_instructions": "text"
+    "TQ_show_tree": "checkbox",
+    "TQ_show_urgency": "checkbox"
   }
 }

src/Query/QueryFileDefaults.ts

@@ -14,116 +14,137 @@ enum Handler {
 const queryProperties = [
     {
         name: 'TQ_explain',
+        type: 'checkbox',
         display: 'explain',
         handler: Handler.Instruction,
         trueValue: 'explain',
         falseValue: '',
     },
     {
         name: 'TQ_short_mode',
+        type: 'checkbox',
         display: 'short mode',
         handler: Handler.Instruction,
         trueValue: 'short mode',
         falseValue: 'full mode',
     },
     {
         name: 'TQ_show_tree',
+        type: 'checkbox',
         display: 'tree',
         handler: Handler.ShowAndHide,
     },
 
     // Fields that appear before date values:
     {
         name: 'TQ_show_tags',
+        type: 'checkbox',
         display: 'tags',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_id',
+        type: 'checkbox',
         display: 'id',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_depends_on',
+        type: 'checkbox',
         display: 'depends on',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_priority',
+        type: 'checkbox',
         display: 'priority',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_recurrence_rule',
+        type: 'checkbox',
         display: 'recurrence rule',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_on_completion',
+        type: 'checkbox',
         display: 'on completion',
         handler: Handler.ShowAndHide,
     },
 
     // Date fields:
     {
         name: 'TQ_show_created_date',
+        type: 'checkbox',
         display: 'created date',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_start_date',
+        type: 'checkbox',
         display: 'start date',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_scheduled_date',
+        type: 'checkbox',
         display: 'scheduled date',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_due_date',
+        type: 'checkbox',
         display: 'due date',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_cancelled_date',
+        type: 'checkbox',
         display: 'cancelled date',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_done_date',
+        type: 'checkbox',
         display: 'done date',
         handler: Handler.ShowAndHide,
     },
 
     // Elements of query results:
     {
         name: 'TQ_show_urgency',
+        type: 'checkbox',
         display: 'urgency',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_backlink',
+        type: 'checkbox',
         display: 'backlink',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_edit_button',
+        type: 'checkbox',
         display: 'edit button',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_postpone_button',
+        type: 'checkbox',
         display: 'postpone button',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_show_task_count',
+        type: 'checkbox',
         display: 'task count',
         handler: Handler.ShowAndHide,
     },
     {
         name: 'TQ_extra_instructions',
+        type: 'text',
         handler: Handler.AddValue,
     },
 ];
@@ -168,6 +189,16 @@ export class QueryFileDefaults {
         return this.allPropertyNames().sort((a, b) => a.localeCompare(b));
     }
 
+    /**
+     * Return the type of the property with the specified name.
+     *
+     * @param {string} propertyName - The name of the property to retrieve the type for.
+     * @return {string | undefined} The type of the property if found, or undefined if the property is not found.
+     */
+    public propertyType(propertyName: string): string | undefined {
+        return queryProperties.find((prop) => prop.name === propertyName)?.type ?? undefined;
+    }
+
     /**
      * Return text that creates MetaBind widgets for users to edit query file defaults.
      */

src/main.ts

@@ -18,6 +18,7 @@ import { EditorSuggestor } from './Suggestor/EditorSuggestorPopup';
 import { StatusSettings } from './Config/StatusSettings';
 import { tasksApiV1 } from './Api';
 import { GlobalFilter } from './Config/GlobalFilter';
+import { QueryFileDefaults } from './Query/QueryFileDefaults';
 
 export default class TasksPlugin extends Plugin {
     private cache: Cache | undefined;
@@ -61,6 +62,9 @@ export default class TasksPlugin extends Plugin {
         this.inlineRenderer = new InlineRenderer({ plugin: this });
         this.queryRenderer = new QueryRenderer({ plugin: this, events });
 
+        // Update types.json.
+        this.setObsidianPropertiesTypes();
+
         this.registerEditorExtension(newLivePreviewExtension());
         this.registerEditorSuggest(new EditorSuggestor(this.app, getSettings(), this));
         new Commands({ plugin: this });
@@ -101,4 +105,32 @@ export default class TasksPlugin extends Plugin {
             return this.cache.getTasks();
         }
     }
+
+    /**
+     * Add {@link QueryFileDefaults} properties to the Obsidian vault's types.json file,
+     * so that they are available via auto-complete in the File Properties panel.
+     */
+    private setObsidianPropertiesTypes() {
+        // Credit: this code based on ideas...
+        // by:
+        //      @SkepticMystic
+        // in:
+        //      https://github.com/SkepticMystic/breadcrumbs/blob/d380407678ce64f5668550d270b1035bc1a767f8/src/main.ts#L47-L64
+        try {
+            // @ts-expect-error TS2339: Property metadataTypeManager does not exist on type App
+            const metadataTypeManager = this.app.metadataTypeManager;
+            const all_properties = metadataTypeManager.getAllProperties();
+
+            const defaults = new QueryFileDefaults();
+            for (const field of defaults.allPropertyNamesSorted()) {
+                const property_type = defaults.propertyType(field);
+                if (all_properties[field]?.type === property_type) {
+                    continue;
+                }
+                metadataTypeManager.setType(field, property_type);
+            }
+        } catch (error) {
+            console.error('setObsidianPropertiesTypes error', error);
+        }
+    }
 }

tests/DocumentationSamples/DefaultsDocs/DocsSamplesForDefaults.test.DocsSamplesForDefaults_fake-types.json.approved.json

@@ -0,0 +1,25 @@
+{
+  "types": {
+    "TQ_explain": "checkbox",
+    "TQ_extra_instructions": "text",
+    "TQ_short_mode": "checkbox",
+    "TQ_show_backlink": "checkbox",
+    "TQ_show_cancelled_date": "checkbox",
+    "TQ_show_created_date": "checkbox",
+    "TQ_show_depends_on": "checkbox",
+    "TQ_show_done_date": "checkbox",
+    "TQ_show_due_date": "checkbox",
+    "TQ_show_edit_button": "checkbox",
+    "TQ_show_id": "checkbox",
+    "TQ_show_on_completion": "checkbox",
+    "TQ_show_postpone_button": "checkbox",
+    "TQ_show_priority": "checkbox",
+    "TQ_show_recurrence_rule": "checkbox",
+    "TQ_show_scheduled_date": "checkbox",
+    "TQ_show_start_date": "checkbox",
+    "TQ_show_tags": "checkbox",
+    "TQ_show_task_count": "checkbox",
+    "TQ_show_tree": "checkbox",
+    "TQ_show_urgency": "checkbox"
+  }
+}

tests/DocumentationSamples/DefaultsDocs/DocsSamplesForDefaults.test.ts

@@ -1,5 +1,6 @@
 import type { Pos } from 'obsidian';
 
+import { verifyAsJson } from 'approvals/lib/Providers/Jest/JestApprovals';
 import { getTasksFileFromMockData } from '../../TestingTools/MockDataHelpers';
 import query_file_defaults_all_options_null from '../../Obsidian/__test_data__/query_file_defaults_all_options_null.json';
 import query_file_defaults_all_options_true from '../../Obsidian/__test_data__/query_file_defaults_all_options_true.json';
@@ -37,4 +38,24 @@ describe('DocsSamplesForDefaults', () => {
     it('meta-bind-widgets-snippet', () => {
         verifyMarkdown(new QueryFileDefaults().metaBindPluginWidgets());
     });
+
+    it('fake-types.json', () => {
+        const queryFileDefaults = new QueryFileDefaults();
+        const allPropertyNamesSorted = queryFileDefaults.allPropertyNamesSorted();
+
+        // Generate an object representing QueryFileDefaults in Obsidain's types.json.
+        const types: { [key: string]: string } = allPropertyNamesSorted.reduce(
+            (acc: { [key: string]: string }, propName) => {
+                const propType = queryFileDefaults.propertyType(propName);
+                if (propType !== undefined) {
+                    acc[propName] = propType;
+                }
+                return acc;
+            },
+            {},
+        );
+        const generatedObject = { types };
+
+        verifyAsJson(generatedObject);
+    });
 });

tests/Query/QueryFileDefaults.test.ts

@@ -77,6 +77,14 @@ describe('QueryFileDefaults', () => {
         `);
     });
 
+    it('should provide a known property type', () => {
+        expect(new QueryFileDefaults().propertyType('TQ_show_tree')).toEqual('checkbox');
+    });
+
+    it('should provide an unknown property type as undefined', () => {
+        expect(new QueryFileDefaults().propertyType('TQ_any_old_property')).toBeUndefined();
+    });
+
     it('should generate instructions - all values false', () => {
         expect(generateQueryFileDefaultsSource(query_file_defaults_all_options_false)).toMatchInlineSnapshot(`
             "full mode