clojure-lsp.custom-linters-api — com.github.clojure-lsp/clojure-lsp 2025.06.06-19.04.49

Public API used by custom linters, avoid breaking changes.

api-fns clj

db-with-internal-analysis clj

(db-with-internal-analysis db)

Return a db with only internal analysis.

db-with-uris-analysis clj

(db-with-uris-analysis db uris)

Return a db with only analysis for uris. Good for performance since the db is reduced to see only those uris.

dir-uris->file-uris clj

(dir-uris->file-uris uris db)

Convert a coll of uris that may represent dirs to its respective file uris if present on db.

Example

(dir-uris->file-uris ["file:///project/src"] db)
=> ["file:///project/src/foo.clj"
    "file:///project/src/bar.clj"]

external-analysis clj

(external-analysis db)

Filter only dependencies analysis, that are not related to project code.

fast= clj

(fast= a b)

Fast = comparassion, useful for string, sym and keyword comparassions.

filename->uri clj

(filename->uri filename db)

Convert a absolute filename path to a uri.

find-all-var-definitions clj

(find-all-var-definitions db include-private?)

Find all var-definitions of db.

find-declaration clj

(find-declaration db element)

Find the analysis element declaration.

find-definition clj

(find-definition db element)

Find the analysis element definition.

find-element clj

(find-element db uri row col)

Find the analysis element in given position.

find-element-from-sym clj

(find-element-from-sym db ns-sym name-sym)

Find element from a full qualified namespaced symbol.

find-implementations clj

(find-implementations db element)

Find the analysis element implementations.

find-nodes clj

(find-nodes db elements filter-fn)

Find all rewrite-clj zipper nodes from elements filtering by filter-fn function.

(find-nodes
  db
  (find-all-var-definitions db true)
  #(.equals 'clojure.core/defn (:defined-by %)))

find-nodes-from-defined-bys clj

(find-nodes-from-defined-bys db defined-bys)

Find the rewrite-clj zipper node from all var-definitions defined-by one of defined-bys.

find-nodes-from-sym clj

(find-nodes-from-sym db ns-sym name-sym)

Find the rewrite-clj zipper node from a fully qualified symbol.

find-references clj

(find-references db element include-definition?)

Find the analysis element references.

find-var-definitions clj

(find-var-definitions db uri include-private?)

Find all var-definitions of a uri.

inside? clj

(inside? a b)

Checks if element a is inside element b scope.

internal-analysis clj

(internal-analysis db)

Filter only project related analysis, that are not related to dependencies code.

uri->filename clj

(uri->filename uri)

Convert a uri to an absolute filename path.