Remove now-redundant testOnly util

Author: af

README.md

@@ -221,32 +221,6 @@ argument required in the third position:
   middleware (see src/middleware.ts), which you can mix and match with your own
   custom logic to get the behavior you desire.
 
-## Utils
-
-### testOnly
-
-The `testOnly` helper function is available for setting a default value for an env var only when `NODE_ENV=test`. It is used by wrapping a `devDefault` value:
-
-```js
-const env = cleanEnv(process.env, {
-  SOME_VAR: envalid.str({ devDefault: testOnly('myTestValue') }),
-})
-```
-
-Because `testOnly` is applied via `devDefault`, you cannot use it to express both a development default _and_ a separate test default. For that, prefer the `testDefault` spec attribute, which can be combined freely with `default` and `devDefault`:
-
-```js
-const env = cleanEnv(process.env, {
-  SOME_VAR: envalid.str({
-    default: 'productionValue',
-    devDefault: 'devValue',
-    testDefault: 'myTestValue',
-  }),
-})
-```
-
-For more context see [this issue](https://github.com/af/envalid/issues/32).
-
 ## FAQ
 
 ### Can I call `structuredClone()` on Envalid's validated output?

src/core.ts

@@ -2,8 +2,6 @@ import { EnvError, EnvMissingError } from './errors'
 import type { CleanOptions, SpecsOutput, Spec, ValidatorSpec } from './types'
 import { defaultReporter } from './reporter'
 
-export const testOnlySymbol = Symbol('envalid - test only')
-
 /**
  * Validate a single env var, given a spec object
  *
@@ -46,8 +44,6 @@ const readRawEnvValue = <T>(env: unknown, k: keyof T | 'NODE_ENV'): string | T[k
   return (env as any)[k]
 }
 
-const isTestOnlySymbol = (value: any): value is symbol => value === testOnlySymbol
-
 /**
  * Perform the central validation/sanitization logic on the full environment object
  */
@@ -82,11 +78,6 @@ export function getSanitizedEnv<S>(
 
         if (usingDevDefault) {
           cleanedEnv[k] = spec.devDefault
-
-          if (isTestOnlySymbol(spec.devDefault) && rawNodeEnv != 'test') {
-            throw new EnvMissingError(formatSpecDescription(spec))
-          }
-
           continue
         }
 
@@ -107,7 +98,7 @@ export function getSanitizedEnv<S>(
     }
   }
 
-  // This block is for supporting requiredWhen. If that field was provided for a var's spec and 
+  // This block is for supporting requiredWhen. If that field was provided for a var's spec and
   // its condition evaluates to a truthy value, ensure that env var is present.
   for (const k of varKeys) {
     if (errors[k] == undefined) {

src/envalid.ts

@@ -1,5 +1,5 @@
 import type { CleanedEnv, CleanOptions } from './types'
-import { getSanitizedEnv, testOnlySymbol } from './core'
+import { getSanitizedEnv } from './core'
 import { applyDefaultMiddleware } from './middleware'
 
 /**
@@ -38,12 +38,3 @@ export function customCleanEnv<S, MW>(
   const cleaned = getSanitizedEnv(environment, specs, options)
   return Object.freeze(applyMiddleware(cleaned as CleanedEnv<S>, environment))
 }
-
-/**
- * Utility function for providing default values only when NODE_ENV=test
- *
- * For more context, see https://github.com/af/envalid/issues/32
- */
-export const testOnly = <T>(defaultValueForTests: T) => {
-  return process.env.NODE_ENV === 'test' ? defaultValueForTests : (testOnlySymbol as unknown as T) // T is not strictly correct, but prevents type errors during usage
-}

src/types.ts

@@ -26,8 +26,6 @@ export interface Spec<T> {
   devDefault?: NonNullable<T> | undefined
   /**
    * A fallback value to use only when NODE_ENV is 'test'. Takes priority over `devDefault` and `default`.
-   * Unlike the `testOnly()` helper (which wraps a `devDefault` value), `testDefault` can be combined
-   * with both `default` and `devDefault` to specify distinct values for production, development, and test.
    */
   testDefault?: NonNullable<T> | undefined
 
@@ -125,16 +123,16 @@ export type SpecsOutput<S> = {
 
 export type CleanedEnv<S> =
   S extends Record<string, ValidatorSpec<unknown>>
-  ? Readonly<
-    {
-      [K in keyof S]: S[K] extends OptionalValidatorSpec<infer U>
-      ? U | undefined
-      : S[K] extends RequiredValidatorSpec<infer U>
-      ? U
-      : never
-    } & CleanedEnvAccessors
-  >
-  : never
+    ? Readonly<
+        {
+          [K in keyof S]: S[K] extends OptionalValidatorSpec<infer U>
+            ? U | undefined
+            : S[K] extends RequiredValidatorSpec<infer U>
+              ? U
+              : never
+        } & CleanedEnvAccessors
+      >
+    : never
 
 export interface CleanedEnvAccessors {
   /** true if NODE_ENV === 'development' */

tests/basics.test.ts

@@ -1,5 +1,5 @@
 import { describe, test, expect, vi } from 'vitest'
-import { cleanEnv, str, num, testOnly, type ReporterOptions } from '../src'
+import { cleanEnv, str, num, type ReporterOptions } from '../src'
 import { assertPassthrough } from './utils'
 import { expectTypeOf } from 'expect-type'
 
@@ -297,49 +297,3 @@ describe('NODE_ENV built-in support', () => {
     expect(cleanEnv({}, customSpec).isDevelopment).toEqual(false)
   })
 })
-
-test('testOnly', () => {
-  const processEnv = process.env.NODE_ENV
-
-  const reporter = vi.fn(({ errors = {} }: ReporterOptions<any>) => {
-    if (Object.keys(errors).length) {
-      throw new Error()
-    }
-  })
-
-  // Create an env spec that has our testOnly value applied as the devDefault,
-  // and then restore the original NODE_ENV
-  process.env.NODE_ENV = 'test'
-  const env = cleanEnv(
-    { NODE_ENV: 'test' },
-    { FOO: str({ devDefault: testOnly('sup') }) },
-    { reporter },
-  )
-  expect(env).toEqual({ FOO: 'sup' })
-  expect(reporter).toHaveBeenCalledTimes(1)
-  vi.clearAllMocks()
-
-  process.env.NODE_ENV = 'production'
-  expect(() =>
-    cleanEnv(
-      { NODE_ENV: 'production' },
-      { FOO: str({ devDefault: testOnly('sup') }) },
-      { reporter },
-    ),
-  ).toThrow()
-  expect(reporter).toHaveBeenCalledTimes(1)
-  vi.clearAllMocks()
-
-  process.env.NODE_ENV = 'development'
-  expect(() =>
-    cleanEnv(
-      { NODE_ENV: 'development' },
-      { FOO: str({ devDefault: testOnly('sup') }) },
-      { reporter },
-    ),
-  ).toThrow()
-  expect(reporter).toHaveBeenCalledTimes(1)
-  vi.clearAllMocks()
-
-  process.env.NODE_ENV = processEnv
-})