Types of changes

Changes visible to users:

• Bug fix (prefix: fix - non-breaking change which fixes an issue)
  • Issue/discussion:
    • Support for using YAML front Matter Values as Variables in Queries [via placeholder values, without the need for 'filter by function'] #3154
    • Expose query.file.property similarly to task.file.property #3083
• Documentation (prefix: docs - improvements to any documentation content for users)
• Sample vault (prefix: vault - improvements to the Tasks-Demo sample vault)

Internal changes:

• Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

Summary: This is all about making the following features releasable, by fixing bugs in the initial implementation and adding documentation:

• Support for using YAML front Matter Values as Variables in Queries [via placeholder values, without the need for 'filter by function'] #3154
• Expose query.file.property similarly to task.file.property #3083

Detail:

1. When the user edits any Obsidian properties in the query file, refresh the query, in case any frontmatter properties were used in the query
2. When the user moves or renames the file containing the query, refresh the query, in case the query's path used in the query, such as via placeholders
3. Add some initial documentation for query.file.hasProperty() and query.file.property()

Motivation and Context

This builds on the following PRs:

• feat: partial support for query.file.property() and query.file.hasProperty() #3242
• fix: Allow multi-line properties in {{query.file.property('...')}} #3245

They enabled queries to access query.file.hasProperty() and query.file.property(), but with the major limitation that the query file had to be re-opened for the changes to take effect.

How has this been tested?

• Automated tests, where possible.
• Lots of exploratory testing

Screenshots (if appropriate)

Video coming soon

Checklist

• My code follows the code style of this project and passes yarn run lint.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• My change has adequate Unit Test coverage.

Terms

• My contribution follows this project's contributing guide
• I agree to follow this project's Code of Conduct