jeel-shah / todo-wrangler Goto Github PK

Core

We need to have test cases so that the plugin continues to stay robust as we add more features.

Cases

Test Case 1: Default Keyword Recognition

Objective: Verify that the plugin recognizes tasks marked with the default keyword "TODO".
Preconditions: The plugin is installed and activated with default settings.
Input:

TODO Hello

Expected Output:

### TODOs
TODO Hello

Input:

- [x] TODO Bye

Expected Output:

### TODOs
- [x] TODO Bye

Input:

- [ ] TODO Bye

Expected Output:

### TODOs
- [ ] TODO Bye

Test Case 2: Custom Keyword Recognition

Objective: Verify that the plugin recognizes tasks marked with a custom keyword set in the plugin settings.
Preconditions: The plugin is installed, activated, and the user has set a custom keyword in the settings (e.g., "DONE").

The above inputs/outputs should also work with the custom keyword.

What happened?

1. I had a bulleted list with multiple levels and it only extracted the TODOs from the top level

What should have happened?

1. All TODOs should have been extracted independent of their level in the bulleted list

Steps to reproduce

1. Create a list of items with nested items (see sample below)
2. Label some of items with TODO (or your keyword)
3. Run "TODO Wrangler"
4. Result: only top level keywords will have been extracted

Sample

- TODO Hello World
    - TODO Hi there
- TODO Hello

Hi @Jeel-Shah

We have noticed that the latest release of your plugin cannot be installed currently.

This is due to the following reasons:

• no manifest.json in latest release
• no `main,js´ in latest release

We will remove this plugin from the community plugins if this issue is not fixed within 30 days.

• The Obsidian Team

Currently, lines starting with "TODO" or "- [] TODO" or "- TODO" will get consolidated.
However proper markdown code for a checkbox includes a whitespace between the brackets. But this is not consolidated.
Obsidian only renders a checkbox when done this way - [ ]. It will not render - [] into a checkbox because of the missing whitespace.

So my question would be: would it be possible to add - [ ] TODO to the list of "to be consolidated TODO lines"?

Core

Presently, the Wrangler will only move pre-defined keywords which fit into the following cases:

• - [] keyword
• keyword
• [] keyword

Generally, the Regex is '^-?\\s*(\\[x?\\])?\\s*' + keyword.

However, we also need to include : so it's quite common to have a colon right after the keyword.

Acceptance Criteria

• Users can include : in their keyword
• Users cannot include : in the settings

Core

As a user, I would like to wrangle TODOs at the top of the file so that I can quickly see the relevant TODOs when I see my note.

Acceptance Criteria

• A user can set top/bottom wrangling of TODOs in the settings (global)