support custom date format #296

shabegom · 2021-08-24T17:24:04Z

This PR adds support for:

custom date format for due and done dates
toggle to make due and done dates links for linking to DNP

There are two new settings added to Tasks settings modal. One allows a date format to be set which is then used during moment.format(). The other is a toggle to make dates links.

I've also updated the due and done date regex to be a bit more open. I went the easy route instead of trying to guess all the different date formats. I hope this is ok!

TfTHacker · 2021-08-24T17:47:59Z

+1 up vote for this feature

GitMurf · 2021-08-24T20:14:02Z

+99 up vote as well ;-) This is great! Thanks @shabegom for doing this and thanks @schemar for the amazing plugin!

arminta7 · 2021-08-24T21:56:07Z

+1

kmaustral · 2021-08-24T22:24:00Z

+1

PJJPtx · 2021-08-25T02:38:02Z

+1

schemar · 2021-08-25T07:16:37Z

Thank you @shabegom 🎉

I will do a proper review when I find the time. Until then, can you please:

Make sure tests and linting pass
Add documentation to the README
Consider whether there is a better way to set the format on the Task from the settings (maybe only once when the plugin initializes? Maybe get the format always from the settings? Setting the static property doesn't look right in my opinion)

Thank you for the effort! ❤️

shabegom · 2021-08-25T17:00:29Z

@schemar:

fixed linting errors and tests now pass. I added extra validation on due and done dates at the point they are removed from the description. This means the initial regex is a pretty broad match, but the result of the match must also match the proper date format in order to be considered a due or done date. I think this is a decent workaround vs trying to support all possible date formats via regex.
Added a section on these new setting to the README. LMK if anything could be clearer there.
I moved the format and linking setting to be something that is provided when constructing the class / accessed directly. I don't think this totally solves what you were getting at, but I'm not sure how I could read the format once on plugin initialization. Would love a point in the right direction if this change doesn't work.

LMK if you have any other feedback! That test allowing the emoji in the description got me good! If you want me to write any tests for this feature lmk.

schemar · 2021-08-28T09:25:15Z

I think you can remove the dateFormat property from the Task class as you will get the format from the settings every time.

However, I can't wrap my head around a fundamental problem when allowing users to change the format of dates: what happens to all the tasks already in the vault? Their due and done dates would simply become invalid and instead be part of the description now. In your current implementation this also means the parser stops parsing metadata from the end of the task line and thus the recurrence rule would be lost as well.

In short: just allowing users to change the format will lead to what they deem a "broken" Tasks plugin and get back to me via bug tickets.

We need to consider updating all existing tasks when changing the setting. 🤔 Or we only allow a certain set of formats that we all try to match (regardless of the setting) when reading the task. Only newly written tasks would then have the new format, e.g. when toggling, editing, or creating a task.

What do you think?

shabegom · 2021-08-30T19:23:38Z

Here's the simplest approach imo. I could add a button to the settings or a command that runs a one time conversion to any new date format specified. That way all previous tasks would get updated. it could also just auto update, but we'd need to validate the user has completed entering their new format into the field with onBlur or something...

I'm not too sure about accepting any date format, it's totally doable (just don't provide a second argument to moment() and any valid dateformat will be parsed). But I think it will confuse people if they see a different format between edit and preview of the tasks.

kmaustral · 2021-08-30T22:45:47Z

That would be a big gesture. For me, I couldn't see any problem taking personal responsibility for changing the date format for my previously entered tasks, given it was my choice to set the option for a date link.

…

On Tue, 31 Aug 2021 at 05:23, Sam ***@***.***> wrote: Here's the simplest approach imo. I could add a button to the settings or a command that runs a one time conversion to any new date format specified. That way all previous tasks would get updated. it could also just auto update, but we'd need to validate the user has completed entering their new format into the field with onBlur or something... I'm not too sure about accepting any date format, it's totally doable (just don't provide a second argument to moment() and any valid dateformat will be parsed). But I think it will confuse people if they see a different format between edit and preview of the tasks. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#296 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ARTR6N2SOVROSJ73DH4C3XLT7PLEJANCNFSM5CXJTPAA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

jan-willi · 2021-09-03T00:34:16Z

While going down the rabbit hole to modify this plugin to be my perfect task manager I stumbled across the same problem of being able to read multiple formats.
I "solved" it by allowing to set multiple formats in the settings. All formats can be read, while the first supplied format will be used for new tasks. Is this something that could work?

The branch I'm working on (not at all pretty enough for a PR):
https://github.com/jan-willi/obsidian-tasks/tree/datetime
(Also includes custom signifiers and optional times in addition to dates. I might open separate PR's if this works out.)

TfTHacker · 2021-09-19T19:22:35Z

Hoping to see this merge already for days :-)

I am also willing to migrate my tasks to the new format.

schemar · 2021-09-22T11:55:38Z

I don't have time right now for private reasons. I plan to add some new things, including open PRs, to Tasks some time during October. Please be patient.

I think the best solution will be to not support any format, but a number of specific formats, including links ([[]]).

Merge branch 'schemar-main'

schemar · 2021-11-01T17:37:57Z

Thank you for the update @shabegom. This is next on my list.

shabegom · 2021-11-01T22:41:20Z

The fork is still a broken given the massive update. I'm working on it though. Totally didn't realize I opened this PR off the main branch...

schemar · 2021-11-02T05:58:22Z

The fork is still a broken given the massive update. I'm working on it though. Totally didn't realize I opened this PR off the main branch...

Thank you! If it is too much, I can also do it. I suspect I will do some changes after merging either way 👍

schemar · 2021-11-02T09:16:48Z

It also looks like there are some unrelated changes @shabegom 🤔

shabegom · 2021-11-02T12:14:04Z

~~Do you have an example? I only changed things to get the custom date format and date links working with the new options. Anything else must have slipped in accidentally.~~

Oh maybe you mean the manifest? I can change that back. That was for my own testing. Sorry! 🙈

My tsserver was yelling at me about app not existing and Notice not being used...I can also revert that change if it was wrong. 🤦

shabegom · 2021-11-02T12:20:32Z

@schemar I'll revert those changes back today. Sorry about that. Just blindly following the linting errors.

schemar · 2021-11-02T12:31:27Z

If the linter complains, it's fine to update 😄

shabegom · 2021-11-02T15:39:44Z

@schemar I've reverted some of the unrelated changes and left the ones that were throwing errors. Also updated the tests in Query.test.ts.

I'm getting a test failure that I don't think is related to the changes:

Jest: concurrent test "Query sorting instructions sorting as {"input":"sort by status\nsort by due","output":[{"property":"status","reverse":false
},{"property":"due","reverse":false}]}" must return a Promise.

