chore: better describe the accepted config type and more extensive test

Author: NamesMT

src/utils/__tests__/config.spec.ts

@@ -31,14 +31,44 @@ describe("injectEnv", () => {
 			key: "${env:API_KEY}",
 			url: "${env:ENDPOINT}",
 			nested: {
-				value: "Keep this ${env:API_KEY}",
+				string: "Keep this ${env:API_KEY}",
+				number: 123,
+				boolean: true,
+				stringArr: ["${env:API_KEY}", "${env:ENDPOINT}"],
+				numberArr: [123, 456],
+				booleanArr: [true, false],
+			},
+			deeply: {
+				nested: {
+					string: "Keep this ${env:API_KEY}",
+					number: 123,
+					boolean: true,
+					stringArr: ["${env:API_KEY}", "${env:ENDPOINT}"],
+					numberArr: [123, 456],
+					booleanArr: [true, false],
+				},
 			},
 		}
 		const expectedObject = {
 			key: "12345",
 			url: "https://example.com",
 			nested: {
-				value: "Keep this 12345",
+				string: "Keep this 12345",
+				number: 123,
+				boolean: true,
+				stringArr: ["12345", "https://example.com"],
+				numberArr: [123, 456],
+				booleanArr: [true, false],
+			},
+			deeply: {
+				nested: {
+					string: "Keep this 12345",
+					number: 123,
+					boolean: true,
+					stringArr: ["12345", "https://example.com"],
+					numberArr: [123, 456],
+					booleanArr: [true, false],
+				},
 			},
 		}
 		const result = await injectEnv(configObject)

src/utils/config.ts

@@ -1,11 +1,23 @@
+export type InjectableConfigType =
+	| string
+	| {
+			[key: string]:
+				| undefined
+				| null
+				| boolean
+				| number
+				| InjectableConfigType
+				| Array<undefined | null | boolean | number | InjectableConfigType>
+	  }
+
 /**
  * Deeply injects environment variables into a configuration object/string/json
  *
  * Uses VSCode env:name pattern: https://code.visualstudio.com/docs/reference/variables-reference#_environment-variables
  *
  * Does not mutate original object
  */
-export async function injectEnv<C extends string | Record<PropertyKey, any>>(config: C, notFoundValue: any = "") {
+export async function injectEnv<C extends InjectableConfigType>(config: C, notFoundValue: any = "") {
 	return injectVariables(config, { env: process.env }, notFoundValue)
 }
 
@@ -20,8 +32,8 @@ export async function injectEnv<C extends string | Record<PropertyKey, any>>(con
  *
  * Matched keys that have `null` | `undefined` values are treated as not found.
  */
-export async function injectVariables<C extends string | Record<PropertyKey, any>>(
-	config: string | Record<PropertyKey, any>,
+export async function injectVariables<C extends InjectableConfigType>(
+	config: C,
 	variables: Record<string, undefined | null | string | Record<string, undefined | null | string>>,
 	propNotFoundValue?: any,
 ) {