-
Notifications
You must be signed in to change notification settings - Fork 7
/
zprint.clj
304 lines (296 loc) · 14.5 KB
/
zprint.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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
(ns leiningen.zprint
(:require [zprint.core :as zp :exclude [zprint]]
[zprint.config :as zc]
[me.raynes.fs :as fs])
(:import [java.io File]))
(defn lein-zprint-about
"Return version of this program."
[]
(str "lein-zprint-0.5.4"))
(defn zprint-about "Return version of zprint library program." [] (zc/about))
(defn vec-str-to-str
"Take a vector of strings and concatenate them into one string with
newlines between them."
[vec-str]
(apply str (interpose "\n" vec-str)))
;!zprint {:format :next :vector {:wrap? false}}
(def help-str
(vec-str-to-str
[(lein-zprint-about)
(zprint-about)
""
" lein zprint reformats Clojure source files from scratch using the"
" zprint library, ignoring any line breaks or whitespace in the files."
" It replaces the files by new ones that are completely reformatted."
" The existing files are renamed by appending .old to the previous name."
""
" If you put this line in your project.clj, it won't keep"
" the original files around:"
""
" :zprint {:old? false}"
""
" Using lein zprint:"
" ------------------"
""
" To reformat one file in myproject:"
""
" lein zprint src/myproject/core.clj"
""
" To reformat all of the Clojure source files in myproject:"
""
" lein zprint src/myproject/*.clj"
""
" Make sure you run lein zprint with the current directory set to"
" the directory containing your project.clj file."
""
" To configure lein zprint, you can:"
""
" - invoke lein-zprint with a switch:"
" lein zprint -d filename1 filename2 ..."
" Supported switches are: -d and --default, see below..."
" - create a $HOME/.zprintrc file or a $HOME/.zprint.edn file"
" containing a zprint options map"
" - define :search-config? as true in the $HOME/.zprintrc or"
" $HOME/.zprint.edn file, and zprint will search for a"
" .zprintrc or .zprint.edn file in the current directory"
" and if it doesn't find one, in the parent of that directory,"
" all the way to the root directory, stopping when it finds a"
" configuration file."
" - add a :zprint {<options-map>} pair to the map in project.clj"
" - place a number first in the arguments, which will become the width"
" - place an options map (surrounded by double quotes) first in the"
" arguments, which will be used to configure zprint (if there is a"
" number first, the map can be second in the arguments)"
""
" A small number of command line switches are supported:"
""
" -d --default Ignore external configuration and format based"
" only on defaults and ;!zprint directives in the"
" file. The only thing in the :zprint map in the"
" project.clj file that is recognized is the :old?"
" key, all other keys ignored. $HOME/.zprintrc is"
" also ignored."
""
" You can place the token :explain anywhere you can place a file name"
" and the current options will be output to standard out."
""
" You can also place the token :support anywhere you can put a file"
" name, and you should put :support at the end of a line that isn't"
" doing what you want, and submit that with your issue."
""
" Within a file, you can control the function of the zprint formatter"
" with lines that start with ;!zprint, and contain an options map."
""
" ;!zprint <options> perform a (set-options! <options>)"
" Will use these options for the rest of the"
" file (or until they are changed again)"
""
" ;!zprint {:format :off} turn off formatting"
""
" ;!zprint {:format :on} turn on formattting"
""
" ;!zprint {:format :skip} do not format the next element that is"
" not a comment and not whitespace"
""
" ;!zprint {:format :next <options>}"
" Format only the next non-comment non-whitespace"
" element with the specified <options>"
""
" You can type: lein zprint :help to get this text."
""]))
(defn get-switch
"Given an options, get a switch out of it if there is one to get. Throw
an exception for a bad switch. Returns [switch old?], where old is
the value of :old if options is a map."
[options]
(cond
(string? options)
(if (clojure.string/starts-with? options "-")
(cond (or (= options "--default") (= options "-d")) [:default nil]
#_#_(or (= options "--standard") (= options "-s")) [:standard nil]
:else (throw (Exception. (str "Unknown switch '" options "'")))))
(map options)
(when (:command options)
(let [command (:command options)
option-keys (keys options)]
(if (or (= command :default) (= command :standard))
(if (= (count option-keys)
(count (filter #{:old? :parallel? :command} option-keys)))
[command (:old? options)]
(throw
(Exception. (str "If key :command appears in an options map"
" the only other allowed keys are :old? and"
" :parallel?, instead found: " options))))
(throw (Exception. (str "Unknown switch '" options "'"))))))
:else (throw (Exception. (str "Options '"
options
"' must be either a map or a string")))))
(defn process-options-as-switches
"Take the project-options and line-options, and look for switches. If
switches are found (and don't conflict with each other), then return
:default, :standard, or nil. Throw an exception for a problem. If
line-options has switch, ignore project-options if it is not a command,
but if it is a command, it must match line-options. If project-options has
a command, then fail if line-options has something that is not the same
switch. Pull :old out of project options if it contains a command and
return it in old?. Returns [switch old?]."
[project-options line-options]
(cond
(not (empty? line-options))
(let [[line-switch line-old?] (get-switch line-options)
[project-switch project-old?] (get-switch project-options)
project-old? (or project-old?
(when (map? project-options)
(:old? project-options)))]
#_(println "project-old?:" project-old? project-options)
(if line-switch
; If project-options were a switch, then we will require
; line and project options have the same switch.
; If project-options was a options map, then we will ignore it.
(if project-switch
(if (= line-switch project-switch)
[line-switch (or line-old? project-old?)]
(throw (Exception. (str "Command line input '"
line-options
"' conflicted with input from project.clj"
" file '"
project-options
"'!"))))
[line-switch (or line-old? project-old?)])
; We had line-options, but not a switch. If we have
; a project switch, that is a error. Project options are fine.
(when project-switch
(throw (Exception. (str "Command line input '"
line-options
"' conflicted with input from project.clj"
" file '"
project-options
"'!"))))))
; We just have project-options, no line-options, so this is easy. It
; is either a switch or options.!
(not (empty? project-options)) (get-switch project-options)
:else nil))
(defn zprint-one-file
"Take a file name, possibly including a path, and zprint that one file."
[project-options line-options file-spec]
(cond
(= file-spec ":explain") (do (println (lein-zprint-about))
(println (zprint-about))
(zp/czprint nil :explain))
(= file-spec ":support") (do (println (lein-zprint-about))
(println (zprint-about))
(zp/czprint nil :support))
(= file-spec ":about") (println (lein-zprint-about))
(= file-spec ":help") (println help-str)
:else
(let [parent-path (fs/parent file-spec)
tmp-name (fs/temp-name "zprint")
tmp-file (str parent-path File/separator tmp-name)
old-file (str file-spec ".old")]
(println "Processing file:" file-spec)
(let [[switch old?] (process-options-as-switches project-options
line-options)
; If old? is nil (or, really, not false), then we want to
; default it to true. False means we explicitly found it
; set to false somewhere, nil means that we didn't see
; anything
; about it one way or the other.
old? (if-not (false? old?) true)
parallel? (get project-options :parallel? true)
op-options (cond (and (map? project-options) (map? line-options))
(zc/merge-deep project-options line-options)
(map? project-options) project-options
(map? line-options) line-options
:else {})]
(try
(case switch
:default (zp/set-options! {:configured? true,
:color? false,
:parallel? parallel?,
:old? old?})
#_#_:standard
(zp/set-options! {:configured? true,
:style :standard,
:color? false,
:parallel? parallel?,
:old? old?})
(do (zc/config-configure-all! op-options)
(zp/set-options! {:parallel? true} "lein-zprint internal")
(zp/set-options! project-options ":zprint map in project.clj")
(zp/set-options! line-options "lein-zprint command line")
(zp/set-options! {:color? false} "lein-zprint no color")))
(zp/zprint-file file-spec (fs/base-name file-spec) tmp-file)
(when (:old? (zc/get-options))
(fs/delete old-file)
(fs/rename file-spec old-file))
(fs/rename tmp-file file-spec)
(when (:old? (zc/get-options)) old-file)
(catch Exception e
(println (str "Unable to process file: "
file-spec
" because: "
e
" Leaving it unchanged!"))))))))
(defn ^:no-project-needed zprint
"Pretty-print all of the arguments that are not a map, replacing the
existing file with the pretty printed one. The old one is kept around
with a .old extension. If the arg is a map, it is considered an options
map and subsequent files are pretty printed with those options."
[project & args]
(let [project-options (:zprint project)
arg1 (try (load-string (first args)) (catch Exception e nil))
[line-options args]
(cond
(map? arg1) [arg1 (next args)]
(number? arg1) (if-let [arg2 (try (load-string (second args))
(catch Exception e nil))]
(cond (map? arg2) [(merge {:width arg1} arg2)
(nnext args)]
:else [{:width arg1} (next args)])
[{:width arg1} (next args)])
(= :planck-cmd-line arg1)
(do (println (str ":planck-cmd-line has been removed. "
"The last version to support :planck-cmd-line "
"was 0.5.0 for both lein-zprint and zprint."))
[nil nil])
(= :lumo-cmd-line arg1)
(do (println (str ":lumo-cmd-line has been removed. "
"The last version to support :lumo-cmd-line "
"was 0.5.0 for both lein-zprint and zprint, "
"but required an older version of lumo."))
[nil nil])
(clojure.string/starts-with? (first args) "-") [(first args)
(next args)]
:else [{} args])
[switch _] (process-options-as-switches project-options line-options)
op-options (cond (and (map? project-options) (map? line-options))
(zc/merge-deep project-options line-options)
(map? project-options) project-options
(map? line-options) line-options
:else {})]
; All of these options will be reset by zprint-one-file, but we
; do them here to see if they work, and for :explain output.
(case switch
:default (zp/set-options! {:configured? true, :parallel? true}
"lein-zprint default switch")
#_#_:standard
(zp/set-options! {:configured? true, :style :standard, :parallel? true})
; Regular, not switch processing
(do (zp/set-options! {:parallel? true} "lein-zprint internal" op-options)
(when project-options
(zp/set-options! project-options ":zprint map in project.clj"))
(when line-options
(zp/set-options! line-options "lein zprint command line"))))
(let [old-files (mapv #(zprint-one-file project-options line-options %)
args)
old-files (remove nil? old-files)]
(when-not (empty? old-files)
(println "Renamed"
(count old-files)
(str "original file"
(if (> (count old-files) 1) "s" "")
" with .old extensions."))
(println
"To disable rename, add :zprint {:old? false} to your project.clj.")))
(flush)
(shutdown-agents)))