Merge pull request #167 from jcsumlin/task/add-logging

Displays description on validation warnings/errors

Author: noahtigner

__tests__/index.test.ts

@@ -12,9 +12,11 @@ jest.mock('../src/validateInput');
 describe('validateEnvVars', () => {
 	let processExitSpy: jest.SpyInstance;
 	let consoleErrorSpy: jest.SpyInstance;
+	let consoleLogSpy: jest.SpyInstance;
 
 	beforeEach(() => {
 		consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
+		consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
 		processExitSpy = jest.spyOn(process, 'exit').mockImplementation();
 	});
 
@@ -145,4 +147,26 @@ describe('validateEnvVars', () => {
 			validateEnvVars({ schema, envPath });
 		}).not.toThrow();
 	});
+
+	it('descriptions are logged on console warning', () => {
+		const schema = z.object({
+			OPTIONAL_1: z
+				.string({ description: 'This is an optional variable' })
+				.optional(),
+			EXPECTED_2: z.string(),
+		});
+		const envPath = './__tests__/.env.test';
+
+		validateEnvVars({ schema, envPath });
+
+		expect(consoleLogSpy).toHaveBeenCalledTimes(3);
+		expect(consoleLogSpy).toHaveBeenNthCalledWith(
+			1,
+			expect.stringContaining('This is an optional variable')
+		);
+		expect(consoleLogSpy).toHaveBeenNthCalledWith(
+			2,
+			expect.not.stringContaining('This is an optional variable')
+		);
+	});
 });

src/logParseResults.ts

@@ -62,6 +62,11 @@ function logParseResults(
 
 	// loop over each variable and log the result
 	Object.entries(schemaKeys).forEach(([varName, res]) => {
+		// Try to get the description from the Zod option if present
+		let description = '';
+		if (typeof schema.shape[varName]?.description === 'string') {
+			description = `\n\r - ${schema.shape[varName].description}`;
+		}
 		// parsing succeeded
 		if (res.error === null && res.data !== '' && res.data !== 'undefined') {
 			const varValue = logVars
@@ -72,13 +77,13 @@ function logParseResults(
 		// no data, but parsing did not fail and the variable is optional
 		else if (res.error === null && res.optional) {
 			console.log(
-				`${WARN_SYMBOL} ${varName} ${WARN_COLOR}'${res.data}'${RESET_COLOR}`
+				`${WARN_SYMBOL} ${varName} ${WARN_COLOR}'${res.data}'${RESET_COLOR}${description}`
 			);
 		}
 		// parsing failed
 		else {
 			console.error(
-				`${ERR_SYMBOL} ${varName}: ${ERR_COLOR}${res.error}${RESET_COLOR}`
+				`${ERR_SYMBOL} ${varName}: ${ERR_COLOR}${res.error}${RESET_COLOR}${description}`
 			);
 			error_count++;
 		}

src/schemaTypes.ts

@@ -3,18 +3,19 @@ import {
 	enum as envEnum,
 	literal as envLiteral,
 	z,
+	RawCreateParams,
 } from 'zod';
 
-const nonEmpty = () =>
-	z.string().min(1, { message: 'Variable cannot be empty' });
+const nonEmpty = (params?: RawCreateParams) =>
+	z.string(params).min(1, { message: 'Variable cannot be empty' });
 
-const envNonEmptyString = () =>
-	nonEmpty().refine((val) => val != 'undefined', {
+const envNonEmptyString = (params?: RawCreateParams) =>
+	nonEmpty(params).refine((val) => val != 'undefined', {
 		message: `Variable cannot equal 'undefined'`,
 	});
 
-const envInteger = () =>
-	nonEmpty().regex(/^-?\d+$/, {
+const envInteger = (params?: RawCreateParams) =>
+	nonEmpty(params).regex(/^-?\d+$/, {
 		message: 'Variable must be a valid integer',
 	});