Run tests against clojure-ts-mode

Includes top level "main" tests, plus an additional
clojure-ts-mode/* tests.

This also tries to install the language grammar in the CI environment.
Git and CC are required. This works in github actions

Author: dannyfreeman

.github/workflows/test.yml

@@ -99,4 +99,8 @@ jobs:
         cd dev; ../clojure.sh clojure -M:gen; cd -
         wc -l test/File.edn
         eldev -p -dtTC test --test-type enrich || eldev -p -dtTC test --test-type enrich
-        
+
+    - name: Test clojure-ts-mode
+      if: startsWith (matrix.emacs_version, '29')
+      run: |
+        eldev -p -dtTC test --test-type clojure-ts-mode || eldev -p -dtTC test --test-type clojure-ts-mode

Eldev

@@ -23,25 +23,34 @@
 (setf eldev-standard-excludes `(:or ,eldev-standard-excludes
                                     ;; Avoid including files in test "projects".
                                     (eldev-pcase-exhaustive cider-test-type
-                                                            (`main        "./test/*/")
-                                                            (`integration '("./test/"   "!./test/integration"))
-                                                            (`enrich      '("./test/"   "!./test/enrich"))
-                                                            (`all         '("./test/*/" "!./test/integration")))
+                                                            (`main            "./test/*/")
+                                                            (`integration     '("./test/"   "!./test/integration"))
+                                                            (`enrich          '("./test/"   "!./test/enrich"))
+                                                            (`clojure-ts-mode '("./test/*/" "!./test/clojure-ts-mode"))
+                                                            (`all             '("./test/*/" "!./test/integration")))
                                     "test/integration/projects"
                                     ;; This file is _supposed_ to be excluded
                                     ;; from automated testing.
                                     "test/cider-tests--no-auto.el"))
 
 (eldev-defoption cider-test-selection (type)
-  "Select tests to run; type can be `main', `integration', `enrich' or `all'"
+  "Select tests to run; type can be `main', `integration', `enrich', `clojure-ts-mode' or `all'"
   :options        (-T --test-type)
   :for-command    test
   :value          TYPE
   :default-value  cider-test-type
-  (unless (memq (intern type) '(main integration enrich all))
+  (unless (memq (intern type) '(main integration enrich clojure-ts-mode all))
     (signal 'eldev-wrong-option-usage `("unknown test type `%s'" ,type)))
   (setf cider-test-type (intern type)))
 
+(add-hook 'eldev-load-dependencies-hook
+          (lambda (type additional-sets)
+            (when (and (eq cider-test-type 'clojure-ts-mode)
+                       (member 'runtime additional-sets))
+              (message "Installing tree-sitter grammars")
+              (require 'clojure-ts-mode)
+              (clojure-ts--ensure-grammars))))
+
 (add-hook 'eldev-test-hook
           (lambda ()
             (eldev-verbose "Using cider tests of type `%s'" cider-test-type)))

test/cider-selector-tests.el

@@ -29,39 +29,27 @@
 
 (require 'buttercup)
 (require 'cider-selector)
+(require 'cider-selector-test-utils "test/utils/cider-selector-test-utils")
 (require 'cider-connection-test-utils "test/utils/cider-connection-test-utils")
 
 ;; Please, for each `describe', ensure there's an `it' block, so that its execution is visible in CI.
 
 ;; selector
-(defun cider-invoke-selector-method-by-key (ch)
-  (let ((method (cl-find ch cider-selector-methods :key #'car)))
-    (funcall (cl-third method))))
-
-(defun cider--test-selector-method (method buffer-mode buffer-name)
-  (with-temp-buffer
-    (rename-buffer buffer-name)
-    (setq major-mode buffer-mode)
-    (let ((expected-buffer (current-buffer)))
-      ;; switch to another buffer
-      (with-temp-buffer
-        (cider-invoke-selector-method-by-key method)
-        (expect (current-buffer) :to-equal expected-buffer)))))
 
 (describe "cider-seletor-method-c"
   (it "switches to most recently visited clojure-mode buffer"
-    (cider--test-selector-method ?c 'clojure-mode "*testfile*.clj")))
+    (cider-test-selector-method ?c 'clojure-mode "*testfile*.clj")))
 
 (describe "cider-seletor-method-e"
   (it "switches to most recently visited emacs-lisp-mode buffer"
     (kill-buffer "*scratch*")
-    (cider--test-selector-method ?e 'emacs-lisp-mode "*testfile*.el")))
+    (cider-test-selector-method ?e 'emacs-lisp-mode "*testfile*.el")))
 
 (describe "cider-seletor-method-r"
   :var (cider-current-repl)
   (it "switches to current REPL buffer"
     (spy-on 'cider-current-repl :and-return-value "*cider-repl xyz*")
-    (cider--test-selector-method ?r 'cider-repl-mode "*cider-repl xyz*")))
+    (cider-test-selector-method ?r 'cider-repl-mode "*cider-repl xyz*")))
 
 ;; FIXME: should work but doesn't with a nonsense error
 ;; (describe "cider-selector-method-m"
@@ -70,18 +58,18 @@
 ;;       (with-repl-buffer "a-session" 'clj _
 ;;         (setq-local nrepl-messages-buffer buf)
 ;;         (message "%S" (nrepl-messages-buffer (cider-current-repl)))
-;;         (cider--test-selector-method ?m nil "*nrepl-messages some-id*")))))
+;;         (cider-test-selector-method ?m nil "*nrepl-messages some-id*")))))
 
 (describe "cider-seletor-method-x"
   (it "switches to *cider-error* buffer"
-    (cider--test-selector-method ?x 'cider-stacktrace-mode "*cider-error*")))
+    (cider-test-selector-method ?x 'cider-stacktrace-mode "*cider-error*")))
 
 (describe "cider-seletor-method-d"
   (it "switches to *cider-doc* buffer"
-    (cider--test-selector-method ?d 'cider-stacktrace-mode "*cider-doc*")))
+    (cider-test-selector-method ?d 'cider-stacktrace-mode "*cider-doc*")))
 
 (describe "cider-seletor-method-s"
   :var (cider-scratch-find-or-create-buffer)
   (it "switches to *cider-scratch* buffer"
     (spy-on 'cider-scratch-find-or-create-buffer :and-return-value "*cider-scratch*")
-    (cider--test-selector-method ?s 'cider-docview-mode "*cider-scratch*")))
+    (cider-test-selector-method ?s 'cider-docview-mode "*cider-scratch*")))

test/cider-util-tests.el

@@ -374,3 +374,21 @@ and some other vars (like clojure.core/filter).
       (expect (cider--find-symbol-xref) :to-equal "clojure.core/map")
       (expect (cider--find-symbol-xref) :to-equal "clojure.core/filter")
       (expect (cider--find-symbol-xref) :to-equal nil))))
+
+(describe "major-mode-predicates"
+  (with-temp-buffer
+    (it "matches clojure-mode"
+      (clojure-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :not :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :not :to-be-truthy))
+    (it "matches clojurescript-mode"
+      (clojurescript-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :not :to-be-truthy))
+    (it "matches clojurec-mode"
+      (clojurec-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :not :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :to-be-truthy))))

test/clojure-ts-mode/cider-connection-ts-tests.el

@@ -0,0 +1,60 @@
+;;; cider-connection-ts-tests.el  -*- lexical-binding: t; -*-
+
+;; Copyright © 2012-2023 Tim King, Bozhidar Batsov
+
+;; Author: Tim King <kingtim@gmail.com>
+;;         Bozhidar Batsov <bozhidar@batsov.dev>
+;;         Artur Malabarba <bruce.connor.am@gmail.com>
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software: you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation, either version 3 of the
+;; License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see `http://www.gnu.org/licenses/'.
+
+;;; Commentary:
+
+;; This file is part of CIDER
+
+;;; Code:
+
+(require 'buttercup)
+(require 'clojure-ts-mode)
+(require 'cider-connection)
+
+(describe "Enable cider-minor mode on clojure-ts-mode buffers"
+  (setq clojure-ts-mode-hook nil)
+  (with-temp-buffer
+    (clojure-ts-mode)
+    (it "should enable cider-mode in the clojure-ts-mode buffer"
+      (cider-enable-on-existing-clojure-buffers)
+      (expect local-minor-modes :to-contain 'cider-mode)
+      (expect clojure-ts-mode-hook :to-contain #'cider-mode))
+    (it "should disable cider-mode in the clojure-ts-mode-buffer"
+      (cider-disable-on-existing-clojure-buffers)
+      (expect local-minor-modes :not :to-contain 'cider-mode))))
+
+(describe "cider-repl-type-for-buffers"
+  (it "correctly detects corresponding repl type based on clojure-ts-* major mode"
+    (with-temp-buffer
+      (clojure-ts-mode)
+      (expect (cider-repl-type-for-buffer) :to-be 'clj))
+    (with-temp-buffer
+      (clojurescript-ts-mode)
+      (expect (cider-repl-type-for-buffer) :to-be 'cljs))
+    (with-temp-buffer
+      (clojurec-ts-mode)
+      (expect (cider-repl-type-for-buffer) :to-be 'multi))))
+
+(provide 'cider-connection-ts-tests)
+
+;;; clojure-connection-ts-tests.el ends here

test/clojure-ts-mode/cider-selector-ts-tests.el

@@ -0,0 +1,40 @@
+;;; cider-selector-ts-tests.el  -*- lexical-binding: t; -*-
+
+;; Copyright © 2012-2023 Tim King, Bozhidar Batsov
+
+;; Author: Tim King <kingtim@gmail.com>
+;;         Bozhidar Batsov <bozhidar@batsov.dev>
+;;         Artur Malabarba <bruce.connor.am@gmail.com>
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software: you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation, either version 3 of the
+;; License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see `http://www.gnu.org/licenses/'.
+
+;;; Commentary:
+
+;; This file is part of CIDER
+
+;;; Code:
+
+(require 'buttercup)
+(require 'clojure-ts-mode)
+(require 'cider-selector-test-utils "test/cider-selector-tests")
+
+(describe "cider-seletor-method-c"
+  (it "switches to most recently visited clojure-ts-mode buffer"
+    (cider-test-selector-method ?c 'clojure-ts-mode "*treesitter-test*.clj")))
+
+(provide 'cider-selector-ts-tests)
+
+;;; clojure-selector-ts-tests.el ends here

test/clojure-ts-mode/cider-util-ts-tests.el

@@ -0,0 +1,61 @@
+;;; cider-util-ts-tests.el  -*- lexical-binding: t; -*-
+
+;; Copyright © 2012-2023 Tim King, Bozhidar Batsov
+
+;; Author: Tim King <kingtim@gmail.com>
+;;         Bozhidar Batsov <bozhidar@batsov.dev>
+;;         Artur Malabarba <bruce.connor.am@gmail.com>
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software: you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation, either version 3 of the
+;; License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see `http://www.gnu.org/licenses/'.
+
+
+;;; Commentary:
+
+;; This file is part of CIDER
+
+;;; Code:
+
+(require 'buttercup)
+(require 'clojure-ts-mode)
+(require 'cider-util)
+
+(describe "clojure-ts-mode activation"
+  (it "test suite installs the tree-sitter-clojure grammar"
+    (with-temp-buffer
+      (clojure-ts-mode)
+      (expect (treesit-ready-p 'clojure)))))
+
+(describe "major-mode-predicates"
+  (with-temp-buffer
+    (it "matches clojure-ts-mode"
+      (clojure-ts-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :not :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :not :to-be-truthy))
+    (it "matches clojurescript-ts-mode"
+      (clojurescript-ts-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :not :to-be-truthy))
+    (it "matches clojurec-ts-mode"
+      (clojurec-ts-mode)
+      (expect (cider-clojure-major-mode-p) :to-be-truthy)
+      (expect (cider-clojurescript-major-mode-p) :not :to-be-truthy)
+      (expect (cider-clojurec-major-mode-p) :to-be-truthy))))
+
+(provide 'cider-ts-util-tests)
+
+;;; cider-util-ts-tests.el ends here

test/utils/cider-selector-test-utils.el

@@ -0,0 +1,49 @@
+;;; cider-selector-test-utils.el  -*- lexical-binding: t; -*-
+
+;; Copyright © 2012-2023 Tim King, Bozhidar Batsov
+
+;; Author: Tim King <kingtim@gmail.com>
+;;         Bozhidar Batsov <bozhidar@batsov.dev>
+;;         Artur Malabarba <bruce.connor.am@gmail.com>
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software: you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation, either version 3 of the
+;; License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see `http://www.gnu.org/licenses/'.
+
+;;; Commentary:
+
+;; This file is part of CIDER
+
+;;; Code:
+
+(require 'buttercup)
+(require 'cider-selector)
+
+(defun cider-invoke-selector-method-by-key (ch)
+  (let ((method (cl-find ch cider-selector-methods :key #'car)))
+    (funcall (cl-third method))))
+
+(defun cider-test-selector-method (method buffer-mode buffer-name)
+  (with-temp-buffer
+    (rename-buffer buffer-name)
+    (setq major-mode buffer-mode)
+    (let ((expected-buffer (current-buffer)))
+      ;; switch to another buffer
+      (with-temp-buffer
+        (cider-invoke-selector-method-by-key method)
+        (expect (current-buffer) :to-equal expected-buffer)))))
+
+(provide 'cider-selector-test-utils)
+
+;;; clojure-selector-test-utilss.el ends here