Let me know if there is anything else I can do to get this merge ready. Thanks!

schemar

Thanks a bunch @shabegom! I will use parts of this to get me a speedy start with the feature. It really helps a lot. I will do some things differently. For example, I am not sure I cannot maintain arbitrary date formats.

schemar · 2021-11-02T17:21:09Z

src/QueryRenderer.ts

+        tasks.map(async (task) => {
+            if (task.description.startsWith('![[')) {
+                const link = parseLinktext(task.description);
+                const subpath = link.subpath
+                    .replace('#^', '')
+                    .replace(']]', '');
+                if (link) {
+                    const file = this.app.metadataCache.getFirstLinkpathDest(
+                        link.path.replace('![[', ''),
+                        task.path,
+                    );
+                    const content =
+                        file && (await this.app.vault.read(file)).split('\n');
+                    const blocks =
+                        file &&
+                        this.app.metadataCache.getFileCache(file)?.blocks;
+                    const line = blocks && blocks[subpath]?.position.start.line;
+                    if (line) {
+                        task.description = content[line]
+                            .split(' ^')[0]
+                            .replace('- ', '');
+                    }
+                }
+            }
+        });


@shabegom can you please explain how this is related to the custom date format?

This is so weird! This is from a totally unrelated plugin (block ref counter) and I have no idea how it made it in here. My best guess is Github Copilot suggested this code and I hit tab by accident...

I'm sorry I didn't catch this before. That's really embarrassing. can be fully deleted.

schemar · 2021-11-02T17:21:09Z

src/QueryRenderer.ts

