Feat/973 provide configuration via env vars

.size-limit.json

@@ -2,14 +2,14 @@
   {
     "name": "zx/core",
     "path": ["build/core.cjs", "build/util.cjs", "build/vendor-core.cjs"],
-    "limit": "73 kB",
+    "limit": "74 kB",
     "brotli": false,
     "gzip": false
   },
   {
     "name": "zx/index",
     "path": "build/*.{js,cjs}",
-    "limit": "800 kB",
+    "limit": "801 kB",
     "brotli": false,
     "gzip": false
   },

src/core.ts

@@ -52,6 +52,7 @@ import {
   proxyOverride,
   quote,
   quotePowerShell,
+  camelToSnake,
 } from './util.js'
 
 const CWD = Symbol('processCwd')
@@ -81,7 +82,7 @@ export interface Options {
   verbose:        boolean
   sync:           boolean
   env:            NodeJS.ProcessEnv
-  shell:          string | boolean
+  shell:          string | true
   nothrow:        boolean
   prefix:         string
   postfix:        string
@@ -97,29 +98,63 @@ export interface Options {
   killSignal?:    NodeJS.Signals
   halt?:          boolean
 }
-// prettier-ignore
-export const defaults: Options = {
-  [CWD]:          process.cwd(),
-  [SYNC]:         false,
-  verbose:        false,
-  env:            process.env,
-  sync:           false,
-  shell:          true,
-  stdio:          'pipe',
-  nothrow:        false,
-  quiet:          false,
-  prefix:         '',
-  postfix:        '',
-  detached:       false,
-  preferLocal:    false,
-  spawn,
-  spawnSync,
-  log,
-  kill,
-  killSignal:     SIGTERM,
-  timeoutSignal:  SIGTERM,
+
+export function getZxDefaults(
+  defs: Options,
+  extra: Partial<Options> = {
+    cwd: '',
+    halt: false,
+    preferLocal: '',
+    input: '',
+  },
+  prefix: string = 'ZX_',
+  env = process.env
+) {
+  const process = (opts: Partial<Options>) => {
+    const o: Record<string, string | boolean> = {}
+    for (const [dk, dv] of Object.entries(opts)) {
+      const ek = prefix + camelToSnake(dk)
+      const ev = env[ek]
+      if (typeof ev !== 'undefined') {
+        const v = { true: true, false: false }[ev.toLowerCase()] ?? ev
+        if (typeof v === typeof dv) {
+          o[dk] = v
+        }
+      }
+    }
+    return o
+  }
+  const subset1 = process(defs)
+  const subset2 = process(extra)
+
+  return Object.assign(defs, subset1, subset2)
 }
 
+// prettier-ignore
+export const defaults: Options = getZxDefaults(
+  {
+    [CWD]: process.cwd(),
+    [SYNC]: false,
+    verbose: false,
+    env: process.env,
+    sync: false,
+    shell: true,
+    stdio: 'pipe',
+    nothrow: false,
+    quiet: false,
+    prefix: '',
+    postfix: '',
+    detached: false,
+    preferLocal: false,
+    spawn,
+    spawnSync,
+    log,
+    kill,
+    killSignal: SIGTERM,
+    timeoutSignal: SIGTERM,
+  },
+)
+
 // prettier-ignore
 export interface Shell<
   S = false,

src/util.ts

@@ -462,3 +462,10 @@ export const proxyOverride = <T extends object>(
       )
     },
   }) as T
+
+// https://stackoverflow.com/questions/7888238/javascript-split-string-on-uppercase-characters
+export const camelToSnake = (str: string) =>
+  str
+    .split(/(?=[A-Z])/)
+    .map((s) => s.toUpperCase())
+    .join('_')

test/core.test.js

@@ -19,10 +19,46 @@ import { basename } from 'node:path'
 import { WriteStream } from 'node:fs'
 import { Readable, Transform, Writable } from 'node:stream'
 import { Socket } from 'node:net'
-import { ProcessPromise, ProcessOutput } from '../build/index.js'
+import { ProcessPromise, ProcessOutput, getZxDefaults } from '../build/index.js'
 import '../build/globals.js'
 
 describe('core', () => {
+  describe('getZxDefaults', () => {
+    test('verbose rewrite', async () => {
+      const defaults = getZxDefaults({ verbose: false }, {}, 'ZX_', {
+        ZX_VERBOSE: 'true',
+      })
+      assert.equal(defaults.verbose, true)
+    })
+    test('verbose ignore', async () => {
+      const defaults = getZxDefaults({ verbose: false }, {}, 'ZX_', {
+        ZX_VERBOSE: 'true123',
+      })
+      assert.equal(defaults.verbose, false)
+    })
+    test('input in extra', async () => {
+      const defaults = getZxDefaults({}, { input: '' }, 'ZX_', {
+        ZX_INPUT: 'input',
+      })
+      assert.equal(defaults.input, 'input')
+    })
+    test('preferLocal rewrite boolean', async () => {
+      const defaults = getZxDefaults({ preferLocal: false }, {}, 'ZX_', {
+        ZX_PREFER_LOCAL: 'true',
+      })
+      assert.equal(defaults.preferLocal, true)
+    })
+    test('preferLocal rewrite string', async () => {
+      const defaults = getZxDefaults(
+        { preferLocal: false },
+        { preferLocal: '' },
+        'ZX_',
+        { ZX_PREFER_LOCAL: 'true123' }
+      )
+      assert.equal(defaults.preferLocal, 'true123')
+    })
+  })
+
   describe('$', () => {
     test('is a regular function', async () => {
       const _$ = $.bind(null)
@@ -42,12 +78,14 @@ describe('core', () => {
       process.env.ZX_TEST_FOO = 'foo'
       const foo = await $`echo $ZX_TEST_FOO`
       assert.equal(foo.stdout, 'foo\n')
+      delete process.env.ZX_TEST_FOO
     })
 
     test('env vars are safe to pass', async () => {
       process.env.ZX_TEST_BAR = 'hi; exit 1'
       const bar = await $`echo $ZX_TEST_BAR`
       assert.equal(bar.stdout, 'hi; exit 1\n')
+      delete process.env.ZX_TEST_BAR
     })
 
     test('arguments are quoted', async () => {

test/util.test.js

@@ -31,6 +31,7 @@ import {
   tempdir,
   tempfile,
   preferLocalBin,
+  camelToSnake,
 } from '../build/util.js'
 
 describe('util', () => {
@@ -191,3 +192,9 @@ test('preferLocalBin()', () => {
     `${process.cwd()}/node_modules/.bin:${process.cwd()}:${env.PATH}`
   )
 })
+test('camelToSnake()', () => {
+  assert.equal(camelToSnake('verbose'), 'VERBOSE')
+  assert.equal(camelToSnake('nothrow'), 'NOTHROW')
+  assert.equal(camelToSnake('preferLocal'), 'PREFER_LOCAL')
+  assert.equal(camelToSnake('someMoreBigStr'), 'SOME_MORE_BIG_STR')
+})