Merge pull request #29 from liquidz/dev

liquidz · web-flow · commit 3463c1e31ca8 · 2025-03-08T13:22:18.000+09:00
Next release
diff --git a/.clj-kondo/metosin/malli-types-clj/config.edn b/.clj-kondo/metosin/malli-types-clj/config.edn
@@ -226,7 +226,12 @@
                                                                                                                  :component/clj-kondo :any}}
                                                                                                           :sequential],
                                                                                                    :ret :any}}}},
-                                        elin.function.sexpr {get-top-list {:arities {3 {:args [{:op :keys,
+                                        elin.function.sexpr {validate-code-and-position {:arities {1 {:args [{:op :keys,
+                                                                                                              :req {:code :string,
+                                                                                                                    :lnum :int,
+                                                                                                                    :col :int}}],
+                                                                                                      :ret :any}}},
+                                                             get-top-list {:arities {3 {:args [{:op :keys,
                                                                                                 :req {:message {:op :keys,
                                                                                                                 :req {:method :keyword}},
                                                                                                       :component/nrepl :any,
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -1,5 +1,21 @@
 All notable changes to this project will be documented in this file. This change log follows the conventions of http://keepachangelog.com/[keepachangelog.com].
 
+== [2025.3.2-alpha] - 2025-03-07
+
+=== Added
+
+- Add elin.interceptor.test/register-started-at interceptor
+
+=== Fixed
+
+- Update elin.interceptor.test/output-test-result-to-cmdline to show elapsed time
+- Update elin.function.lookup/lookup to support ordered lookup
+- Update elin.handler.lookup/lookup to use lookup-config
+- Update elin.handler.lookup/show-source to use lookup-config
+- Elin.handler.lookup/show-clojuredocs to use lookup-config
+- Update elin.handler.navigate/jump-to-definition to use lookup-config
+- Update elin.handler.navigate/cycle-function-and-test to use lookup-config
+
 == [2025.3.1-alpha] - 2025-03-01
 
 === Fixed
diff --git a/autoload/elin/internal/sexpr.vim b/autoload/elin/internal/sexpr.vim
@@ -45,11 +45,19 @@ endfunction
 if has('nvim') && exists('*nvim_get_runtime_file') && len(nvim_get_runtime_file('parser', v:true)) > 0
 
   function! s:get_top_list(lnum, col) abort
-    return luaeval('require("elin.sexpr").get_top_list(_A[1], _A[2])', [a:lnum - 1, a:col - 1])
+    try
+      return luaeval('require("elin.sexpr").get_top_list(_A[1], _A[2])', [a:lnum - 1, a:col - 1])
+    catch
+      return {'code': '', 'lnum': 0, 'col': 0}
+    endtry
   endfunction
 
   function! s:get_list(lnum, col) abort
-    return luaeval('require("elin.sexpr").get_list(_A[1], _A[2])', [a:lnum - 1, a:col - 1])
+    try
+      return luaeval('require("elin.sexpr").get_list(_A[1], _A[2])', [a:lnum - 1, a:col - 1])
+    catch
+      return {'code': '', 'lnum': 0, 'col': 0}
+    endtry
   endfunction
 
 else
diff --git a/dev/analysis.edn b/dev/analysis.edn
diff --git a/doc/pages/lookup/index.adoc b/doc/pages/lookup/index.adoc
@@ -37,3 +37,41 @@ The result format is defined by configuration file as a https://mustache.github.
 | * https://github.com/liquidz/elin/blob/main/resources/template/clojuredocs.mustache[ClojureDocs]
 
 |===
+
+=== Lookup order
+
+In Elin, there are three types of var lookups: `nrepl`, `clj-kondo`, and `local`.
+
+[%autowidth,cols="a,a"]
+|===
+| Lookup type | Description
+
+| `nrepl`
+| Looking up vars based on information from the nREPL server. Even if a var is not saved in a file, it can still be referenced if it has been evaluated.
+
+| `clj-kondo`
+| Looking up vars based on clj-kondo's analysis results. If a var is not saved in a file and is not reflected in the analysis results, it cannot be referenced.
+
+| `local`
+| Looking up local vars bound with `let`, etc., based on clj-kondo's analysis results. If a var is not saved in a file and is not reflected in the analysis results, it cannot be referenced.
+|===
+
+Each handler has different reference targets and priorities, which can be customized in the configuration file.
+
+[%autowidth,cols="a,a,a"]
+|===
+| Command | Default order | Description
+
+| <<ElinLookup>>
+| `nrepl`, `clj-kondo`
+| `local` is not included in the order because it is not necessary to look up the documentation.
+
+| <<ElinShowSource>>
+| `local`, `nrepl`, `clj-kondo`
+| `local` is prioritized because we'd like to see the local definition first.
+
+| <<ElinShowClojureDocs>>
+| `nrepl`, `clj-kondo`
+| `local` is not included in the order because it is not necessary to look up clojuredocs.
+
+|===
diff --git a/src/elin/function/sexpr.clj b/src/elin/function/sexpr.clj
@@ -9,41 +9,56 @@
    [elin.util.sexpr :as e.u.sexpr]
    [malli.core :as m]))
 
+(m/=> validate-code-and-position [:=> [:cat e.s.host/?CodeAndPosition] (e.schema/error-or e.s.host/?CodeAndPosition)])
+(defn- validate-code-and-position
+  [{:as code-and-position :keys [code]}]
+  (if (seq code)
+    code-and-position
+    (e/not-found)))
+
 (m/=> get-top-list [:function
                     [:-> e.s.handler/?Elin int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]
                     [:-> e.s.handler/?Elin string? int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]])
 (defn get-top-list
   ([{:component/keys [host]} lnum col]
-   (async/<!! (e.p.host/get-top-list-sexpr! host lnum col)))
+   (e/-> (async/<!! (e.p.host/get-top-list-sexpr! host lnum col))
+         (validate-code-and-position)))
   ([{:component/keys [host]} path lnum col]
-   (async/<!! (e.p.host/get-top-list-sexpr! host path lnum col))))
+   (e/-> (async/<!! (e.p.host/get-top-list-sexpr! host path lnum col))
+         (validate-code-and-position))))
 
 (m/=> get-list [:function
                 [:-> e.s.handler/?Elin int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]
                 [:-> e.s.handler/?Elin string? int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]])
 (defn get-list
   ([{:component/keys [host]} lnum col]
-   (async/<!! (e.p.host/get-list-sexpr! host lnum col)))
+   (e/-> (async/<!! (e.p.host/get-list-sexpr! host lnum col))
+         (validate-code-and-position)))
   ([{:component/keys [host]} path lnum col]
-   (async/<!! (e.p.host/get-list-sexpr! host path lnum col))))
+   (e/-> (async/<!! (e.p.host/get-list-sexpr! host path lnum col))
+         (validate-code-and-position))))
 
 (m/=> get-expr [:function
                 [:-> e.s.handler/?Elin int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]
                 [:-> e.s.handler/?Elin string? int? int? (e.schema/error-or e.s.host/?CodeAndPosition)]])
 (defn get-expr
   ([{:component/keys [host]} lnum col]
-   (async/<!! (e.p.host/get-single-sexpr! host lnum col)))
+   (e/-> (async/<!! (e.p.host/get-single-sexpr! host lnum col))
+         (validate-code-and-position)))
   ([{:component/keys [host]} path lnum col]
-   (async/<!! (e.p.host/get-single-sexpr! host path lnum col))))
+   (e/-> (async/<!! (e.p.host/get-single-sexpr! host path lnum col))
+         (validate-code-and-position))))
 
 (m/=> get-namespace-sexpr [:function
                            [:=> [:cat e.s.handler/?Elin] (e.schema/error-or e.s.host/?CodeAndPosition)]
                            [:=> [:cat e.s.handler/?Elin string?] (e.schema/error-or e.s.host/?CodeAndPosition)]])
 (defn get-namespace-sexpr
   ([{:component/keys [host]}]
-   (async/<!! (e.p.host/get-namespace-sexpr! host)))
+   (e/-> (async/<!! (e.p.host/get-namespace-sexpr! host))
+         (validate-code-and-position)))
   ([{:component/keys [host]} path]
-   (async/<!! (e.p.host/get-namespace-sexpr! host path))))
+   (e/-> (async/<!! (e.p.host/get-namespace-sexpr! host path))
+         (validate-code-and-position))))
 
 (m/=> replace-list-sexpr [:=> [:cat e.s.handler/?Elin int? int? string?] (e.schema/error-or [:maybe string?])])
 (defn replace-list-sexpr
diff --git a/src/elin/handler/lookup.clj b/src/elin/handler/lookup.clj
@@ -32,17 +32,7 @@
 
 (m/=> lookup [:=> [:cat e.s.handler/?Elin] any?])
 (defn lookup
-  "Look up symbol at cursor position.
-
-  .Configuration
-  [%autowidth.stretch]
-  |===
-  | key | type | description
-
-  | format | todo |  todo
-  | replace-string | todo |  todo
-  | lookup-config | todo |  todo
-  |==="
+  "Look up symbol at cursor position."
   [{:as elin :component/keys [host]}]
   (e/let [{:as config :keys [lookup-config]} (e.u.handler/config elin #'lookup)
           {:keys [lnum col]} (async/<!! (e.p.host/get-cursor-position! host))
diff --git a/test/elin/function/sexpr_test.clj b/test/elin/function/sexpr_test.clj
@@ -16,6 +16,54 @@
     (async/go
       {:code ns-form :lnum 0 :col 0})))
 
+(t/deftest get-top-list-test
+  (let [test-elin (h/test-elin)]
+    (t/testing "Positive"
+      (with-redefs [e.p.host/get-top-list-sexpr! (h/async-constantly {:code "foo" :lnum 1 :col 2})]
+        (t/is (= {:code "foo" :lnum 1 :col 2}
+                 (sut/get-top-list test-elin 0 0)))))
+
+    (t/testing "Negative"
+      (t/testing "Failed to fetch"
+        (with-redefs [e.p.host/get-top-list-sexpr! (h/async-constantly (e/fault))]
+          (t/is (e/fault? (sut/get-top-list test-elin 0 0)))))
+
+      (t/testing "No code"
+        (with-redefs [e.p.host/get-top-list-sexpr! (h/async-constantly {:code "" :lnum 0 :col 0})]
+          (t/is (e/not-found? (sut/get-top-list test-elin 0 0))))))))
+
+(t/deftest get-list-test
+  (let [test-elin (h/test-elin)]
+    (t/testing "Positive"
+      (with-redefs [e.p.host/get-list-sexpr! (h/async-constantly {:code "foo" :lnum 1 :col 2})]
+        (t/is (= {:code "foo" :lnum 1 :col 2}
+                 (sut/get-list test-elin 0 0)))))
+
+    (t/testing "Negative"
+      (t/testing "Failed to fetch"
+        (with-redefs [e.p.host/get-list-sexpr! (h/async-constantly (e/fault))]
+          (t/is (e/fault? (sut/get-list test-elin 0 0)))))
+
+      (t/testing "No code"
+        (with-redefs [e.p.host/get-list-sexpr! (h/async-constantly {:code "" :lnum 0 :col 0})]
+          (t/is (e/not-found? (sut/get-list test-elin 0 0))))))))
+
+(t/deftest get-expr-test
+  (let [test-elin (h/test-elin)]
+    (t/testing "Positive"
+      (with-redefs [e.p.host/get-single-sexpr! (h/async-constantly {:code "foo" :lnum 1 :col 2})]
+        (t/is (= {:code "foo" :lnum 1 :col 2}
+                 (sut/get-expr test-elin 0 0)))))
+
+    (t/testing "Negative"
+      (t/testing "Failed to fetch"
+        (with-redefs [e.p.host/get-single-sexpr! (h/async-constantly (e/fault))]
+          (t/is (e/fault? (sut/get-expr test-elin 0 0)))))
+
+      (t/testing "No code"
+        (with-redefs [e.p.host/get-single-sexpr! (h/async-constantly {:code "" :lnum 0 :col 0})]
+          (t/is (e/not-found? (sut/get-expr test-elin 0 0))))))))
+
 (t/deftest get-namespace-test
   (let [test-elin (h/test-elin)]
     (t/testing "no metadata"
