feat: add support for environment variables (#8)

README.md

@@ -250,6 +250,10 @@ require("conform").setup({
       end,
       -- Exit codes that indicate success (default {0})
       exit_codes = { 0, 1 },
+      -- Environment variables. This can also be a function that returns a table.
+      env = {
+        VAR = "value",
+      },
     },
     -- These can also be a function that returns the formatter
     other_formatter = function()

doc/conform.txt

@@ -62,6 +62,10 @@ OPTIONS                                                          *conform-option
           end,
           -- Exit codes that indicate success (default {0})
           exit_codes = { 0, 1 },
+          -- Environment variables. This can also be a function that returns a table.
+          env = {
+            VAR = "value",
+          },
         },
         -- These can also be a function that returns the formatter
         other_formatter = function()

lua/conform/init.lua

@@ -16,6 +16,7 @@ local M = {}
 ---@field stdin? boolean Send buffer contents to stdin (default true)
 ---@field condition? fun(ctx: conform.Context): boolean
 ---@field exit_codes? integer[] Exit codes that indicate success (default {0})
+---@field env? table<string, any>|fun(ctx: conform.Context): table<string, any>
 
 ---@class (exact) conform.FileFormatterConfig : conform.FormatterConfig
 ---@field meta conform.FormatterMeta

lua/conform/runner.lua

@@ -104,6 +104,10 @@ local function run_formatter(bufnr, formatter, config, ctx, input_lines, callbac
   if config.cwd then
     cwd = config.cwd(ctx)
   end
+  local env = config.env
+  if type(env) == "function" then
+    env = env(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)
@@ -121,11 +125,15 @@ local function run_formatter(bufnr, formatter, config, ctx, input_lines, callbac
   if cwd then
     log.debug("Run CWD: %s", cwd)
   end
+  if env then
+    log.debug("Run ENV: %s", env)
+  end
   local stdout
   local stderr
   local exit_codes = config.exit_codes or { 0 }
   local jid = vim.fn.jobstart(cmd, {
     cwd = cwd,
+    env = env,
     stdout_buffered = true,
     stderr_buffered = true,
     stdin = config.stdin and "pipe" or "null",

tests/options_doc.lua

@@ -48,6 +48,10 @@ require("conform").setup({
       end,
       -- Exit codes that indicate success (default {0})
       exit_codes = { 0, 1 },
+      -- Environment variables. This can also be a function that returns a table.
+      env = {
+        VAR = "value",
+      },
     },
     -- These can also be a function that returns the formatter
     other_formatter = function()