Feature filter filename replacements #246
Conversation
pass file name through to query parser
pass file name through to parser, and replace {{filename}} in filter query with file name (spaces removed to comply with Todoist, and remove .md extension)
Update to pass through file name, expand {{filename}} in query filter to file name, replacing spaces with wildcards for compatibility
|
Glad you like the idea! I think it can be really powerful. Another idea I had for the future could be to add expansions for a custom frontmatter property you have defined in the note. Could allow for cleaner templates. Also, depending again on execution order, could allow for dynamic values to be passed in (if inline dataview or templater expression got processed first). |
pendingquery has the ctx MarkdownPostProcessorContext which contains the source file name
- Had to use type any as I don't think the PendingQuery type is available in this context? - Hopefully adding the .parsedObj to pendingQuery within parseQuery works here; tested fine when editing compiled js directly - Filename seems to always be formatted with forward slashes, even on Windows, so only handled these in the regex
|
OK, this has been revised as discussed. This actually cleaned it up a bit as I didn't need to pass a new parameter around just for the filename, since the MarkdownPostProcessor context was already in the pendingQuery object. Added some comments on the commits with considerations. |
| @@ -19,20 +19,21 @@ export class ParsingError extends Error { | |||
| } | |||
| } | |||
|
|
|||
| export function parseQuery(raw: string): Query { | |||
| export function parseQuery(pendingQuery: any): Query { | |||
There was a problem hiding this comment.
Can we use PendingQuery as the type here? You'll need to export the type from injector.ts
| if (!query.hasOwnProperty("name") || query.name === null) { | ||
| throw new ParsingError("Missing field 'name' in query"); | ||
| } | ||
|
|
||
| if (!query.hasOwnProperty("filter") || query.filter === null) { | ||
| throw new ParsingError("Missing field 'filter' in query"); | ||
| } | ||
|
|
||
| query.filter = query.filter.replace(/{{filename}}/g, pendingQuery.ctx.sourcePath.replace(/.*\//, '').replace(/\.md$/i, '').replace(/\s+/g, '*')); |
There was a problem hiding this comment.
This operation might be better done elsewhere. I.e. - parseObject validates that the object is the correct shape and returns a Query. Then we introduce another function that performs expansions on the Query
This enables a clearer delineation of responsibilities and makes it easier for us to test each method in isolation.
There was a problem hiding this comment.
Also the series of regex replacements on the sourcePath, am I right in thinking this grabs the final file path part (i.e. - foo.md), drops the extension, and replaces whitespace characters with *?
Why do we want to do the last part?
|
Hey @anth-dinosaur, I've pulled this change into #259, added some tests and tweaked the implementation. I've added you as a co-author on the commit - thanks for the contribution! 🎉 |
Thanks @jamiebrynes7!! Psyched to see this make it in. Apologies for having disappeared - I kept meaning to get back around to finishing the cleanup and it got buried. Thanks much for bringing it home. |
|
When is this going to happen? |
I wanted the ability to pull in relevant tasks to the current note (use case: a project overview note, for example). Inline dataview and templater expressions do not appear to process before the Todoist query, so I added some functionality to expand {{filename}} within the query filter. Spaces replaced with asterisks for compatibility.
I am not super familiar with typescript and this may be considered hacky. Future improvements would be to include a toggle in settings for this, maybe adding a map of other possible expansions, etc.