@@ -146,6 +172,7 @@ class QueryRenderChild extends MarkdownRenderChild {
    }: {
        tasks: Task[];
        content: HTMLDivElement;
+        app: App;


is this actually used?

I don't believe it is used. I missed this.

schemar

Merging into a branch. It would still help me if you replied to my questions 😄 Thank you!

schemar · 2021-11-02T18:40:07Z

@shabegom, @TfTHacker, @GitMurf, @arminta7, @kmaustral, @PJJPtx, @jan-willi, @wenlzhang all of you upvoted or participated here or in the discussion #69.

If Tasks supported a fixed list of date formats (only dates, no times), which format(s) would you require? All would have the option to be links.

TfTHacker · 2021-11-02T18:42:58Z

Thank you for your work on this project!!! Format for me:

YYYY-MM-DD

By the way, one of things I have done with my plugins is get the date format for daily notes page which tends to be the format used by the user in his vault. This can be easily retrieved with this library. https://github.com/liamcain/obsidian-daily-notes-interface

schemar · 2021-11-02T18:46:09Z

By the way, one of things I have done with my plugins is get the date format for daily notes page which tends to be the format used by the user in his vault. This can be easily retrieved with this library. https://github.com/liamcain/obsidian-daily-notes-interface

This is great! Thank you!

Incorporating and cleaning up the changes proposed in #296.

kwjfef · 2021-11-10T16:44:49Z

Please could you add the option to change the date format to DD-MM-YYYY (reverse order) to follow EU/UK regional formatting?

schemar · 2021-11-11T09:00:13Z

Please could you add the option to change the date format to DD-MM-YYYY (reverse order) to follow EU/UK regional formatting?

Will do 👍

support custom date format

7fb919f

shabegom added 7 commits Aug 25, 2021

fix linting error

4528fbd

better checking for date format

ce71166

remove brackets from placeholder

bf82c11

pass in dateFormat and dateLink

45b9107

made tests pass

40cc5f7

update readme

7556eb2

fix linting error

e879c16

remove console log

f35cb5f

schemar mentioned this pull request Aug 28, 2021

Added a few things #274

Closed

Merge branch 'schemar:main' into main

ee34248

schemar mentioned this pull request Sep 22, 2021

Add configuration options for markers and date-backlinks #252

Closed

shabegom added 3 commits Nov 1, 2021

previous changes

823e498

fix merge conflicts

c6ade92

update fork

e0d226d

Merge branch 'schemar-main'

update to support new dates with custom formats and links

ff8c917

shabegom added 3 commits Nov 2, 2021

revert manifest.json

4d70d46

don't use this.dateFormat in the tooltip to avoid error

4323c44

fix tests

f95e7b2

schemar changed the base branch from main to custom_date_format Nov 2, 2021

schemar self-assigned this Nov 2, 2021

schemar self-requested a review Nov 2, 2021

schemar added the enhancement label Nov 2, 2021

schemar reviewed Nov 2, 2021

View changes

schemar approved these changes Nov 2, 2021

View changes

schemar merged commit 2a69927 into schemar:custom_date_format Nov 2, 2021
2 of 3 checks passed

schemar added a commit that referenced this issue Nov 2, 2021

Support custom date formats

13ff1d3

Incorporating and cleaning up the changes proposed in #296.

schemar mentioned this pull request Nov 2, 2021

Custom date formats #384

Open

9 tasks

schemar / obsidian-tasks Public

support custom date format #296

support custom date format #296

shabegom commented Aug 24, 2021

TfTHacker commented Aug 24, 2021

GitMurf commented Aug 24, 2021

arminta7 commented Aug 24, 2021

kmaustral commented Aug 24, 2021

PJJPtx commented Aug 25, 2021

schemar commented Aug 25, 2021

shabegom commented Aug 25, 2021

schemar commented Aug 28, 2021

shabegom commented Aug 30, 2021

kmaustral commented Aug 30, 2021

jan-willi commented Sep 3, 2021

TfTHacker commented Sep 19, 2021

schemar commented Sep 22, 2021

schemar commented Nov 1, 2021

shabegom commented Nov 1, 2021

schemar commented Nov 2, 2021

schemar commented Nov 2, 2021

shabegom commented Nov 2, 2021 •

edited

shabegom commented Nov 2, 2021

schemar commented Nov 2, 2021

shabegom commented Nov 2, 2021

schemar left a comment

schemar Nov 2, 2021

shabegom Nov 2, 2021

schemar Nov 2, 2021

schemar Nov 2, 2021

shabegom Nov 2, 2021

schemar left a comment

schemar commented Nov 2, 2021

TfTHacker commented Nov 2, 2021

schemar commented Nov 2, 2021

kwjfef commented Nov 10, 2021

schemar commented Nov 11, 2021

schemar / obsidian-tasks Public

support custom date format #296

support custom date format #296

Conversation

shabegom commented Aug 24, 2021

TfTHacker commented Aug 24, 2021

GitMurf commented Aug 24, 2021

arminta7 commented Aug 24, 2021

kmaustral commented Aug 24, 2021

PJJPtx commented Aug 25, 2021

schemar commented Aug 25, 2021

shabegom commented Aug 25, 2021

schemar commented Aug 28, 2021

shabegom commented Aug 30, 2021

kmaustral commented Aug 30, 2021

jan-willi commented Sep 3, 2021

TfTHacker commented Sep 19, 2021

schemar commented Sep 22, 2021

schemar commented Nov 1, 2021

shabegom commented Nov 1, 2021

schemar commented Nov 2, 2021

schemar commented Nov 2, 2021

shabegom commented Nov 2, 2021 • edited

shabegom commented Nov 2, 2021

schemar commented Nov 2, 2021

shabegom commented Nov 2, 2021

schemar left a comment

schemar Nov 2, 2021

Choose a reason for hiding this comment

shabegom Nov 2, 2021

Choose a reason for hiding this comment

schemar Nov 2, 2021

Choose a reason for hiding this comment

schemar Nov 2, 2021

Choose a reason for hiding this comment

shabegom Nov 2, 2021

Choose a reason for hiding this comment

schemar left a comment

schemar commented Nov 2, 2021

TfTHacker commented Nov 2, 2021

schemar commented Nov 2, 2021

kwjfef commented Nov 10, 2021

schemar commented Nov 11, 2021

shabegom commented Nov 2, 2021 •

edited