feat: ✨ next.js style terminal string styling

Author: davevanhoorn

src/helpers/get-public-env.spec.ts

@@ -1,3 +1,5 @@
+import chalk from 'chalk';
+
 import { getPublicEnv } from './get-public-env';
 
 const infoSpy = jest.spyOn(console, 'info');
@@ -20,7 +22,17 @@ describe('getPublicEnv()', () => {
     delete process.env.NEXT_PUBLIC_BAZ;
   });
 
-  it('should return a allow-listed value', () => {
+  it('should show an info message after reading the environment', () => {
+    getPublicEnv();
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      `${chalk.cyan(
+        `info`
+      )}  - [next-runtime-env] - Read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
+    );
+  });
+
+  it('should return an allow-listed value', () => {
     process.env.NEXT_PUBLIC_FOO = 'foo';
 
     expect(getPublicEnv()).toEqual({

src/helpers/get-public-env.ts

@@ -1,14 +1,10 @@
-import * as log from '../output/log';
+import * as log from '../utils/log';
 
 /**
  * Gets a list of environment variables that start with `NEXT_PUBLIC_`.
  */
 export function getPublicEnv() {
-  log.info(
-    `Get environment variables prefixed with 'NEXT_PUBLIC_' from process.env`
-  );
-
-  return Object.keys(process.env)
+  const publicEnv = Object.keys(process.env)
     .filter((key) => /^NEXT_PUBLIC_/i.test(key))
     .reduce(
       (env, key) => ({
@@ -17,4 +13,10 @@ export function getPublicEnv() {
       }),
       {} as NodeJS.ProcessEnv
     );
+
+  log.info(
+    `Read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
+  );
+
+  return publicEnv;
 }

src/helpers/write-browser-env.spec.ts

@@ -10,7 +10,7 @@ const path = `${base}/public`;
 const file = `${path}/__ENV.js`;
 const message = `${chalk.cyan(
   `info`
-)}  - [next-runtime-env] - Write browser runtime environment variables to ${file}`;
+)}  - [next-runtime-env] - Wrote browser runtime environment variables to ${file}`;
 
 beforeAll(() => {
   infoSpy.mockImplementation();

src/helpers/write-browser-env.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 
-import * as log from '../output/log';
+import * as log from '../utils/log';
 
 /**
  * Writes the environment variables to the public __ENV.js file and make them
@@ -10,9 +10,9 @@ export function writeBrowserEnv(env: NodeJS.ProcessEnv) {
   const base = fs.realpathSync(process.cwd());
   const path = `${base}/public/__ENV.js`;
 
-  log.info(`Write browser runtime environment variables to ${path}`);
-
   const content = `window.__ENV = ${JSON.stringify(env)};`;
 
   fs.writeFileSync(path, content);
+
+  log.info(`Wrote browser runtime environment variables to ${path}`);
 }

src/make-env-public.spec.ts

@@ -30,12 +30,6 @@ describe('makeEnvPublic()', () => {
 
     makeEnvPublic('FOO');
 
-    expect(infoSpy).toHaveBeenCalledWith(
-      `${chalk.cyan(
-        `info`
-      )}  - [next-runtime-env] - Prefix environment variable 'FOO'.`
-    );
-
     expect(process.env.FOO).toEqual('foo');
     expect(process.env.NEXT_PUBLIC_FOO).toEqual('foo');
   });
@@ -49,12 +43,41 @@ describe('makeEnvPublic()', () => {
 
     expect(process.env.FOO).toEqual('foo');
     expect(process.env.NEXT_PUBLIC_FOO).toEqual('foo');
+
     expect(process.env.BAR).toEqual('bar');
     expect(process.env.NEXT_PUBLIC_BAR).toEqual('bar');
+
     expect(process.env.BAZ).toEqual('baz');
     expect(process.env.NEXT_PUBLIC_BAZ).toEqual('baz');
   });
 
+  it('should show an info message when env vars are prefixed', () => {
+    process.env.FOO = 'foo';
+    process.env.BAR = 'bar';
+    process.env.BAZ = 'baz';
+
+    makeEnvPublic('FOO');
+    makeEnvPublic(['BAR', 'BAZ']);
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      `${chalk.cyan(
+        `info`
+      )}  - [next-runtime-env] - Prefixed environment variable 'FOO'.`
+    );
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      `${chalk.cyan(
+        `info`
+      )}  - [next-runtime-env] - Prefixed environment variable 'BAR'.`
+    );
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      `${chalk.cyan(
+        `info`
+      )}  - [next-runtime-env] - Prefixed environment variable 'BAZ'.`
+    );
+  });
+
   it('should warn when the env var already starts with NEXT_PUBLIC_', () => {
     process.env.NEXT_PUBLIC_FOO = 'foo';
 
@@ -63,7 +86,7 @@ describe('makeEnvPublic()', () => {
     expect(warnSpy).toHaveBeenCalledWith(
       `${chalk.yellow(
         `warn`
-      )}  - [next-runtime-env] - Prefix environment variable 'NEXT_PUBLIC_FOO' is already public.`
+      )}  - [next-runtime-env] - Environment variable 'NEXT_PUBLIC_FOO' is already public.`
     );
   });
 });

src/make-env-public.ts

@@ -1,16 +1,16 @@
-import * as log from './output/log';
+import * as log from './utils/log';
 
 function prefixKey(key: string) {
   // Check if the key already is already public.
   if (/^NEXT_PUBLIC_/i.test(key)) {
-    log.warn(`Prefix environment variable '${key}' is already public.`);
+    log.warn(`Environment variable '${key}' is already public.`);
   }
 
-  log.info(`Prefix environment variable '${key}'.`);
-
   const prefixedKey = `NEXT_PUBLIC_${key}`;
 
   process.env[prefixedKey] = process.env[key];
+
+  log.info(`Prefixed environment variable '${key}'.`);
 }
 
 /**