Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Unreleased
v2.0.1 (2024-12-16)
🔁 Changes
- Tweaked the size of icons throughout the plugin.
🐛 Bug Fixes
- Tasks with floating task time timezones are now rendered correctly in the current system timezone.
v2.0.0 (2024-12-15)
Help wanted!
This release has added rudimentary support for translating the plugin into other languages. If you'd like to help out, please see the translation contribution guide.
Note: the style changes in this release mean that you may need to tweak any custom CSS or themes. The changes are designed for the default Obsidian theme.
Breaking changes
- Removed the deprecated settings for rendering the description, due date, labels, or projects. Please use the
show
property in the query. - Removed the
group
property in queries. Please use thegroupBy
property instead.
✨ Features
- Rebuilt the task renderer from the ground up. This now resembles Todoist more closely and has improved the default styling.
- Added support for translations in the plugin
- Added a setting to control whether the embedded "Add task" button in a query should automatically add a link to the current page.
- This behaviour can now be turned off or configured to append to the task name or description.
🔁 Changes
- Tweaked the onboarding modal to hopefully be more reliable in validating the token and allowing you to save the token.
- Greatly reduced plugin startup time. This should improve your vault's load time.
- The setup button in the settings is no longer disabled except when the plugin is validating the token.
v1.13.0 (2024-04-10)
✨ Features
- Rebuilt the onboarding modal that users are presented with upon installing the plugin. This now offers feedback to users based on the token they've provided.
- We also no longer use a native browser alert if the token isn't present. Instead, we prefer to open the modal each time Obsidian is opened if there is no valid token.
- Rebuilt the settings page from scratch. It is now divided into sections to organize the settings.
- Now includes useful links to documentation and GitHub issues.
- API token validation is done in the settings page with an option to open the modal if the validation fails.
- You can now group by different task properties like: priority, due date, and others. Please see the documentation for more details.
- Rebuilt the add task dialog from scratch. This should fix a number of bugs with the date picker, improves the UX, and brings it inline with the native Todoist experience.
- Added a new command 'Add task with current page in task description' which offers the ability to append a link to the current page to the task description when it is created.
- Added support for adding time to due dates in the "create task" modal.
🔁 Changes
- Added rendered deprecation warnings to queries. Please follow the warnings to avoid breaking changes in the future!
🐛 Bug Fixes
- The
priorityAscending
andpriorityDescending
options now sort tasks in the correct order.
v1.12.0 (2024-02-09)
Note: the style changes in this release mean that you may need to tweak any custom CSS or themes. The changes are based on the default theme.
Deprecated
- Please note that the "Render Descriptions", "Render Dates", "Render project & section", and "Render labels" settings are now deprecated. You can now control whether these render or not via the
show
property in the query itself. These will be removed in a future release.
✨ Features
- Added the option to wrap page links in parenthesis when creating tasks with the command. You may find this useful if you primarily use Todoist on mobile where links are less obvious. Thanks to @ThDag for the contribution!
- You can now use the
{{filename}}
placeholder in the filter property. This will be replaced with the name of the file where the query is defined.- For example, if the full file path is
My Vault/Notes/How to Take Smart Notes.md
then the replaced file name will beHow to Take Smart Notes
.
- For example, if the full file path is
- Added "Add item" button to rendered queries. This will open the task creation modal.
- Added the ability to control which elements of the task metadata render with tasks inside the query with the
show
keyword. - You can now sort by when the task was added to Todoist using
dateAdded
anddateAddedAscending
sort options. - The div rendered when there are no tasks returned by a query now has a
todoist-no-tasks
class to allow you to customize the CSS.
🔁 Changes
- You can now toggle whether or not task descriptions are rendered for each task.
- Change the style of the sync button to match the Obsidian style of the "edit" codeblock button.
- Fix intent level to match standard markdown levels in order to have consistent style.
- Aligned the grouping behaviour with Todoist's when grouping by project. This will be expanded on in a future release.
- Changed all icons to be part of the Lucide set to align with Obsidian.
- The
title
part of the query is now optional.
🐛 Bug Fixes
- Opening tasks via the context menu should now work properly on mobile devices.
v1.11.1 (2023-04-09)
🐛 Bug Fixes
- Task completions should now behave properly.
v1.11.0 (2023-04-08)
✨ Features
- You can now use YAML for writing your Todoist queries.
- Tasks that are due today now have the
task-today
CSS class. - Task descriptions are now rendered with the task.
- If the description is multiple lines or has complex Markdown, it is rendered as a preview.
- The preview can be expanded and closed by double-clicking on the preview.
- The task description can now be set from the 'Add Todoist task' modal.
🔁 Changes
- Improved the alignment of the task metadata for the default Obsidian theme.
🐛 Bug Fixes
- Using the 'Add Todoist Task' command should correctly use the selection in an editor pane.
- Subtask lists should no longer display erroneous messages when all the subtasks are closed.
- Fixed logical bugs in handling failures when marking a task as done.
⚙ Internal
- Ensured that all API requests to Todoist have debug & error logging.
v1.10.1 (2022-12-22)
🐛 Bug Fixes
- Requests to Todoist's API should no longer fail CORS checks.
v1.10.0 (2022-10-17)
✨ Features
- You can now press 'Enter' in the create task dialog to create the task. Thanks to @oleeskild
- This plugin's default styles updated to the new theme in Obsidian v1.0.
🔁 Changes
- The priority CSS classes now appear on the outer
div
for a given task. This should allow you to style the entire task, not just the checkbox/description.
🐛 Bug Fixes
- The plugin should now respect your Vault configuration directory when saving your Todoist token.
⚙ Internal
- This plugin now uses the Todoist REST API v2. Thanks to @gnapse!
v1.9.0 (2022-01-19)
✨ Features
- This plugin is now compatible with live preview! Please report any functionality regressions in this mode.
[1.8.1] - 2021-08-24
🐛 Bug Fixes
- Token path location should no longer be incorrect on Linux machines.
v1.8.0 (2021-08-07)
✨ Features
- This plugin is now compatible with Obsidian on mobile devices!
- All task lists created by this plugin now also have the
todoist-task-list
CSS class on them for easier styling. - Added the ability to fold the projects & section groupings when using the grouped task list view.
- Added an additional sorting option
dateDescending
. This behaves the opposite of the sorting optiondate
.
🐛 Bug Fixes
- The date picker in the 'Add task' modal works correctly with more themes.
v1.7.1 (2021-06-17)
🐛 Bug Fixes
- Right-click context menu now works with the latest Obsidian version.
v1.7.0 (2021-01-24)
✨ Features
- Markdown within tasks is now rendered as part of the task. This means that bold, italics and inline code blocks are supported, as are links (both internal and external).
- Uncompletable tasks have a
disabled
checkbox, this may look different depending on your theme, but it will stop you completing these tasks accidentally. - You can now template the number of tasks returned by the query in the query name by using
{task_count}
- For example, setting the name to
Tasks ({task_count})
will render asTasks (10)
if there are 10 tasks returned by the query.
- For example, setting the name to
- Right clicking on a task will now open a context menu where you can either complete the task or open it in the browser or application.
v1.6.2 (2021-01-13)
🔁 Changes
- Removed built-in update checker as Obsidian has one for plugins now!
🐛 Bug Fixes
- Fixed an issue where queries didn't resolve on first load.
v1.6.1 (2021-01-06)
🐛 Bug Fixes
- Refreshing tasks no longer causes any existing task to disappear and then reappear.
- Use
MarkdownRenderChild
correctly to prevent potential memory leaks.
v1.6.0 (2020-12-31)
✨ Features
- A long awaited and requested feature is finally here! You can create Todoist tasks from within Obsidian.
- This is accessible through a command which will open a modal for the task details.
- There is a second command which will append the link to the current active page at the end of the Todoist task.
- Any selected text under the cursor will be pre-filled as the task text.
- This does not support Todoist's syntax such as '#' for projects, '@' for labels, and smart date recognition.
- Improved the setup of the plugin. Now the plugin will prompt you for an API token on launch and you can set the token through the settings.
- There is now a message rendered if your query returns no tasks.
- Add default CSS for the default Obsidian theme.
🔁 Changes
- The 'Refresh Metadata' command no longer has a duplicate 'Todoist' identifier in front of it.
🐛 Bug Fixes
- JSON parsing errors are now correctly handled and displayed to the user.
⚙ Internal
- Refactored component injection to use the
MarkdownPostProcessor
API.
v1.5.0 (2020-10-31)
✨ Features
- This plugin is now compatible with the official Obsidian API. It was developed against Obsidian 0.9.10.
v1.4.0 (2020-10-19)
Along with this release, I've released an Obsidian theme which has built-in support for this plugin! 🎉
Check it out at jamiebrynes7/moonlight-obsidian-theme!
✨ Features
- The version of the plugin is now displayed in the settings tab along with a link to the changelog.
- You can specify that the result of a query should be grouped by project & section. To do this, add the
"group": true
field to the JSON query.{
"name": "My Tasks",
"filter": "today | overdue",
"group": true
} - You can now check for plugin updates in the Todoist plugin settings.
- The JSON query is now validated and errors are presented in a more user-friendly fashion.
- Any
workspace-leaf
which has an injected query will have thecontains-todoist-query
CSS class attached. This allows you to style these leafs independently of the others.
🔃 Changed
- Errors are displayed more prominently in the injected Todoist query.
⚙ Internal
- Added the ability to turn on debug logging in the plugin.
v1.3.1 (2020-09-18)
🐛 Bug Fixes
- Fixed an issue where the 'Render labels' setting did not work.
v1.3.0 (2020-09-17)
✨ Features
-
Tasks now render labels under them by default. This can be toggled in the settings (along with the accompanying icon).
-
Tasks now render projects & section under them by default. This can be toggled in the settings (along with the accompanying icon).
-
The layout of the project, date, and label combo can be configured in CSS. For example:
/* To make date & project sit inline */
.task-metadata {
display: inline;
}
/* To make date & project sit on top of each other. */
.task-metadata {
display: block;
}
-
-
There is a new command
Todoist: Refresh Metadata
which will re-fetch your projects, sections, and labels. If you add/remove/rename these, you should refresh the metadata. This is done automatically at startup. -
Added
contains-task-list
to match latest Obsidian styling. -
The entire task (
li
element) has thetask-overdue
class on it, in addition to the date element specifically. -
The task (
li
element) has eitherhas-time
orhas-no-time
derived from the date field. (No date or time will also havehas-no-time
). -
Add support for Obsidian v0.8.14
🐛 Bug Fixes
- Fixed a bug where tasks with datetimes were sometimes sorted incorrectly.
v1.2.2 (2020-09-06)
🐛 Bug Fixes
- Fixed an issue where the
task-overdue
status would disappear if a task above it was checked off.
v1.2.1 (2020-09-06)
🐛 Bug Fixes
- Fixed an issue where subtasks would cause errors with sorting.
v1.2.0 (2020-09-05)
✨ Features
- Subtasks are now nested under their parent if both are included in the filter. If a subtask is captured by a filter, but the parent is not, it will be listed as a top level item. You may need to adjust your priority CSS to accommodate these changes. For example:
+ .todoist-p1 > input[type="checkbox"] {
- .todoist-p1 input[type="checkbox"] {
/* This matches against the input element rendered for a priority 1 task. */
} - Tasks now render dates under them by default. This can be toggled in the settings (along with some the accompanying icon). If you choose to use icons, I recommend you at least add the following CSS to your own (tweaking may be required based on your theme):
.task-calendar-icon {
vertical-align: middle;
height: 17px;
width: 17px;
} - Added support for controlling the ordering of the rendered tasks. This can be done by either priority or date, or a combination of them (e.g. - sort by priority, then by date). To use this feature, amend your queries:
```json
{
"name": "My Tasks",
"filter": "today | overdue",
"autorefresh": 30,
"sorting": ["date", "priority"]
}
```
⚙ Internal
- Ported the plugin to (almost entirely) Typescript.
v1.1.0 (2020-08-31)
✨ Features
- Each rendered task's CSS now contains information about the task's priority. You can use this information to style each priority differently. These classes are
todoist-p1
,todoist-p2
,todoist-p3
, andtodoist-p4
. For example:.todoist-p1 input[type="checkbox"] {
/* This matches against the input element rendered for a priority 1 task. */
} - When a task is removed or added, it now transitions with a smooth fading effect, rather than immediately being added/removed. This can be turned off in the settings.
- Added support for auto-refreshing queries. This can be set at a global level within the settings tab or overridden for each individual query. For example:
```json
{
"name": "My Tasks",
"filter": "today | overdue",
"autorefresh": 30
}
``` - Added a setting tab in the Obsidian setting menu. There are three settings included in this release:
- "Task fade animation" - controls whether to use the fade animation
- "Auto-refresh" - controls whether all queries should auto-refresh
- "Auto-refresh interval" - controls the default interval for auto-refreshing queries
🔃 Changes
- The rendered task list now uses the ordering as defined by the Todoist API.
🐛 Bug Fixes
- The injected Todoist query components are correctly destroyed when removed from the DOM.
v1.0.0 (2020-08-29)
This was the initial release of the Obsidian x Todoist plugin. It contained the basic functionality for:
- materializing tasks in an Obsidian note
- allowing you to check tasks off from an Obsidian note