/
deps_edn.clj
162 lines (152 loc) · 6.35 KB
/
deps_edn.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
(ns clj-kondo.impl.linters.deps-edn
(:require [clj-kondo.impl.findings :as findings]
[clj-kondo.impl.utils :refer [sexpr node->line]]))
(set! *warn-on-reflection* true)
(defn sexpr-keys [map-node]
(let [children (:children map-node)
keys (take-nth 2 children)
keys (map sexpr keys)
vals (take-nth 2 (rest children))]
(zipmap keys vals)))
(defn key-nodes [map-node]
(if (identical? :namespaced-map (:tag map-node))
(let [nspace-k (-> map-node :ns :k)
map-node (first (:children map-node))
knodes (take-nth 2 (:children map-node))]
(map #(assoc % :namespace nspace-k) knodes))
(take-nth 2 (:children map-node))))
(defn val-nodes [map-node]
(if (identical? :namespaced-map (:tag map-node))
(let [map-node (first (:children map-node))
vnodes (take-nth 2 (rest (:children map-node)))]
vnodes)
(take-nth 2 (rest (:children map-node)))))
(defn lint-qualified-deps [ctx nodes]
(run! (fn [node]
(let [form (sexpr node)]
(when-not (or (qualified-symbol? form)
;; fix for namespaced maps
(:namespace node))
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
#_{:clj-kondo/ignore[:format]} ;; fixed on master
(format "Libs must be qualified, change %s => %<s/%<s" form))))))
nodes))
(defn lint-dep-coordinates [ctx nodes]
(run! (fn [node]
(let [form (sexpr node)]
(if-not (map? form)
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Expected map, found: " (.getName (class form)))))
(or (when-let [version (:mvn/version form)]
(when (or (= "RELEASE" version)
(= "LATEST" version))
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Non-determistic version."))))
true)
(when (:git/url form)
(when-not (:sha form)
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Missing required key :sha."))))
true)
(:local/root form)
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Missing required key: :mvn/version, :git/url or :local/root.")))))))
nodes))
(defn lint-alias-keys [ctx nodes]
(run! (fn [node]
(let [form (sexpr node)]
(if (not (keyword? form))
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Prefer keyword for alias.")))
(when (contains? #{:deps :extra-deps :jvm-opts} form)
(findings/reg-finding!
ctx
(node->line (:filename ctx)
node
:warning
:deps.edn
(str "Suspicious alias name: " (name form))))))))
nodes))
(defn lint-aliases [ctx alias-nodes]
(run! (fn [alias-node]
(when-let [jvm-opts-node (:jvm-opts alias-node)]
(let [jvm-opts-form (sexpr jvm-opts-node)]
(when (not (and (sequential? jvm-opts-form)
(every? string? jvm-opts-form)))
(findings/reg-finding!
ctx
(node->line (:filename ctx)
jvm-opts-node
:warning
:deps.edn
(str "JVM opts should be seqable of strings.")))))))
alias-nodes))
(defn lint-mvn-repos [ctx mvn-repos]
(let [repo-map-nodes (val-nodes mvn-repos)]
(run! (fn [repo-map-node]
(let [form (sexpr repo-map-node)]
(when-not (and (map? form)
(:url form))
(findings/reg-finding!
ctx
(node->line (:filename ctx)
repo-map-node
:warning
:deps.edn
(str "Expected: map with :url."))))))
repo-map-nodes)))
(defn lint-deps-edn [ctx expr]
(try
(let [deps-edn (sexpr-keys expr)
deps (:deps deps-edn)
_ (lint-qualified-deps ctx (-> deps key-nodes))
_ (lint-dep-coordinates ctx (-> deps val-nodes))
aliases (:aliases deps-edn)
alias-keys (key-nodes aliases)
_ (lint-alias-keys ctx alias-keys)
alias-maps (val-nodes aliases)
alias-maps (map sexpr-keys alias-maps)
_ (lint-aliases ctx alias-maps)
extra-dep-maps (map :extra-deps alias-maps)
extra-dep-map-vals (mapcat val-nodes extra-dep-maps)
_ (lint-dep-coordinates ctx extra-dep-map-vals)
extra-dep-map-vals (map sexpr-keys extra-dep-map-vals)
exclusions (map (comp :children :exclusions) extra-dep-map-vals)
_ (when-let [mvn-repos (:mvn/repos deps-edn)]
(lint-mvn-repos ctx mvn-repos))]
(run! #(lint-qualified-deps ctx (key-nodes %)) extra-dep-maps)
(run! #(lint-qualified-deps ctx %) exclusions))
;; Due to ubiquitous use of sexpr, we're catching coercion errors here and let them slide.
(catch Exception e
(binding [*out* *err*]
(println "ERROR: " (.getMessage e))))))