joeriddles / extended-task-lists

Extended Markdown support for task lists in Obsidian.

Extended Task Lists

Features

• 🌟 Render in-progress and won't do task items with their own UI:
  • in-progress syntax: - [.] In progress
  • won't do syntax: - [~] Won't do
  • Now supports live preview mode (as of release 1.0.4)!
• 🌟 Generate a top-level TODO file by scanning all tasks lists in markdown files
  • Run using the command "Extended Task Lists: Update TODO"

To use

Extra syntax

Simply add an in-progress or won't do task item:

- [ ] Pending
- [.] In progress 
- [~] Won't do
- [x] Done

Generate TODO.md

Open the command palette (Ctrl/Cmd + P by default) and run the "Extended Task Lists: Generate TODO" command.

The generated filename can be configured in the plugin settings, as well as what task item types are included. By default, done and won't do task items are excluded.

To exclude a markdown file's task items from being included in the generated TODO file, add <!-- exclude TODO --> anywhere in the markdown file. To exclude are markdown files in a folder, add an empty .exclude_todos file in the folder.

Development

To get started, set up your local dev environment by following steps 1–3 in the official Obsidian docs for building a plugin.

Basically, the steps look like this:

mkdir -p extended-task-lists/.obsidian/plugins
cd extended-task-lists/.obsidian/plugins
git clone https://github.com/joeriddles/extended-task-lists.git
npm i
npm run dev

Then open the top-level extended-task-lists/ folder in Obsidian as a new vault, enable community plugins in the settings, and enable the Extended Task Lists plugin.

Remember to run npm run dev while developing or you won't see your changes in Obsidian.

Release

Note: releases are now done using GitHub Actions and Releases.

To update the package version:

npm version [major|minor|patch]

To create a release:

git tag x.y.z  # done by `npm version`
git push origin --tags

extended-task-lists's Issues

Ingnore finished task items by default

Add unit tests

Right no there are no tests at all for this plugin. This is not good.

Resources:

• How to test plugin code that uses Obsidian APIs
• Plugin Testing for Developers
• Unit Testing - Obsidian Plugins

Hope to support live preview mode and a faster way to switch

Thank you very much, this is a very useful little plugin, I am looking forward to its future version

Update task item in source file when editing TODO file

Checking a task item in the generated TODO file should check it in the source file

Add setting for organizing generated TODOs according to file structure

For example,

# filepath: 2022/06_June/08_Wednesday
- [ ] do the thing

Would result in the following TODO file:

- 2022
    -  06_June
        - 08_Wednesday
            - [ ] do the thing

Fix generated TODO ordering

Currently the TODO files are ordered oldest-to-newest by mod date, but it should be by creation date. Maybe configurable in settings?

Add support for ignoring markdown files from TODO generator

• <!-- exclude TODO --> anywhere in file
• .exclude_todos file in directory

[Bug] Fix messed-up indentation

The following markdown:

- some list
	- that is deeply nested
		- [ ] with a TODO

Generates the following TODO contents:

- [test nested](test%20nested.md)
			- [ ] with a TODO

The task item in TODO should not be so deeply nested. We need to look at the context of the task item to see if it's nested in a normal list or another task list.

Follow-up to #14

Support comments to exclude a region of a document from generated TODO

something like

- [ ] I am included in TODO.md
// region: exclude_todos
- [ ] I am not included in TODO.md
// endregion: exclude_todos

Add E2E tests

• https://forum.obsidian.md/t/standard-approach-for-writing-automated-end-to-end-tests-for-plugins/31535
• https://playwright.dev/docs/api/class-electron

Add support for live updating TODO doc

See https://github.com/joeriddles/notes

Bug: This plugin has no effect

Hi, I just installed and enabled your plugin, but it did not show the effect as expected.

No matter what I typed into the [], it all turned out to be finished.
For example, I typed the example in yr README.md:

- [ ] Pending
- [.] In progress 
- [~] Won't do
- [x] Done

and it just showed this:

Could it be because I changed some files before?
FYI, I changed my css before:

my current Obsidian version is v1.5.3(Installer version v1.4.13), and I'm running Obsidian on Window11

Bug: fix ordering of settings

"Use full filepath" should be above "Include not started tasks"

[Feature] Support nested todos items

Hello, came across your plugin in an attempt to find something to collate all my various todo's throughout my vault.

Is it possible to have it so that any checkboxes that have nested checkboxes display as such on the generated list? I tend to group my todos in chunks and so having them all just display in the same order means I lose quite a bit of context on them.

Thanks!

Add settings to TODO generator

Settings to add:

• include finished
• show full filepath for linked docs

Auto update TODO file

Automatically update the TODO file in response to events: https://docs.obsidian.md/Plugins/Events

Not rendering in reading view

Hello, maybe it is my workstation, but the checkbox like "in progress" or "won't do" for example isn't rendering in reading view, only in live preview
In reading view, the checkbox of obsidian is the only rendering final like into the screenshot

Reading view :

Live preview :