Plugins: Improve Fold/Unfold section key bindings

This commit replaces "Toggle Folding Current Section" via `shift+tab`
by separate fold/unfold commands bound to  default key combinations.

- `primary+shift+[` => `mde_fold_section` => fold current section
- `primary+shift+]` => `mde_unfold_section` => unfold current section

Fixes conflicts with `shift+tab` being also used to unindent text,
which caused unexpected folding in various situations.

Author: deathaxe

Context.sublime-menu

@@ -9,11 +9,11 @@
 			},
 			{
 				"caption": "Fold Section",
-				"command": "mde_fold_section_context"
+				"command": "mde_fold_section"
 			},
 			{
 				"caption": "Unfold Section",
-				"command": "mde_unfold_section_context"
+				"command": "mde_unfold_section"
 			},
 			{
 				"caption": "-",

Default (Linux).sublime-keymap

@@ -678,24 +678,20 @@
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw", "match_all": true }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["ctrl+shift+["], "command": "mde_fold_section", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "preceding_text", "operator": "not_regex_match", "operand": "^\\s+", "match_all": true }
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["ctrl+shift+]"], "command": "mde_unfold_section", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": false, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "text", "operator": "regex_contains", "operand": "^(#{1,6}(?!#))|^(-{3,}|={3,})$"}
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
 	{ "keys": ["ctrl+shift+tab"], "command": "mde_show_fold_all_sections", "context":

Default (OSX).sublime-keymap

@@ -678,24 +678,20 @@
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw", "match_all": true }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["super+shift+["], "command": "mde_fold_section", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "preceding_text", "operator": "not_regex_match", "operand": "^\\s+", "match_all": true }
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["super+shift+]"], "command": "mde_unfold_section", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": false, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "text", "operator": "regex_contains", "operand": "^(#{1,6}(?!#))|^(-{3,}|={3,})$"}
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
 	{ "keys": ["ctrl+shift+tab"], "command": "mde_show_fold_all_sections", "context":

Default (Windows).sublime-keymap

@@ -678,24 +678,20 @@
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw", "match_all": true }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["ctrl+shift+["], "command": "mde_fold_section", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "preceding_text", "operator": "not_regex_match", "operand": "^\\s+", "match_all": true }
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
-	{ "keys": ["shift+tab"], "command": "mde_fold_section", "context":
+	{ "keys": ["ctrl+shift+]"], "command": "mde_unfold_section", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - meta.frontmatter - meta.disable-markdown - markup.raw - markup.list", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.fold_section", "operator": "not_equal", "operand": true },
-			{ "key": "selection_empty", "operator": "equal", "operand": false, "match_all": true },
 			{ "key": "has_prev_field", "operator": "equal", "operand": false },
-			{ "key": "overlay_visible", "operator": "equal", "operand": false },
-			{ "key": "text", "operator": "regex_contains", "operand": "^(#{1,6}(?!#))|^(-{3,}|={3,})$"}
+			{ "key": "overlay_visible", "operator": "equal", "operand": false }
 		]
 	},
 	{ "keys": ["ctrl+shift+tab"], "command": "mde_show_fold_all_sections", "context":

Default.sublime-commands

@@ -146,9 +146,13 @@
 	//
 
 	{
-		"caption": "MarkdownEditing: Toggle Folding Current Section",
+		"caption": "MarkdownEditing: Fold Current Section",
 		"command": "mde_fold_section"
 	},
+	{
+		"caption": "MarkdownEditing: Unold Current Section",
+		"command": "mde_unfold_section"
+	},
 	{
 		"caption": "MarkdownEditing: Fold Level 1 Sections",
 		"command": "mde_fold_all_sections",

docs/usage.md

@@ -133,14 +133,21 @@ Adding or removing `#` at the beginning of lines also modifies heading levels im
 
 Irrelevant sections of documents can be folded/collapsed via Command Palette:
 
-*   **MarkdownEditing: Toggle Folding Current Section**  
-    Whether child sections are folded or unfolded as well depends on folding level defined by calling one of the following commands.
+*   **MarkdownEditing: Fold Current Section**  
+    Whether child sections are folded depends on folding level defined by calling one of the following commands.
 
-    If `Fold All Sections` was called before _("outline mode" is active)_, the region between current and following sibling or child heading is (un)folded only.
+    If `Fold All Sections` was called before _("outline mode" is active)_, the region between current and following sibling or child heading is folded only.
+
+    If `Unfold All Sections` was called before, all child sections are folded.
+
+*   **MarkdownEditing: Unfold Current Section**  
+    Whether child sections are unfolded depends on folding level defined by calling one of the following commands.
+
+    If `Fold All Sections` was called before _("outline mode" is active)_, the region between current and following sibling or child heading is unfolded only.
 
     If `Fold Level 1-6 Sections` was called before, all child sections with lower level keep folded when unfolding their parent section.
 
-    If `Unfold All Sections` was called before, all child sections are (un)folded.
+    If `Unfold All Sections` was called before, all child sections are unfolded.
 
 *   **MarkdownEditing: Fold Level 1-6 Sections**  
     Folds all sections of headings of specific level. Also hides lower level headings.
@@ -158,7 +165,8 @@ Folding is bound to following keys by default:
 | <kbd>Ctrl</kbd> + <kbd>k</kbd>, <kbd>Ctrl</kbd> + <kbd>0</kbd> | <kbd>⌥</kbd> + <kbd>k</kbd>, <kbd>⌥</kbd> + <kbd>0</kbd> | Unfold all sections
 | <kbd>Ctrl</kbd> + <kbd>k</kbd>, <kbd>Ctrl</kbd> + <kbd>1..6</kbd> | <kbd>⌥</kbd> + <kbd>k</kbd>, <kbd>⌥</kbd> + <kbd>1..6</kbd> | Fold sections by level 1..6
 | <kbd>Ctrl</kbd> + <kbd>k</kbd>, <kbd>Ctrl</kbd> + <kbd>9</kbd> | <kbd>⌥</kbd> + <kbd>k</kbd>, <kbd>⌥</kbd> + <kbd>9</kbd> | Fold all sections, but keep headings of any level visible
-| <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>Tab</kbd> | Fold/Unfold current section.
+| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>[</kbd> | <kbd>^</kbd> + <kbd>⇧</kbd> + <kbd>Tab</kbd> | Fold current section.
+| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>]</kbd> | <kbd>^</kbd> + <kbd>⇧</kbd> + <kbd>Tab</kbd> | Unfold current section.
 | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>^</kbd> + <kbd>⇧</kbd> + <kbd>Tab</kbd> | Fold all sections under headings of a certain level.
 
 ## Automatic Link Url Folding

messages/3.1.9.md

@@ -17,4 +17,8 @@ feedback you can use [GitHub issues][issues].
   This change is required to properly support 3rd-party packages which
   extend default Markdown syntax in ST4.
 
+* Replace "Toggle Folding Current Section" via <kbd>shift+tab</kbd> by 
+  - "Fold Current Section" via <kbd>ctrl+shift+[</kbd>
+  - "Unfold Current Section" via <kbd>ctrl+shift+]</kbd>
+
 [issues]: https://github.com/SublimeText-Markdown/MarkdownEditing/issues

plugin.py

@@ -32,10 +32,9 @@
         MdeFoldLinksCommand,
         MdeFoldLinksListener,
         MdeFoldSectionCommand,
-        MdeFoldSectionContextCommand,
         MdeShowFoldAllSectionsCommand,
         MdeUnfoldAllSectionsCommand,
-        MdeUnfoldSectionContextCommand,
+        MdeUnfoldSectionCommand,
     )
     from .plugins.footnotes import (
         MdeGatherMissingFootnotesCommand,

plugins/folding.py

@@ -208,7 +208,7 @@ class MdeFoldSectionCommand(MdeTextCommand):
     """
     This class describes a `mde_fold_section` command.
 
-    The command folds or unfolds sections at least one caret is within.
+    The command folds sections at least one caret is within.
 
     It's behavior depends on former call of `mde_fold_all_secitons` command and
     the active `mde.folding.target_level` setting respectively.
@@ -222,98 +222,98 @@ class MdeFoldSectionCommand(MdeTextCommand):
         keep folded if their parent section is unfolded.
     """
 
-    def description(self):
-        return "Toggle fold/unfold on current section"
+    def is_enabled(self):
+        view = self.view
+        target_level = folding_target_level(view)
+        for sel in view.sel():
+            section, _ = section_region_and_level(view, sel.a, target_level)
+            if section:
+                return not bool(folded_region(view, section))
+        return False
 
     def run(self, edit):
         view = self.view
         target_level = folding_target_level(view)
         sections = []
-        levels = []
-        unfold = False
         for sel in view.sel():
             if any(s.contains(sel) for s in sections):
                 continue
-            section, level = section_region_and_level(view, sel.begin(), target_level)
+            section, _ = section_region_and_level(view, sel.begin(), target_level)
             if not section:
                 continue
             folded_section = folded_region(view, section)
-            if folded_section:
-                if folded_section != section:
-                    level = section_level(view, folded_section.begin())
-                sections.append(folded_section)
-                unfold = True
-            else:
+            if not folded_section:
                 sections.append(section)
-            levels.append(level)
-
-        if unfold:
-            regions_to_fold = []
-            if target_level > -1:
-                # keep all child sections folded
-                for section, level in zip(sections, levels):
-                    regions_to_fold.extend(
-                        sections_to_fold(view, section, max(target_level, level + 1))
-                    )
-            else:
-                for section in sections:
-                    regions_to_fold.extend(sections_to_fold(view, section, -1))
-
-            view.unfold(sections)
-            view.fold(regions_to_fold + urls_to_fold(view))
 
-        else:
-            view.fold(sections)
+        view.fold(sections)
 
         sublime.status_message(
-            "{} region{} {}folded".format(
-                len(sections), "s" if len(sections) > 1 else "", "un" if unfold else ""
-            )
+            "{} region{} folded".format(len(sections), "s" if len(sections) > 1 else "")
         )
 
 
-class MdeFoldSectionContextCommand(MdeFoldSectionCommand):
+class MdeUnfoldSectionCommand(MdeTextCommand):
     """
-    This class describes a `mde_fold_section_context` command.
+    This class describes a `mde_unfold_section` command.
+
+    The command unfolds sections at least one caret is within.
+
+    It's behavior depends on former call of `mde_fold_all_secitons` command and
+    the active `mde.folding.target_level` setting respectively.
+
+    -1: The whole section, including all child sections is folded and unfolded.
+        The folded region begins after the nearest heading found before a caret's
+        position and ends with the next heading of same level after the caret.
+     0: The region between two the headings enclosing the caret's position
+        is folded or unfolded. That's the so called outline mode.
+    >0: Like (-1) but all child sections of higher level then `target_level`
+        keep folded if their parent section is unfolded.
     """
 
-    def is_visible(self):
-        if not super().is_visible():
-            return False
+    def is_enabled(self):
         view = self.view
         target_level = folding_target_level(view)
-        hasSection = False
         for sel in view.sel():
             section, _ = section_region_and_level(view, sel.a, target_level)
             if section:
-                folded = folded_region(view, section)
-                if folded:
-                    return False
-                else:
-                    hasSection = True
-        return hasSection
+                return bool(folded_region(view, section))
+        return False
 
-
-class MdeUnfoldSectionContextCommand(MdeFoldSectionCommand):
-    """
-    This class describes a `mde_unfold_section_context` command.
-    """
-
-    def is_visible(self):
-        if not super().is_visible():
-            return False
+    def run(self, edit):
         view = self.view
         target_level = folding_target_level(view)
-        hasSection = False
+        sections = []
+        levels = []
         for sel in view.sel():
-            section, _ = section_region_and_level(view, sel.a, target_level)
-            if section:
-                folded = folded_region(view, section)
-                if folded:
-                    hasSection = True
-                else:
-                    return False
-        return hasSection
+            if any(s.contains(sel) for s in sections):
+                continue
+            section, level = section_region_and_level(view, sel.begin(), target_level)
+            if not section:
+                continue
+            folded_section = folded_region(view, section)
+            if folded_section:
+                if folded_section != section:
+                    level = section_level(view, folded_section.begin())
+                sections.append(folded_section)
+            levels.append(level)
+
+        regions_to_fold = []
+        if target_level > -1:
+            # keep all child sections folded
+            for section, level in zip(sections, levels):
+                regions_to_fold.extend(
+                    sections_to_fold(view, section, max(target_level, level + 1))
+                )
+        else:
+            for section in sections:
+                regions_to_fold.extend(sections_to_fold(view, section, -1))
+
+        view.unfold(sections)
+        view.fold(regions_to_fold + urls_to_fold(view))
+
+        sublime.status_message(
+            "{} region{} unfolded".format(len(sections), "s" if len(sections) > 1 else "")
+        )
 
 
 class MdeShowFoldAllSectionsCommand(MdeTextCommand):