npm package: @jvaneenwyk/obsidian-checklist
Description: A plugin for Obsidian.md which consolidates todo items into a single view.
Author: Joel Van Eenwyk
Latest version: 2.2.14

# Obsidian Checklist

> ⚠️ This is a fork of the excellent [obsidian-checklist-plugin](https://github.com/delashum/obsidian-checklist-plugin) created by [delashum](https://github.com/delashum). Intention of this repository is to experiment with the plugin to see if it is possible to help with maintaining the plugin over time and potentially adding new features.

This plugin for [Obsidian](https://obsidian.md/) consolidates checklists from across files into a single view.

<!-- markdownlint-disable MD033 -->
<img alt="screenshot-main" src="https://raw.githubusercontent.com/joelvaneenwyk/obsidian-checklist/develop/images/screenshot-two-files.png" width="50%"/>

## Usage

After enabling this plugin, you will see the checklist appear in the right sidebar. If you do not you can run the `Checklist: Open View` command from the command palette to get it to appear.

By default, block of checklist items you tag with `#todo` will appear in this sidebar.

You can complete checklist items by checking them off in your editor (e.g. `- [ ]` -> `- [x]`) or by clicking a checklist item in the sidebar which will update your `.md` file for you

## Configuration

![screenshot-settings](https://raw.githubusercontent.com/joelvaneenwyk/obsidian-checklist/develop/images/screenshot-settings.png)

**Tag name:** The default tag to lookup checklist items by is `#todo`, but may be changed to whatever you like

**Show completed?:** By default the plugin will only show uncompleted tasks, and as tasks are completed they will filter out of the sidebar. You may choose to show all tasks

![screenshot-completed](https://raw.githubusercontent.com/joelvaneenwyk/obsidian-checklist/develop/images/screenshot-show-completed.png)

**Show All Todos In File?:** By default the plugin will only show tasks in the block that is tagged - changing this will show all tasks present in a file if the tag is present anywhere on the page.

**Group by:** You can group by either file or tag name. If you choose to group by tag name they will appear in the order that they first appear in your files (or last depending on sort order)

![screenshot-tags](https://raw.githubusercontent.com/joelvaneenwyk/obsidian-checklist/develop/images/screenshot-sub-tag.png)

**Sort order:** By default checklist items will appear in the order they appear in the file, with files ordered with the oldest at the top. This can be changed to show the newest files at the top.

## Glob File Matching

The "Include Files" setting uses Glob file matching. Specifically the plugin uses [minimatch](https://github.com/isaacs/minimatch) to match the file pattern - so any specific oddities will come from that plugin.

Couple of common examples to help structure your glob:

- `!{_templates/**,_archive/**}` will include everything except for the two directories `_templates` and `_archive`.
- `{Daily/**,Weekly/**}` will only include files in the `Daily` & `Weekly` directories

I recommend the [Digital Ocean Glob Tool](https://www.digitalocean.com/community/tools/glob) for figuring out how globs work - although the implementation is not identical to minimatch so there might be slight differences.