-
-
Notifications
You must be signed in to change notification settings - Fork 149
/
diagnostics.clj
225 lines (197 loc) · 9.09 KB
/
diagnostics.clj
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
(ns clojure-lsp.feature.diagnostics
(:require
[clj-kondo.impl.config :as kondo.config]
[clojure-lsp.dep-graph :as dep-graph]
[clojure-lsp.logger :as logger]
[clojure-lsp.queries :as q]
[clojure-lsp.settings :as settings]
[clojure-lsp.shared :as shared]
[clojure.core.async :as async]))
(set! *warn-on-reflection* true)
(def diagnostic-types-of-unnecessary-type
#{:clojure-lsp/unused-public-var
:redefined-var
:redundant-do
:redundant-expression
:redundant-let
:unused-binding
:unreachable-code
:unused-import
:unused-namespace
:unused-private-var
:unused-referred-var})
(def deprecated-diagnostic-types
#{:deprecated-var})
(defn ^:private kondo-config-for-ns [kondo-config ns-name filename]
(let [ns-group (kondo.config/ns-group kondo-config ns-name filename)
config-in-ns (get (:config-in-ns kondo-config) ns-group)
kondo-config (if config-in-ns
(kondo.config/merge-config! kondo-config config-in-ns)
kondo-config)]
kondo-config))
(defn ^:private unused-public-var->finding [element kondo-config]
(let [keyword-def? (identical? :keyword-definitions (:bucket element))
kondo-config (if (:ns element)
(kondo-config-for-ns kondo-config (:ns element) (:filename element))
kondo-config)]
{:uri (:uri element)
:row (:name-row element)
:col (:name-col element)
:end-row (:name-end-row element)
:end-col (:name-end-col element)
:level (or (-> kondo-config :linters :clojure-lsp/unused-public-var :level) :info)
:message (if keyword-def?
(if (:ns element)
(format "Unused public keyword ':%s/%s'" (:ns element) (:name element))
(format "Unused public keyword ':%s'" (:name element)))
(format "Unused public var '%s/%s'" (:ns element) (:name element)))
:type :clojure-lsp/unused-public-var}))
(defn ^:private exclude-public-diagnostic-definition? [kondo-config definition]
(let [kondo-config (kondo-config-for-ns kondo-config (:ns definition) (:filename definition))
excluded-syms-regex (get-in kondo-config [:linters :clojure-lsp/unused-public-var :exclude-regex] #{})
excluded-defined-by-syms-regex (get-in kondo-config [:linters :clojure-lsp/unused-public-var :exclude-when-defined-by-regex] #{})
fqsn (symbol (-> definition :ns str) (-> definition :name str))]
(or (q/exclude-public-definition? kondo-config definition)
(some #(re-matches (re-pattern (str %)) (str fqsn)) excluded-syms-regex)
(some #(re-matches (re-pattern (str %)) (str (:defined-by definition))) excluded-defined-by-syms-regex)
(:export definition))))
(defn ^:private kondo-finding->diagnostic
[{:keys [type message level row col end-row] :as finding}]
(let [expression? (not= row end-row)
finding (cond-> (merge {:end-row row :end-col col} finding)
expression? (assoc :end-row row :end-col col))]
{:range (shared/->range finding)
:tags (cond-> []
(diagnostic-types-of-unnecessary-type type) (conj 1)
(deprecated-diagnostic-types type) (conj 2))
:message message
:code (if-let [n (namespace type)]
(str n "/" (name type))
(name type))
:severity (case level
:error 1
:warning 2
:info 3)
:source (if (identical? :clojure-lsp/unused-public-var type)
"clojure-lsp"
"clj-kondo")}))
(defn ^:private valid-finding? [{:keys [row col level] :as finding}]
(when (not= level :off)
(or (and row col)
(logger/warn "Invalid clj-kondo finding. Cannot find position data for" finding))))
(defn ^:private exclude-ns? [uri linter db]
;; TODO: it's possible, though unusual, to have several namespaces in a file.
;; What should we do in that case?
(when-let [namespace (first (dep-graph/ns-names-for-uri db uri))]
(when-let [ns-exclude-regex-str (settings/get db [:linters linter :ns-exclude-regex])]
(re-matches (re-pattern ns-exclude-regex-str) (str namespace)))))
(defn ^:private kondo-findings->diagnostics [uri linter db]
(when-not (exclude-ns? uri linter db)
(->> (get-in db [:findings uri])
(filter valid-finding?)
(mapv kondo-finding->diagnostic))))
(defn severity->level [severity]
(case (int severity)
1 :error
2 :warning
3 :info))
(defn severity->color [severity]
(case (int severity)
1 :red
2 :yellow
3 :cyan))
(defn ^:private clj-depend-violations->diagnostics [uri level db]
;; TODO: it's possible, though unusual, to have several namespaces in a file.
;; What should we do in that case?
(when-let [namespace (first (dep-graph/ns-names-for-uri db uri))]
(mapv (fn [{:keys [message]}]
(let [ns-definition (q/find-namespace-definition-by-uri db uri)]
{:range (shared/->range ns-definition)
:tags []
:message message
:code "clj-depend"
:severity (case level
:error 1
:warning 2
:info 3)
:source "clj-depend"}))
(get-in db [:clj-depend-violations (symbol namespace)]))))
(defn find-diagnostics [^String uri db]
(let [kondo-level (settings/get db [:linters :clj-kondo :level])
depend-level (settings/get db [:linters :clj-depend :level] :info)]
(if (shared/jar-file? uri)
[]
(cond-> []
(not= :off kondo-level)
(concat (kondo-findings->diagnostics uri :clj-kondo db))
(not= :off depend-level)
(concat (clj-depend-violations->diagnostics uri depend-level db))))))
(defn ^:private publish-diagnostic!* [{:keys [diagnostics-chan]} diagnostic]
(async/put! diagnostics-chan diagnostic))
(defn ^:private publish-all-diagnostics!* [{:keys [diagnostics-chan]} diagnostics]
(async/onto-chan! diagnostics-chan diagnostics false))
(defn ^:private diagnostics-of-uri [uri db]
{:uri uri
:diagnostics (find-diagnostics uri db)})
(defn ^:private empty-diagnostics-of-uri [uri]
{:uri uri
:diagnostics []})
(defn publish-diagnostics! [uri {:keys [db*], :as components}]
(publish-diagnostic!* components (diagnostics-of-uri uri @db*)))
(defn publish-all-diagnostics! [uris {:keys [db*], :as components}]
(let [db @db*]
(publish-all-diagnostics!*
components
(->> uris
(remove #(= :unknown (shared/uri->file-type %)))
(map #(diagnostics-of-uri % db))))))
(defn publish-empty-diagnostics! [uris components]
(publish-all-diagnostics!* components (map empty-diagnostics-of-uri uris)))
(defn ^:private unused-public-vars [narrowed-db project-db kondo-config]
(let [exclude-def? (partial exclude-public-diagnostic-definition? kondo-config)
var-definitions (->> (q/find-all-var-definitions narrowed-db)
(remove exclude-def?))
var-nses (set (map :ns var-definitions)) ;; optimization to limit usages to internal namespaces, or in the case of a single file, to its namespaces
var-usages (into #{}
(comp
(q/xf-all-var-usages-to-namespaces var-nses)
(map q/var-usage-signature))
(q/nses-and-dependents-analysis project-db var-nses))
var-used? (fn [var-def]
(some var-usages (q/var-definition-signatures var-def)))
kw-definitions (->> (q/find-all-keyword-definitions narrowed-db)
(remove exclude-def?))
kw-usages (if (seq kw-definitions) ;; avoid looking up thousands of keyword usages if these files don't define any keywords
(into #{}
(comp
q/xf-all-keyword-usages
(map q/kw-signature))
(:analysis project-db))
#{})
kw-used? (fn [kw-def]
(contains? kw-usages (q/kw-signature kw-def)))]
(->> (concat (remove var-used? var-definitions)
(remove kw-used? kw-definitions))
(map (fn [unused-var]
(unused-public-var->finding unused-var kondo-config))))))
(defn ^:private findings-of-project
[db kondo-config]
(let [project-db (q/db-with-internal-analysis db)]
(unused-public-vars project-db project-db kondo-config)))
(defn ^:private findings-of-uris
[uris db kondo-config]
(let [project-db (q/db-with-internal-analysis db)
db-of-uris (update project-db :analysis select-keys uris)]
(unused-public-vars db-of-uris project-db kondo-config)))
(defn ^:private finalize-findings! [findings reg-finding!]
(let [uri->filename (memoize shared/uri->filename)]
(run! #(reg-finding! (assoc % :filename (uri->filename (:uri %)))) findings))
nil)
(defn custom-lint-project!
[db {:keys [reg-finding! config]}]
(-> (findings-of-project db config)
(finalize-findings! reg-finding!)))
(defn custom-lint-uris!
[uris db {:keys [reg-finding! config]}]
(-> (findings-of-uris uris db config)
(finalize-findings! reg-finding!)))