Hi @borkdude, big bravo for your recent work.

seems to work well.

one thing that I noticed which works well, but I was expecting to fail is that (do x) warns that the do is redundant. However if a macro expands to something containing a singleton do this warning is thankfully suppressed. Is that an accident or by design?

by design

how does it know?

the generated nodes are marked as "generated" and the redundant do linter doesn't warn if the node was generated

cool.

so if the macro does something like

`(foo (do 41) ~@user-code)

with :macroexpand it doesn't but with :analyze-call it does, because you can re-use the incoming node

:analyze-call is more powerful, :macroexpand is just for "ease"

I haven't read the HOW-TO yet.

this sort of limitation could be worth noting

Yes, I think we have to emphasize that :macroexpand comes with these trade-offs.

indeed.

but it may be good for people like yourself who are not yet familiar with :analyze-hook and want to get started more quickly

note that :macroexpand will still provide linter warnings for the majority of linters

just not for some of these "redundant" ones

yes it seems like a powerful feature, and easy to use.

I agree

can you give me the link to the HOWTO again please?

https://github.com/clj-kondo/clj-kondo/blob/master/doc/hooks.md

I'd like to add some things to this doc. What should I do?

Make a PR

(pull request)

if you're not familiar with this, there are some docs on the internet explaining how this works. e.g.: https://opensource.com/article/19/7/create-pull-request-github

I have a patch for backtick/template which makes it compatible with clj-kondo Is that something we should include in the clj-kondo repo, or should I try to convince the backtick folks to take it?

I think it depends. What is the patch and which problem does it solve?

it provides a macro expansion for cli-kondo to use. you can't simply copy the default backtick.clj file into the .clj-kondo directory because the interpreter can't underhand direct references to java class names, and a few more issues. I replace (instance? x Boolean) with (boolean? x) and several similar things. These changes theoretically could but sent upstream to the backtick maintainers. However, I had to change one of the throw exception calls in a way which would probably break the code, but doesn't break it as far as clj-kondo is concerned.

seems backtick was last touched 6 years ago.

the boolean? predicate was introduced in clojure 1.9

modifying that library in that way would make it incompatible with clojure 1.8 for example, but that's a trade-off for the lib maintainer to make

@jimka.issy But you could try to provide a "config" with a macro that that library will export

See https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md#exporting-and-importing-configuration

And then users of that library will receive the config automatically, e.g. if they use clojure-lsp

could that be made invisible to the users of backtick? I.e. somewhere in the backtick download would be a .clj-kondo configuration which the system would implicitly know about? Or would each user need to modify his .clj-kondo directory to include copies of the files, or entries in the deps.edn file?

@jimka.issy if the library includes the config in its resources under clj-kondo.exports then it works automatically when you lint the classpath

or would it be something that I (Jim) would provide independent and in parallel to backtick?

you could also do the latter

in the latter case, you could also contribute it to https://github.com/clj-kondo/config

and if users then include that library on their classpath, or install the config for backtick manually it will also work

ah, so if the maintainers of that library are amenable, I could submit a PR to backtick including this configuration?

yes

you could also make your own clj-kondo config project and include that on your own classpath

if you want to keep it completely private

but it's better if people improved one single config over time, probably in the repo of the original library

again, would I hard code a particular sha1 into the deps.edn file of that library? wouldn't that conflict with the sha found elsewhere?

what do you mean by that library in this context?

according to https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md#exporting-and-importing-configuration I need to create a deps.edn file at the top level directory of the backtick library with the following content:

{:deps {clj-kondo/config {:git/url ""
                          :sha "e2e156c53c6c228fee7242629b41013f3e55051d"}}}

no

ahhhh. good thing I asked.

this is when you would include the clj-kondo/config library which would then contain the config for the backtick library

but if you would contribute the config to the backtick library itself, you wouldn't need the clj-kondo/config library

the config is extracted from whatever dependency provides it

it could be your own custom dependency

it doesn't matter

as long as the path starts with clj-kondo.exports inside your dependency

(a better path would maybe have been META-INF/clj-kondo.exports but oh well)

during the linting of dependencies, clj-kondo checks for this and then copies these files into your local config dir

(if you call clj-kondo with --copy-configs, which clojure-lsp does automatically)

so clj-kondo --copy-configs --lint $(clojure -Spath) should copy configs from all dependencies that provide them

ahhh. and I need config.edn inside clj-kondo.exports which contains

{:hooks {
         ;; {:macroexpand {app.bar/baz hook.bar/baz}}}
         :macroexpand {backtick/template     backtick/template}}}

indeed

along with the backtick.clj file which contains the (defmacro ...)

indeed

inside clj-kondo.exports you will need to create a uniquely named dir as well

simple, but I'm not sure how I can test it before submitting the PR

clj-kondo.exports/backtick/backtick/config.edn

(the first backtick is an org name, the second the lib name)

@jimka.issy You can test this by making a local project using :local/root

and then doing what you described in that directory

deps.edn:

{:deps {backtick/backtick {:local/root "/Users/jim/dev/backtick"}}}

(EDITED the above example)

and then calling clj-kondo --copy-configs --lint $(clojure -Spath) should dump the config from /Users/jim/dev/backtick/resources/clj-kondo.exports/backtick/backtick into your local .clj-kondo dir

Note that the backtick library should add a resources directory to accomodate this config

also you will need to add a deps.edn with :paths ["src" "resources"] in backtick or produce a pom.xml from the lein project with lein pom to make :local/root understand it

(it's quite the ceremony)

bash-3.2$ clojure -Spath Error building classpath. Manifest type not detected when finding deps for backtick/backtick in coordinate #:local{:root "/Users/jnewton/Repos/backtick"} bash-3.2$

https://clojurians.slack.com/archives/CHY97NXE2/p1627649831039600

after added deps.edn to backtick, I have the following:

bash-3.2$ clojure -Spath
src:/Users/jnewton/Repos/backtick/src:/Users/jnewton/Repos/backtick/resources:/Users/jnewton/.m2/repository/org/clojure/clojure/1.10.3/clojure-1.10.3.jar:/Users/jnewton/.m2/repository/org/clojure/core.specs.alpha/0.2.56/core.specs.alpha-0.2.56.jar:/Users/jnewton/.m2/repository/org/clojure/spec.alpha/0.2.194/spec.alpha-0.2.194.jar

looks good

what do you mean by: Note that the backtick library should add a `resources` directory to accomodate this config

do I need to create a resources directory in backtick ?

you should put the config inside the resources dir yes

/Users/jim/dev/backtick/resources/clj-kondo.exports/backtick/backtick/config.edn

Make it look like that

I see the following unexpected but understandable message: Imported config to .clj-kondo/backtick/backtick. To activate, add "backtick/backtick" to :config-paths in .clj-kondo/config.edn.

yes, that is expected. In your local config.edn you should then have :config-dirs ["backtick/backtick"]

to activate it

Here is my current config.edn

{:hooks {
         ;; {:macroexpand {app.bar/baz hook.bar/baz}}}
         :macroexpand {clojure-rte.util/print-vals     clojure-rte.util/print-vals,
                       clojure-rte.util/defn-memoized  clojure-rte.util/defn-memoized,
                       clojure-rte.util/defmethod-memoized  clojure-rte.util/defmethod-memoized,
                       clojure-rte.util/exists  clojure-rte.util/exists,
                       clojure-rte.util/setof  clojure-rte.util/setof,
                       clojure-rte.util/forall  clojure-rte.util/forall,
                       clojure-rte.util/forall-pairs  clojure-rte.util/forall-pairs,
                       clojure-rte.util/exists-pair  clojure-rte.util/exists-pair,
                       clojure-rte.util/casep clojure-rte.util/casep,
                       clojure-rte.cl-compat/cl-cond clojure-rte.cl-compat/cl-cond,
                       clojure-rte.cl-compat/with-escape clojure-rte.cl-compat/with-escape
                       clojure-rte.rte-case/rte-case clojure-rte.rte-case/rte-case
                       clojure-rte.rte-case/destructuring-case clojure-rte.rte-case/destructuring-case
                       clojure-rte.rte-case/destructuring-fn clojure-rte.rte-case/destructuring-fn
                       clojure-rte.rte-case/-destructuring-fn-many clojure-rte.rte-case/-destructuring-fn-many
                       clojure-rte.rte-case/dsfn clojure-rte.rte-case/dsfn
                       clojure-rte.rte-case/dscase clojure-rte.rte-case/dscase
                       clojure-rte.typecase/typecase clojure-rte.typecase/typecase
                       ;; backtick/template backtick/template
                       }}}

added :config-dirs parallel with :hooks ?

yes, top-level

hmmm here is my config.edn now

{:config-dirs ["backtick/backtick"]
 :hooks {
         ;; {:macroexpand {app.bar/baz hook.bar/baz}}}
         :macroexpand {clojure-rte.util/print-vals     clojure-rte.util/print-vals,
                       clojure-rte.util/defn-memoized  clojure-rte.util/defn-memoized,
                       clojure-rte.util/defmethod-memoized  clojure-rte.util/defmethod-memoized,
                       clojure-rte.util/exists  clojure-rte.util/exists,
                       clojure-rte.util/setof  clojure-rte.util/setof,
                       clojure-rte.util/forall  clojure-rte.util/forall,
                       clojure-rte.util/forall-pairs  clojure-rte.util/forall-pairs,
                       clojure-rte.util/exists-pair  clojure-rte.util/exists-pair,
                       clojure-rte.util/casep clojure-rte.util/casep,
                       clojure-rte.cl-compat/cl-cond clojure-rte.cl-compat/cl-cond,
                       clojure-rte.cl-compat/with-escape clojure-rte.cl-compat/with-escape
                       clojure-rte.rte-case/rte-case clojure-rte.rte-case/rte-case
                       clojure-rte.rte-case/destructuring-case clojure-rte.rte-case/destructuring-case
                       clojure-rte.rte-case/destructuring-fn clojure-rte.rte-case/destructuring-fn
                       clojure-rte.rte-case/-destructuring-fn-many clojure-rte.rte-case/-destructuring-fn-many
                       clojure-rte.rte-case/dsfn clojure-rte.rte-case/dsfn
                       clojure-rte.rte-case/dscase clojure-rte.rte-case/dscase
                       clojure-rte.typecase/typecase clojure-rte.typecase/typecase
                       ;; backtick/template backtick/template
                       }}}

clojure -M:clj-kondo --copy-configs --lint $(clojure -Spath)

Imported config to .clj-kondo/backtick/backtick. To activate, add "backtick/backtick" to :config-paths in .clj-kondo/config.edn.

ahhhhh config-paths, not config-dirs ..... hold on

bash-3.2$ clojure -M:clj-kondo --copy-configs --lint $(clojure -Spath)
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:30:1: warning: redefined var #'backtick/*resolve*
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:32:1: warning: redefined var #'backtick/*gensyms*
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:37:1: warning: redefined var #'backtick/resolve
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:48:1: warning: redefined var #'backtick/unquote?
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:53:1: warning: redefined var #'backtick/unquote-splicing?
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:102:1: warning: redefined var #'backtick/quote-fn
/Users/jnewton/Repos/backtick/resources/clj-kondo.exports/backtick/backtick/backtick.clj:107:1: warning: redefined var #'backtick/defquote
/U

maybe I need to remove some caches somewhere?

hmm, I think clj-kondo should actually not lint your hook code

I kind of expected this error

removing .cache and .cpcache seems to have no effect.

it should consider namespaces from hook code and application code differently

now it thinks they are the same ;)

bash-3.2$ clojure -M:clj-kondo --copy-configs --lint src
src/clojure_rte/genus.clj:35:31: warning: Unresolved var: template
src/clojure_rte/genus_spec.clj:27:31: warning: Unresolved var: template
src/clojure_rte/rte_case.clj:29:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:37:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:2113:34: warning: unused binding sink-state-id
src/clojure_rte/rte_extract.clj:32:9: warning: unused binding canonicalize-pattern
src/clojure_rte/typecase.clj:25:31: warning: Unresolved var: template
src/clojure_rte/xymbolyco.clj:34:31: warning: Unresolved var: template
linting took 1742ms, errors: 0, warnings: 8

yes, this is the same problem basically. the hook namespace replaces the real namespace. instead, we should just never save the results from linted hook code to the cache

I wonder if clojure if finding the correct template library now?

this warrants another issue on github

so far this wasn't a problem since the hook namespaces were always called differently than application code

sorry, me no understand.

ok, what happens is that clj-kondo lints the backtick library. but while linting it, it also lints the hook namespace code and mistakes it for the original namespace since it has the same name

and then when you use this library from your code, you will see some vars are "unresolved" because they are not in the hook code

instead, clj-kondo should never "replace" the results of linted hook code in the cache

so what triggered clj-kondo to lint the backtick library?

clj-kondo lints your config code as well, that's the problem

ahhh was that the --lint $(clojure -Spath) ?

yes, that code is on the classpath. which was the point, because else it wouldn't have been copied

but clj-kondo just skip linting it

lemme push a quick fix for this

@jimka.issy Can you test commit 07fd7d0ca055e09072d9ea9779e9e5c73e0c0026 of clj-kondo?

oops was away from desk.

bash-3.2$ clojure -M:clj-kondo --copy-configs --lint src
Checking out:  at 07fd7d0ca055e09072d9ea9779e9e5c73e0c0026
src/clojure_rte/genus.clj:35:31: warning: Unresolved var: template
src/clojure_rte/genus_spec.clj:27:31: warning: Unresolved var: template
src/clojure_rte/rte_case.clj:29:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:37:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:2113:34: warning: unused binding sink-state-id
src/clojure_rte/rte_extract.clj:32:9: warning: unused binding canonicalize-pattern
src/clojure_rte/typecase.clj:25:31: warning: Unresolved var: template
src/clojure_rte/xymbolyco.clj:34:31: warning: Unresolved var: template
linting took 1758ms, errors: 0, warnings: 8

yes, re-lint the classpath

bash-3.2$ clojure -M:clj-kondo --copy-configs --lint $(clojure -Spath)
/Users/jnewton/Repos/backtick/src/backtick.clj:58:11: error: Unresolved symbol: template
/Users/jnewton/Repos/backtick/src/backtick.clj:101:11: error: Unresolved symbol: syntax-quote
clojure/core.clj:35:17: warning: unused binding &form
clojure/core.clj:35:23: warning: unused binding &env
clojure/core.clj:40:18: warning: unused binding &form
clojure/core.clj:40:24: warning: unused binding &env
clojure/core.clj:45:20: warning: unused binding &env
clojure/core.clj:210:9: warning: Missing else branch.
clojure/core.clj:223:27: warning: unused binding fdecl
clojure/core.clj:294:17: warning: unused binding &form
clojure/core.clj:294:23: warning: unused binding &env
clojure/core.clj:325:23: warning: Missing else branch.

yes, ok

and now re-lint your src

(you don't need config-configs for that anymore)

bash-3.2$ clojure -M:clj-kondo  --lint src
src/clojure_rte/genus.clj:35:31: warning: Unresolved var: template
src/clojure_rte/genus_spec.clj:27:31: warning: Unresolved var: template
src/clojure_rte/rte_case.clj:29:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:37:31: warning: Unresolved var: template
src/clojure_rte/rte_construct.clj:2113:34: warning: unused binding sink-state-id
src/clojure_rte/rte_extract.clj:32:9: warning: unused binding canonicalize-pattern
src/clojure_rte/typecase.clj:25:31: warning: Unresolved var: template
src/clojure_rte/xymbolyco.clj:34:31: warning: Unresolved var: template
linting took 1690ms, errors: 0, warnings: 8

@borkdude maybe you'd like to join this discussion, in case I've given some false information. https://github.com/brandonbloom/backtick/issues/8

What is the standard way of developing a hook. I added clj-kondo to my deps. I am getting Could not locate clj_kondo/hooks_api.... when evaluating

(ns hooks.macros
  (:require [clj-kondo.hooks-api :as api]))

Following the example here: https://github.com/clj-kondo/clj-kondo/blob/master/doc/hooks.md#transformation

@finn.volkel The hook code runs in an interpreter during linting. You don't actually call it as a library from clojure. You call the API from within the lint config code.

To develop you just call the linter

with some examples

I see thanks

so I added the following line to my config :hooks {:analyze-call {ramper.util.macros/cond-let hooks.macros/cond-let}} , wrote the hook code and tried with

cat src/clj/ramper/util/macros.clj | clj-kondo --lint -

There’s a reference. to clj-kondo.hooks-api in the https://github.com/clj-kondo/clj-kondo/blob/master/doc/hooks.md#custom-lint-warnings. Should that be a reference to a different namespace now?

@ajarosinski No. This namespace is exposed to hook code which is configured to run using the :hooks config

it is not exposed as a library to the JVM for general purpose Clojure programming

@borkdude Thanks for the quick reply; I see. There’s some notification that when using api/sexpr it can’t be resolved, but maybe that’s a Cursive warning

gotcha

It seems like it might be possible to highlight a finding containing multiple nodes on a hook using a row , end-row, col, and end-col. I’m having a bit of trouble doing that. For example, below I’d like to highlight from [:img#pic] through [:#pic-col. Is that possible?

(m/deftemplate
  test-fn
  (resource "") 
  [{:keys [data test-data]}]
  [:img#pic] (if data (m/set :src data) nil)
  [:#pic-col])

Here’s how I’m attempting to register the finding

(when-not (even? (count body))
      (let [{:keys [row col]} (some-> node :children (nth 4) meta)
            end-metadata (some-> node :children last meta)]
        (api/reg-finding! {:message "Must have an even number of arguments in the body"
                           :type    :m-template
                           :row     row
                           :end-row (:end-row end-metadata)
                           :col     col
                           :end-col (:end-col end-metadata)})))

It registers the finding but only on the [:img#pic] node