README file from
GithubTodos Sort Plugin
A plugin for Obsidian that sorts todos by completion status within a note.
Ever wanted to sort your todos by completion status when you open a note? Well, this Obsidian plugin is here to help you! This plugin automatically sorts todos in your notes based on their completion status, making it easier to manage and prioritise your tasks (only on file open - not for every single note edit)
Features
- Automatic Sorting: Automatically sorts todos in your notes whenever a file is opened.
- Four-Tier Priority System: Sorts tasks by status: incomplete → in-progress → completed → canceled.
- Customizable Sort Order: Choose whether completed tasks appear at the top or bottom of your list.
- Efficient Performance: Optimized to handle large notes with minimal performance impact.
- User-Friendly Settings: Easily configure the plugin settings through the Obsidian settings tab.
Task Status Priority
The plugin recognizes four different task statuses and sorts them accordingly:
| Status | Syntax | Description |
|---|---|---|
| Incomplete | - [ ] |
Tasks not yet started (space character) |
| In-Progress | - [/] - [!] |
Tasks in progress (any character except space, x, or -) |
| Completed | - [x] |
Finished tasks |
| Canceled | - [-] |
Canceled/abandoned tasks |
Example
Click any checkbox to toggle it and switch Obsidian Tab (or close the file):
- [x] Update portfolio website
- [ ] Schedule dentist appointment
- [/] Review project proposal (in progress)
- [-] Old task (canceled)
- [ ] Buy groceries
With Completed at bottom (default), becomes:
- [ ] Schedule dentist appointment ← Incomplete tasks first
- [ ] Buy groceries
- [/] Review project proposal (in progress) ← In-progress tasks
- [x] Update portfolio website ← Completed tasks
- [-] Old task (canceled) ← Canceled tasks last
Installation
- Browse to the "Community Plugins" section in your Obsidian settings.
- Search for "Todos Sort".
- Click "Install", then "Enable".
(Or install plugin directly from this link: Todos Sort)
Usage
Once installed and enabled, the plugin will automatically sort todos in your notes based on the selected sort order. You can configure the sort order in the plugin settings:
- Open the Obsidian settings.
- Navigate to the "Todos Sort" tab.
- Choose your preferred sort order:
- Completed at top: Completed tasks will appear at the top of the list.
- Completed at bottom: Completed tasks will appear at the bottom of the list.
Development
To contribute to the development of this plugin, follow these steps:
- Clone the repository:
git clone https://github.com/jsifalda/obsidian-todos-sort.git - Install dependencies:
yarn install - Build the plugin:
yarn run build - Test your changes:
yarn run test
Release Process
To release a new version of the plugin:
- Make and commit your changes.
- Tag the release:
git tag x.x.x - Push the tags:
git push origin --tags
License
This project is licensed under the MIT License. See the LICENSE file for details.
Support the Project
If you find this plugin valuable, consider supporting its development, because it helps me a lot!
Follow me on X/Twitter @jsifalda for updates and announcements! Your support helps maintain and improve this plugin. Every contribution is appreciated and makes a difference. Thank you for your support!
Acknowledgments
- Developed by @jsifalda (forked version of Ryan Gomba)
- Inspired by the need for better task management within Obsidian notes.
