clojure-lsp.api
Entrypoint for main clojure-lsp features
Entrypoint for main clojure-lsp features
analyze-project!clj
(analyze-project! {:keys [project-root settings] :as options})Analyze project caching analysis for future API calls. Useful for REPL usage for example. Options:
:project-root a java.io.File representing the project root.
settings map of settings following https://clojure-lsp.io/settings/
Analyze project caching analysis for future API calls. Useful for REPL usage for example. Options: `:project-root` a java.io.File representing the project root. `settings` map of settings following https://clojure-lsp.io/settings/
clean-ns!clj
(clean-ns! {:keys [project-root settings namespace ns-exclude-regex]
:as options})Organize ns form, removing unused requires/refers/imports and sorting alphabetically. Options:
:project-root a java.io.File representing the project root.
:namespace a coll of symbols representing the namespaces which should be cleaned,
if empty all project namespaces will be considered.
:ns-exclude-regex a string regex representing the namespaces that should be excluded during this call.
dry? a boolean, when enabled make no changes to files, only report.
settings map of settings following https://clojure-lsp.io/settings/
Organize ns form, removing unused requires/refers/imports and sorting alphabetically. Options: `:project-root` a java.io.File representing the project root. `:namespace` a coll of symbols representing the namespaces which should be cleaned, if empty all project namespaces will be considered. `:ns-exclude-regex` a string regex representing the namespaces that should be excluded during this call. `dry?` a boolean, when enabled make no changes to files, only report. `settings` map of settings following https://clojure-lsp.io/settings/
diagnosticsclj
(diagnostics {:keys [project-root settings] :as options})Analyze the project and find all diagnostics (warnings, errors). Options:
:project-root a java.io.File representing the project root.
:namespace a coll of symbols representing the namespaces which should be cleaned,
if empty all project namespaces will be considered.
:ns-exclude-regex a string regex representing the namespaces that should be excluded during this call.
:output a map with options on how the result should be printed, available values are:
:canonical-paths a boolean if the path should be absolute or not, defaults to false.
settings map of settings following https://clojure-lsp.github.io/clojure-lsp/settings/
Analyze the project and find all diagnostics (warnings, errors). Options: `:project-root` a java.io.File representing the project root. `:namespace` a coll of symbols representing the namespaces which should be cleaned, if empty all project namespaces will be considered. `:ns-exclude-regex` a string regex representing the namespaces that should be excluded during this call. `:output` a map with options on how the result should be printed, available values are: `:canonical-paths` a boolean if the path should be absolute or not, defaults to false. `settings` map of settings following https://clojure-lsp.github.io/clojure-lsp/settings/
format!clj
(format! {:keys [project-root settings namespace ns-exclude-regex] :as options})Format one or more namespaces using cljfmt. Options:
:project-root a java.io.File representing the project root.
:namespace a coll of symbols representing the namespaces which should be cleaned,
if empty all project namespaces will be considered.
dry? a boolean, when enabled make no changes to files, only report.
:ns-exclude-regex a string regex representing the namespaces that should be excluded during this call.
settings map of settings following https://clojure-lsp.io/settings/
Format one or more namespaces using cljfmt. Options: `:project-root` a java.io.File representing the project root. `:namespace` a coll of symbols representing the namespaces which should be cleaned, if empty all project namespaces will be considered. `dry?` a boolean, when enabled make no changes to files, only report. `:ns-exclude-regex` a string regex representing the namespaces that should be excluded during this call. `settings` map of settings following https://clojure-lsp.io/settings/
rename!clj
(rename! {:keys [project-root settings from to] :as options})Rename a symbol and its definitions across the project. Options:
:project-root a java.io.File representing the project root.
:from the full qualified symbol origin name that should be renamed. e.g. my-project/my-var or my-project.foo for namespaces
:to the full qualified symbol that will replace the original symbol. e.g. my-project/my-var-2 or my-project.bar for namespaces
dry? a boolean, when enabled make no changes to files, only report.
settings map of settings following https://clojure-lsp.io/settings/
Rename a symbol and its definitions across the project. Options: `:project-root` a java.io.File representing the project root. `:from` the full qualified symbol origin name that should be renamed. e.g. my-project/my-var or my-project.foo for namespaces `:to` the full qualified symbol that will replace the original symbol. e.g. my-project/my-var-2 or my-project.bar for namespaces `dry?` a boolean, when enabled make no changes to files, only report. `settings` map of settings following https://clojure-lsp.io/settings/
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close