Plugins: Add function to reset all tasks

This commit adds `mde_reset_task_list_items` command
to clear all task check marks.

Author: deathaxe

Default (Linux).sublime-keymap

@@ -1084,6 +1084,12 @@
 			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
+	// Reset GFM tasks
+	{ "keys": ["alt+shift+x"], "command": "mde_reset_task_list_items", "context":
+		[
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true }
+		]
+	},
 	// Toggle GFM tasks
 	{ "keys": ["alt+x"], "command": "mde_toggle_task_list_item", "context":
 		[

Default (OSX).sublime-keymap

@@ -1084,6 +1084,12 @@
 			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
+	// Reset GFM tasks
+	{ "keys": ["alt+shift+x"], "command": "mde_reset_task_list_items", "context":
+		[
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true }
+		]
+	},
 	// Toggle GFM tasks
 	{ "keys": ["alt+x"], "command": "mde_toggle_task_list_item", "context":
 		[

Default (Windows).sublime-keymap

@@ -1084,6 +1084,12 @@
 			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
+	// Reset GFM tasks
+	{ "keys": ["alt+shift+x"], "command": "mde_reset_task_list_items", "context":
+		[
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true }
+		]
+	},
 	// Toggle GFM tasks
 	{ "keys": ["alt+x"], "command": "mde_toggle_task_list_item", "context":
 		[

Default.sublime-commands

@@ -205,6 +205,23 @@
 		"command": "mde_switch_list_bullet_type"
 	},
 
+	//
+	// Tasks
+	//
+
+	{
+		"caption": "MarkdownEditing: Insert Task",
+		"command": "mde_insert_task_list_item"
+	},
+	{
+		"caption": "MarkdownEditing: Toggle Task",
+		"command": "mde_toggle_task_list_item"
+	},
+	{
+		"caption": "MarkdownEditing: Reset Tasks",
+		"command": "mde_reset_task_list_items"
+	},
+
 	//
 	// References
 	//

docs/usage.md

@@ -250,7 +250,7 @@ Further available key bindings:
 | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>,</kbd>  | <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>,</kbd> | Decrease block quote level (remove a `> `)
 | <kbd>Ctrl</kbd> + <kbd>Enter</kbd>  | <kbd>⌘</kbd> + <kbd>Enterkbd> | Terminate block quote by adding two newline's.<br/>If the current line is empty, block quote signs are removed.
 
-# Lists and Tasks
+# Lists
 
 List bullets are automatically changed when indenting or unindenting list items by default. This behaviour can be disabled via `"mde.list_indent_auto_switch_bullet": false`.
 
@@ -261,12 +261,24 @@ Following commands are provided via Command Palette:
 *   **Switch List Bullet Type**
     Switches the highlighted list between numbered and bulleted style.
 
+# Tasks
+
+Following commands are provided via Command Palette to manage tasks:
+
+*   **Insert Task**
+    Creates new GFM task (`* [ ] task`)
+*   **Toggle Task**
+    Toggles GFM task check marks (`* [x] task`)
+*   **Reset Tasks**
+    Clear all task check boxes. If non-empty selection exists, only selected tasks are reset.
+
 Following key bindings may be used to create or toggle tasks.
 
 | Linux/Windows | MacOS | Description
 |---------------|-------|-------------
 | <kbd>Alt</kbd> + <kbd>t</kbd>  | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>t</kbd> | Creates new GFM task (`* [ ] task`)
-| <kbd>Alt</kbd> + <kbd>x</kbd>  | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>x</kbd> | Toggles GFM task check marks (`* [x] task`)
+| <kbd>Alt</kbd> + <kbd>Shift</kbd> + <kbd>x</kbd>  | <kbd>⌥</kbd> + <kbd>⇧</kbd> + <kbd>x</kbd> | Clear GFM all (selected) task check marks (`* [0] task`)
+| <kbd>Alt</kbd> + <kbd>x</kbd>  | <kbd>⌥</kbd> + <kbd>x</kbd> | Toggles GFM task check marks (`* [x] task`)
 
 # References
 

plugin.py

@@ -67,6 +67,7 @@
         MdeNumberListCommand,
         MdeSwitchListBulletTypeCommand,
         MdeInsertTaskListItemCommand,
+        MdeResetTaskListItemsCommand,
         MdeToggleTaskListItemCommand,
         MdeJoinLines,
     )

plugins/lists.py

@@ -196,6 +196,49 @@ def run(self, edit):
             self.view.insert(edit, sel.begin(), to_insert)
 
 
+class MdeResetTaskListItemsCommand(MdeTextCommand):
+    """
+    The `mde_reset_task_list_items` command resets check mark of all task list items.
+
+    It must be called in the line of the check mark.
+
+    **Examples:**
+
+    ```markdown
+    # Ordered Task List
+
+    1. [ ] task 1
+    2. [x] task 2
+
+    # Unordered Task List
+
+    * [ ] task 1
+    - [x] task 2
+    + [ ] task 3
+
+    # Quoted Task List
+
+    > * [ ] task 1
+    > * [x] task 2
+    ```
+    """
+
+    def run(self, edit):
+        sels = self.view.sel()
+        if not sels:
+            return
+
+        # list of non-empty selections
+        sels = [sel for sel in sels if not sel.empty()]
+
+        # replace all check marks by space
+        for mark in self.view.find_by_selector(
+            "text.html.markdown markup.list markup.checkbox.mark"
+        ):
+            if not sels or any(mark in sel for sel in sels):
+                self.view.replace(edit, mark, " ")
+
+
 class MdeToggleTaskListItemCommand(MdeTextCommand):
     """
     The `mde_toggle_task_list_item` command toggles the check mark of task list items.