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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
local fs = require("conform.fs")
local log = require("conform.log")
local util = require("conform.util")
local uv = vim.uv or vim.loop
local M = {}
---@param ctx conform.Context
---@param config conform.FormatterConfig
M.build_cmd = function(ctx, config)
local command = config.command
if type(command) == "function" then
command = command(ctx)
end
local cmd = { command }
local args = {}
if ctx.range and config.range_args then
---@cast ctx conform.RangeContext
args = config.range_args(ctx)
elseif config.args then
if type(config.args) == "function" then
args = config.args(ctx)
else
---@diagnostic disable-next-line: cast-local-type
args = config.args
end
end
---@diagnostic disable-next-line: param-type-mismatch
for _, v in ipairs(args) do
if v == "$FILENAME" then
v = ctx.filename
elseif v == "$DIRNAME" then
v = ctx.dirname
end
table.insert(cmd, v)
end
return cmd
end
---@param range? conform.Range
---@param start_a integer
---@param end_a integer
local function indices_in_range(range, start_a, end_a)
return not range or (start_a <= range["end"][1] and range["start"][1] <= end_a)
end
---@param bufnr integer
---@param original_lines string[]
---@param new_lines string[]
---@param range? conform.Range
---@param only_apply_range boolean
local function apply_format(bufnr, original_lines, new_lines, range, only_apply_range)
local original_text = table.concat(original_lines, "\n")
-- Trim off the final newline from the formatted text because that is baked in to
-- the vim lines representation
if new_lines[#new_lines] == "" then
new_lines[#new_lines] = nil
end
local new_text = table.concat(new_lines, "\n")
local indices = vim.diff(original_text, new_text, {
result_type = "indices",
algorithm = "histogram",
})
assert(indices)
for i = #indices, 1, -1 do
local start_a, count_a, start_b, count_b = unpack(indices[i])
-- When count_a is 0, the diff is an insert after the line
if count_a == 0 then
-- This happens when the first line is blank and we're inserting text after it
if start_a == 0 then
count_a = 1
end
start_a = start_a + 1
end
-- If this diff range goes *up to* the last line in the original file, *and* the last line
-- after that is just an empty space, then the diff range here was calculated to include that
-- final newline, so we should bump up the count_a to include it
if (start_a + count_a) == #original_lines and original_lines[#original_lines] == "" then
count_a = count_a + 1
end
-- Same logic for the new lines
if (start_b + count_b) == #new_lines and new_lines[#new_lines] == "" then
count_b = count_b + 1
end
local replacement = util.tbl_slice(new_lines, start_b, start_b + count_b - 1)
local end_a = start_a + count_a
if not only_apply_range or indices_in_range(range, start_a, end_a) then
vim.api.nvim_buf_set_lines(bufnr, start_a - 1, end_a - 1, true, replacement)
end
end
end
---@param bufnr integer
---@param formatter conform.FormatterInfo
---@param config conform.FormatterConfig
---@param ctx conform.Context
---@param input_lines string[]
---@param callback fun(err?: string, output?: string[])
---@return integer job_id
local function run_formatter(bufnr, formatter, config, ctx, input_lines, callback)
local cmd = M.build_cmd(ctx, config)
local cwd = nil
if config.cwd then
cwd = config.cwd(ctx)
end
log.info("Run %s on %s", formatter.name, vim.api.nvim_buf_get_name(bufnr))
if not config.stdin then
log.debug("Creating temp file %s", ctx.filename)
local fd = assert(uv.fs_open(ctx.filename, "w", 448)) -- 0700
uv.fs_write(fd, table.concat(input_lines, "\n"))
uv.fs_close(fd)
local final_cb = callback
callback = function(...)
log.debug("Cleaning up temp file %s", ctx.filename)
uv.fs_unlink(ctx.filename)
final_cb(...)
end
end
log.debug("Run command: %s", cmd)
if cwd then
log.debug("Run CWD: %s", cwd)
end
local stdout
local stderr
local exit_codes = config.exit_codes or { 0 }
local jid = vim.fn.jobstart(cmd, {
cwd = cwd,
stdout_buffered = true,
stderr_buffered = true,
stdin = config.stdin and "pipe" or "null",
on_stdout = function(_, data)
if config.stdin then
stdout = data
end
end,
on_stderr = function(_, data)
stderr = data
end,
on_exit = function(_, code)
local output
if not config.stdin then
local fd = assert(uv.fs_open(ctx.filename, "r", 448)) -- 0700
local stat = assert(uv.fs_fstat(fd))
local content = assert(uv.fs_read(fd, stat.size))
uv.fs_close(fd)
output = vim.split(content, "\n", { plain = true })
else
output = stdout
end
if vim.tbl_contains(exit_codes, code) then
log.debug("%s exited with code %d", formatter.name, code)
callback(nil, output)
else
log.error("%s exited with code %d", formatter.name, code)
log.warn("%s stdout: %s", formatter.name, stdout)
log.warn("%s stderr: %s", formatter.name, stderr)
local stderr_str
if stderr then
stderr_str = table.concat(stderr, "\n")
end
callback(string.format("Formatter '%s' error: %s", formatter.name, stderr_str))
end
end,
})
if jid == 0 then
callback(string.format("Formatter '%s' invalid arguments", formatter.name))
elseif jid == -1 then
callback(string.format("Formatter '%s' command is not executable", formatter.name))
elseif config.stdin then
local text = table.concat(input_lines, "\n")
vim.api.nvim_chan_send(jid, text)
vim.fn.chanclose(jid, "stdin")
end
vim.b[bufnr].conform_jid = jid
return jid
end
---@param bufnr integer
---@param config conform.FormatterConfig
---@param range? conform.Range
---@return conform.Context
M.build_context = function(bufnr, config, range)
if bufnr == 0 then
bufnr = vim.api.nvim_get_current_buf()
end
local filename = vim.api.nvim_buf_get_name(bufnr)
-- Hack around checkhealth. For buffers that are not files, we need to fabricate a filename
if vim.bo[bufnr].buftype ~= "" then
filename = ""
end
local dirname
if filename == "" then
dirname = vim.fn.getcwd()
filename = fs.join(dirname, "unnamed_temp")
local ft = vim.bo[bufnr].filetype
if ft and ft ~= "" then
filename = filename .. "." .. ft
end
else
dirname = vim.fs.dirname(filename)
end
if not config.stdin then
local basename = vim.fs.basename(filename)
local tmpname = string.format(".conform.%d.%s", math.random(1000000, 9999999), basename)
local parent = vim.fs.dirname(filename)
filename = fs.join(parent, tmpname)
end
return {
buf = bufnr,
filename = filename,
dirname = dirname,
range = range,
}
end
---@param bufnr integer
---@param formatters conform.FormatterInfo[]
---@param range? conform.Range
---@param callback? fun(err?: string)
M.format_async = function(bufnr, formatters, range, callback)
if bufnr == 0 then
bufnr = vim.api.nvim_get_current_buf()
end
local idx = 1
local changedtick = vim.b[bufnr].changedtick
local original_lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
local input_lines = original_lines
local all_support_range_formatting = true
-- kill previous jobs for buffer
local prev_jid = vim.b[bufnr].conform_jid
if prev_jid then
if vim.fn.jobstop(prev_jid) == 1 then
log.info("Canceled previous format job for %s", vim.api.nvim_buf_get_name(bufnr))
end
end
local function run_next_formatter()
local formatter = formatters[idx]
if not formatter then
-- discard formatting if buffer has changed
if vim.b[bufnr].changedtick == changedtick then
apply_format(bufnr, original_lines, input_lines, range, not all_support_range_formatting)
else
log.info(
"Async formatter discarding changes for %s: concurrent modification",
vim.api.nvim_buf_get_name(bufnr)
)
end
if callback then
callback()
end
return
end
idx = idx + 1
local config = assert(require("conform").get_formatter_config(formatter.name))
local ctx = M.build_context(bufnr, config, range)
local jid
jid = run_formatter(bufnr, formatter, config, ctx, input_lines, function(err, output)
if err then
-- Only log the error if the job wasn't canceled
if vim.api.nvim_buf_is_valid(bufnr) and jid == vim.b[bufnr].conform_jid then
log.error(err)
end
if callback then
callback(err)
end
return
end
input_lines = output
run_next_formatter()
end)
all_support_range_formatting = all_support_range_formatting and config.range_args ~= nil
end
run_next_formatter()
end
---@param bufnr integer
---@param formatters conform.FormatterInfo[]
---@param timeout_ms integer
---@param quiet boolean
---@param range? conform.Range
M.format_sync = function(bufnr, formatters, timeout_ms, quiet, range)
if bufnr == 0 then
bufnr = vim.api.nvim_get_current_buf()
end
local start = uv.hrtime() / 1e6
local original_lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
local input_lines = original_lines
-- kill previous jobs for buffer
local prev_jid = vim.b[bufnr].conform_jid
if prev_jid then
if vim.fn.jobstop(prev_jid) == 1 then
log.info("Canceled previous format job for %s", vim.api.nvim_buf_get_name(bufnr))
end
end
local all_support_range_formatting = true
for _, formatter in ipairs(formatters) do
local remaining = timeout_ms - (uv.hrtime() / 1e6 - start)
if remaining <= 0 then
if quiet then
log.warn("Formatter '%s' timed out", formatter.name)
else
vim.notify(string.format("Formatter '%s' timed out", formatter.name), vim.log.levels.WARN)
end
return
end
local done = false
local result = nil
local config = assert(require("conform").get_formatter_config(formatter.name))
local ctx = M.build_context(bufnr, config, range)
local jid = run_formatter(bufnr, formatter, config, ctx, input_lines, function(err, output)
if err then
log.error(err)
end
done = true
result = output
end)
all_support_range_formatting = all_support_range_formatting and config.range_args ~= nil
local wait_result, wait_reason = vim.wait(remaining, function()
return done
end, 5)
if not wait_result then
if wait_reason == -1 then
if quiet then
log.warn("Formatter '%s' timed out", formatter.name)
else
vim.notify(string.format("Formatter '%s' timed out", formatter.name), vim.log.levels.WARN)
end
end
vim.fn.jobstop(jid)
return
end
if not result then
return
end
input_lines = result
end
local final_result = input_lines
apply_format(bufnr, original_lines, final_result, range, not all_support_range_formatting)
end
return M
|