Improvement/rollover blocks

[tim-hilt]

Solves #41

This adds

• A setting that enables users to choose whether they want to roll over the nested items under an open todo-item
  • Useful if you add further information about the todo in a nested list of sorts
  • Implemented as a new class TodoParser that's thinly wrapped by a utility function and called in index.js
• Several smaller improvements to naming
• JS testing via vitest
  • this was very useful to ensure that the TodoParser is doing what I expect it to do
  • Usable via pnpm test according to the npm-scripts in package.json

In the future we should

• think about whether it would make sense to provide a similar setting but the other way around; i.e. for also rolling over the parent.
  • If a todo-item is found it will be rolled over, regardless of whether it has indentation or not.
  • If it has indentation, it's probably a nested item and it's parent should probably be rolled over too, in order to preserve the previous logic of the note.
• Integrate the build- and test-stage into some kind of CI
  • I'll add that shortly
• Switch to TypeScript
  • This enables a whole bunch of IDE-features and safety-measures that make the plugin more predictable and more maintainable in the long run. Same here: I'll add a new PR shortly.

[lumoe]

That looks very promising, thank you for your work!! :smiley:

the default behaviour of the plugin is well-designed, it should be disabled so that there is no confusion about additional content being rolled-over. We should also add a small section to the README that describes this feature.

Switch to TypeScript This enables a whole bunch of IDE-features and safety-measures that make the plugin more predictable and more maintainable in the long run. Same here: I'll add a new PR shortly.

I agree to that as well. When we do that, we should incorporate the newest changes from the official Sample Plugin from Obsidian: https://github.com/obsidianmd/obsidian-sample-plugin They use TypeScript out-of-the-box and switched to esbuild from rollup.

JS testing via vitest this was very useful to ensure that the TodoParser is doing what I expect it to do Usable via pnpm test according to the npm-scripts in package.json

Thank you!! This has been missing now for a long time. :star_struck: As a note for myself and reminder, that we should also implement tests for filtering out the files and getting the right daily file. We recently added the possibility to have more complex datetime moment formats which supports directories. We recently had quite some troubles with that feature.

Give me a few days to test out this feature and provide you with some feedback.

[lumoe]

Btw. can you also push the options you used for your formatter? Your settings look good, so we can also use it as our main formatter options upstream to avoid formatter diffs in our commits.

[tim-hilt]

Oh, I'm sorry, I just saw that I messed up the formatting of all touched files!

As for the formatter: I use VSCode together with the prettier plugin. I have configured vscode to auto-format on save. That's why I didn't notice that I changed so much!

Prettier doesn't allow for global formatting-settings, so what you see is actually just prettiers default settings. I think the obsidian-sample-plugin is using a .prettierrc though. It would be better to add that to the codebase.

I'll add a new PR to add formatting to the codebase. At some point we could also incorporate husky to perform formatting (and possibly linting / type-checking / building) before each commit.

[tim-hilt]

Ah btw. with this implementation I preserve the indentation of previous todo-elements:

- [ ] Foo
    - [ ] Bar

Will be rolled over as

- [ ] Foo
    - [ ] Bar

As opposed to the previous behavior:

- [ ] Foo
- [ ] Bar

Adjusting this would be a minor adaptation though.