branch: elpa/clojure-ts-mode
commit 7e359edd3e695a81eaa20bd7db5c451ad281a8ef
Author: Roman Rudakov <rruda...@fastmail.com>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Extend docstrings and fix some small issues
---
CHANGELOG.md | 12 ++++++------
clojure-ts-mode.el | 29 +++++++++++++++++++++--------
test/samples/indentation.clj | 1 -
3 files changed, 27 insertions(+), 15 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 18eb45ed74..aca43c6b81 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,12 +5,12 @@
- [#96](https://github.com/clojure-emacs/clojure-ts-mode/pull/96): Highlight
function name properly in `extend-protocol` form.
- [#96](https://github.com/clojure-emacs/clojure-ts-mode/pull/96): Add support
for extend-protocol forms to `clojure-ts-add-arity` refactoring
command.
-- Improve navigation by s-expression by switching to an experimental Clojure
- grammar.
-- More consistent docstrings highlighting and `fill-paragraph` behavior.
-- Fix bug in `clojure-ts-align` when nested form has extra spaces.
-- Fix bug in `clojure-ts-unwind` when there is only one expression after
threading
- symbol.
+- [#99](https://github.com/clojure-emacs/clojure-ts-mode/pull/99): Improve
navigation by s-expression by switching to an experimental
+ Clojure grammar.
+- [#99](https://github.com/clojure-emacs/clojure-ts-mode/pull/99): More
consistent docstrings highlighting and `fill-paragraph` behavior.
+- [#99](https://github.com/clojure-emacs/clojure-ts-mode/pull/99): Fix bug in
`clojure-ts-align` when nested form has extra spaces.
+- [#99](https://github.com/clojure-emacs/clojure-ts-mode/pull/99): Fix bug in
`clojure-ts-unwind` when there is only one expression after
+ threading symbol.
## 0.4.0 (2025-05-15)
diff --git a/clojure-ts-mode.el b/clojure-ts-mode.el
index 53e8ffb182..03a93af85b 100644
--- a/clojure-ts-mode.el
+++ b/clojure-ts-mode.el
@@ -470,7 +470,7 @@ if a third argument (the value) is provided.
:*)
(:match ,clojure-ts--interface-def-symbol-regexp @_def_symbol))))
-(defconst clojure-ts--match-docstring-query-compiled
+(defconst clojure-ts--match-docstring-query
(treesit-query-compile 'clojure (clojure-ts--docstring-query
'@font-lock-doc-face))
"Precompiled query that matches a Clojure docstring.")
@@ -839,9 +839,14 @@ Skip the optional metadata node at pos 0 if present."
t)))
(defun clojure-ts--first-value-child (node)
- "Return the first value child of the NODE.
-
-This will skip metadata and comment nodes."
+ "Returns the first value child of the given NODE.
+
+In the syntax tree, there are a few types of possible child nodes:
+unnamed standalone nodes (e.g., comments), anonymous nodes (e.g.,
+opening or closing parentheses), and named nodes. Named nodes are
+standalone nodes that are labeled by a specific name. The most common
+names are meta and value. This function skips any unnamed, anonymous,
+and metadata nodes and returns the first value node."
(treesit-node-child-by-field-name node "value"))
(defun clojure-ts--symbol-matches-p (symbol-regexp node)
@@ -1363,7 +1368,7 @@ according to the rule. If NODE is nil, use next node
after BOL."
"Match PARENT when it is a docstring node."
(when-let* ((top-level-node (treesit-parent-until parent 'defun t))
(result (treesit-query-capture top-level-node
-
clojure-ts--match-docstring-query-compiled)))
+
clojure-ts--match-docstring-query)))
(seq-find (lambda (elt)
(and (eq (car elt) 'font-lock-doc-face)
(treesit-node-eq (cdr elt) parent)))
@@ -1529,6 +1534,9 @@ function literal."
`((clojure
(sexp ,(regexp-opt clojure-ts--sexp-nodes))
(list ,(regexp-opt clojure-ts--list-nodes))
+ ;; `sexp-default' thing allows to fallback to the default implementation
of
+ ;; `forward-sexp' function where `treesit-forward-sexp' produces undesired
+ ;; results.
(sexp-default
;; For `C-M-f' in "#|(a)" or "#|{1 2 3}"
(,(rx (or "(" "{")) . ,#'clojure-ts--default-sexp-node-p))
@@ -2470,8 +2478,13 @@ before DELIM-OPEN."
"v0.24.3"))
"Intended to be used as the value for `treesit-language-source-alist'.")
-(defun clojure-ts--grammar-outdated-p ()
- "Return TRUE if currently installed grammar is outdated."
+(defun clojure-ts--clojure-grammar-outdated-p ()
+ "Return TRUE if currently installed grammar is outdated.
+
+This function checks if `clojure-ts-mode' is compatible with the
+currently installed grammar. The simplest way to do this is to validate
+a query that is valid in a previous grammar version but invalid in the
+required version."
(treesit-query-valid-p 'clojure '((sym_lit (meta_lit)))))
(defun clojure-ts--ensure-grammars ()
@@ -2483,7 +2496,7 @@ before DELIM-OPEN."
;; If Clojure grammar is available, but outdated, re-install
;; it.
(and (equal grammar 'clojure)
- (clojure-ts--grammar-outdated-p)))
+ (clojure-ts--clojure-grammar-outdated-p)))
(message "Installing %s Tree-sitter grammar" grammar)
;; `treesit-language-source-alist' is dynamically scoped.
;; Binding it in this let expression allows
diff --git a/test/samples/indentation.clj b/test/samples/indentation.clj
index 7d30162b65..52b417e0be 100644
--- a/test/samples/indentation.clj
+++ b/test/samples/indentation.clj
@@ -228,7 +228,6 @@
:foo
"bar"}
-;; NOTE: It works well now with the alternative grammar.
'(one
two ^:foo
three)
