Clojure-aware clojure_sublimed_toggle_comment command

Author: tonsky

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Pretty print selection #123
 - Execute code from inside top-level `; ...` and `#_...` #124
+- Clojure-aware `clojure_sublimed_toggle_comment` command
 - Remove background color on quoted strings inside metadata
 - Better handle eval of `#_` forms in nREPL JVM
 

Default (Linux).sublime-keymap

@@ -54,7 +54,12 @@
  // // Insert New Line
  // {"keys": ["enter"],
  //  "command": "clojure_sublimed_insert_newline",
- //  "context": [{"key": "selector", "operator": "equal", "operand": "source.edn | source.clojure"},
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"},
  //              {"key": "auto_complete_visible", "operator": "equal", "operand": false},
  //              {"key": "panel_has_focus", "operator": "equal", "operand": false}]},
+
+ // // Toggle Comment
+ // {"keys": ["ctrl+/"],
+ //  "command": "clojure_sublimed_toggle_comment",
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"}]},
 ]

Default (OSX).sublime-keymap

@@ -54,7 +54,12 @@
  // // Insert New Line
  // {"keys": ["enter"],
  //  "command": "clojure_sublimed_insert_newline",
- //  "context": [{"key": "selector", "operator": "equal", "operand": "source.edn | source.clojure"},
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"},
  //              {"key": "auto_complete_visible", "operator": "equal", "operand": false},
  //              {"key": "panel_has_focus", "operator": "equal", "operand": false}]},
+
+ // // Toggle Comment
+ // {"keys": ["super+forward_slash"],
+ //  "command": "clojure_sublimed_toggle_comment",
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"}]},
 ]

Default (Windows).sublime-keymap

@@ -54,7 +54,12 @@
  // // Insert New Line
  // {"keys": ["enter"],
  //  "command": "clojure_sublimed_insert_newline",
- //  "context": [{"key": "selector", "operator": "equal", "operand": "source.edn | source.clojure"},
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"},
  //              {"key": "auto_complete_visible", "operator": "equal", "operand": false},
  //              {"key": "panel_has_focus", "operator": "equal", "operand": false}]},
+
+ // // Toggle Comment
+ // {"keys": ["ctrl+/"],
+ //  "command": "clojure_sublimed_toggle_comment",
+ //  "context": [{"key": "selector", "operator": "equal", "operand": "source.clojure"}]},
 ]

Default.sublime-commands

@@ -80,6 +80,10 @@
         "caption": "Clojure Sublimed: Pretty-print selection",
         "command": "clojure_sublimed_pretty_print"
     },
+    {
+        "caption": "Clojure Sublimed: Toggle comment",
+        "command": "clojure_sublimed_toggle_comment"
+    },
     {
         "caption": "Clojure Sublimed: Insert Newline",
         "command": "clojure_sublimed_insert_newline"

cs_indent.py

@@ -1,3 +1,4 @@
+import re
 import sublime, sublime_plugin
 from . import cs_cljfmt, cs_common, cs_parser, cs_printer
 
@@ -158,6 +159,27 @@ def run(self, edit):
             formatted = cs_printer.format(form, node, limit = cs_common.wrap_width(view))
             view.replace(edit, region, formatted)
 
+class ClojureSublimedToggleCommentCommand(sublime_plugin.TextCommand):
+    def run(self, edit):
+        view      = self.view
+        change_id = view.change_id()
+        for region in [r for r in view.sel()]:
+            region = view.transform_region_from(region, change_id)
+            line = view.line(region)
+            line_text = view.substr(line)
+            # uncomment ;
+            if m := re.match(r'^(\s*)(;[;\s]*)(.*)', line_text):
+                view.replace(edit, line, m[1] + m[3])
+                continue
+            parsed = cs_parser.parse_tree(view)
+            # uncomment #_
+            if node := cs_parser.search(parsed, region.begin(), pred = lambda node: node.name == "discard"):
+                view.replace(edit, sublime.Region(node.start, node.body.start), '')
+                continue
+            # prepend ;
+            if m := re.match(r'^(\s*)([^\s].*)', line_text):
+                view.replace(edit, line, m[1] + '; ' + m[2])
+
 def cljfmt_indent(view, point):
     i = None
     try:

cs_parser.py

@@ -363,17 +363,19 @@ def parse_as_dict(string):
         dict[key] = val
     return dict
 
-def search(node, pos, pred = lambda x: True, max_depth = 1000):
+def search(node, pos, pred = None, max_depth = 1000):
     """
     Search inside node what’s the deepest node that includes pos.
     Stops at max_depth and if pred evals to true.
     If two nodes touch around pos, checks both for pred.
     """
     if max_depth <= 0 or not node.children:
-        if pred(node):
+        if not pred or pred(node):
             return node
         else:
             return None
+    if pred and pred(node):
+        return node
     for child in node.children:
         if child.start <= pos <= child.end:
             if res := search(child, pos, pred = pred, max_depth = max_depth - 1):
@@ -388,7 +390,6 @@ def parse_tree(view, region = None):
     """
     Parses current buffer content and return AST
     """
-    id = view.buffer_id()
     text = view.substr(region or sublime.Region(0, view.size()))
     return parse(text)
 
@@ -397,7 +398,6 @@ def symbol_at_point(view, point):
     Returns symbol left/right/around cursor 
     """
     parsed = parse_tree(view)
-    start = time.time()
     if node := search(parsed, point, pred = is_symbol):
         return sublime.Region(node.start, node.end)