feat: 🔊 adjust logs to match new nextjs style

Author: HofmannZ

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

@@ -71,9 +71,9 @@ describe('getPublicEnv()', () => {
     getPublicEnv();
 
     expect(infoSpy).toHaveBeenCalledWith(
-      `${chalk.cyan(
-        `info`
-      )}  - [next-runtime-env] - Read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
+      `- ${chalk.magenta(
+        `event`
+      )} [next-runtime-env] read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
     );
   });
 });

src/helpers/get-public-env.ts

@@ -14,8 +14,8 @@ export function getPublicEnv() {
       {} as NodeJS.ProcessEnv
     );
 
-  log.info(
-    `Read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
+  log.event(
+    `read environment variables prefixed with 'NEXT_PUBLIC_' from process.env.`
   );
 
   return publicEnv;

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

@@ -8,9 +8,9 @@ const infoSpy = jest.spyOn(console, 'info');
 const base = fs.realpathSync(process.cwd());
 const path = `${base}/public`;
 const file = `${path}/__ENV.js`;
-const message = `${chalk.cyan(
-  `info`
-)}  - [next-runtime-env] - Wrote browser runtime environment variables to '${file}'.`;
+const message = `- ${chalk.green(
+  `ready`
+)} [next-runtime-env] wrote browser runtime environment variables to '${file}'.`;
 
 beforeAll(() => {
   infoSpy.mockImplementation();
@@ -71,9 +71,9 @@ describe('writeBrowserEnv()', () => {
 
   it('should write to a subdirectory', () => {
     const fileInSubdirectory = `${path}/subdirectory/__ENV.js`;
-    const messageWithSubdirectory = `${chalk.cyan(
-      `info`
-    )}  - [next-runtime-env] - Wrote browser runtime environment variables to '${fileInSubdirectory}'.`;
+    const messageWithSubdirectory = `- ${chalk.green(
+      `ready`
+    )} [next-runtime-env] wrote browser runtime environment variables to '${fileInSubdirectory}'.`;
 
     writeBrowserEnv({}, 'subdirectory/');
 

src/helpers/write-browser-env.ts

@@ -21,5 +21,5 @@ export function writeBrowserEnv(env: NodeJS.ProcessEnv, subdirectory = '') {
 
   fs.writeFileSync(file, content);
 
-  log.info(`Wrote browser runtime environment variables to '${file}'.`);
+  log.ready(`wrote browser runtime environment variables to '${file}'.`);
 }

src/make-env-public.spec.ts

@@ -60,31 +60,31 @@ describe('makeEnvPublic()', () => {
     makeEnvPublic(['BAR', 'BAZ']);
 
     expect(infoSpy).toHaveBeenCalledWith(
-      `${chalk.cyan(
-        `info`
-      )}  - [next-runtime-env] - Prefixed environment variable 'FOO'.`
+      `- ${chalk.magenta(
+        `event`
+      )} [next-runtime-env] prefixed environment variable 'FOO'.`
     );
 
     expect(infoSpy).toHaveBeenCalledWith(
-      `${chalk.cyan(
-        `info`
-      )}  - [next-runtime-env] - Prefixed environment variable 'BAR'.`
+      `- ${chalk.magenta(
+        `event`
+      )} [next-runtime-env] prefixed environment variable 'BAR'.`
     );
 
     expect(infoSpy).toHaveBeenCalledWith(
-      `${chalk.cyan(
-        `info`
-      )}  - [next-runtime-env] - Prefixed environment variable 'BAZ'.`
+      `- ${chalk.magenta(
+        `event`
+      )} [next-runtime-env] prefixed environment variable 'BAZ'.`
     );
   });
 
   it('should warn when prefixing a variable that is not available in process.env', () => {
     makeEnvPublic('FOO');
 
     expect(warnSpy).toHaveBeenCalledWith(
-      `${chalk.yellow(
+      `- ${chalk.yellow(
         `warn`
-      )}  - [next-runtime-env] - Skipped prefixing environment variable 'FOO'. Variable not in process.env.`
+      )} [next-runtime-env] skipped prefixing environment variable 'FOO'. Variable not in process.env.`
     );
   });
 
@@ -94,9 +94,9 @@ describe('makeEnvPublic()', () => {
     makeEnvPublic('NEXT_PUBLIC_FOO');
 
     expect(warnSpy).toHaveBeenCalledWith(
-      `${chalk.yellow(
+      `- ${chalk.yellow(
         `warn`
-      )}  - [next-runtime-env] - Environment variable 'NEXT_PUBLIC_FOO' is already public.`
+      )} [next-runtime-env] environment variable 'NEXT_PUBLIC_FOO' is already public.`
     );
   });
 });

src/make-env-public.ts

@@ -4,22 +4,22 @@ function prefixKey(key: string) {
   // Check if key is available in process.env.
   if (!process.env[key]) {
     log.warn(
-      `Skipped prefixing environment variable '${key}'. Variable not in process.env.`
+      `skipped prefixing environment variable '${key}'. Variable not in process.env.`
     );
 
     return;
   }
 
   // Check if key is already public.
   if (/^NEXT_PUBLIC_/i.test(key)) {
-    log.warn(`Environment variable '${key}' is already public.`);
+    log.warn(`environment variable '${key}' is already public.`);
   }
 
   const prefixedKey = `NEXT_PUBLIC_${key}`;
 
   process.env[prefixedKey] = process.env[key];
 
-  log.info(`Prefixed environment variable '${key}'.`);
+  log.event(`prefixed environment variable '${key}'.`);
 }
 
 /**

src/utils/log.ts

@@ -1,13 +1,12 @@
 import chalk from 'chalk';
 
 const libraryName = '[next-runtime-env]';
-const librarySeparator = '-';
-const libraryPrefix = `${libraryName} ${librarySeparator}`;
 
 const prefixes = {
-  // Double space before the dash aligns messages in the terminal and improves readability.
-  warn: `${chalk.yellow(`warn`)}  - ${libraryPrefix}`,
-  info: `${chalk.cyan(`info`)}  - ${libraryPrefix}`,
+  info: `- ${chalk.cyan(`info`)} ${libraryName}`,
+  warn: `- ${chalk.yellow(`warn`)} ${libraryName}`,
+  event: `- ${chalk.magenta(`event`)} ${libraryName}`,
+  ready: `- ${chalk.green(`ready`)} ${libraryName}`,
 };
 
 export function warn(message: string) {
@@ -19,3 +18,13 @@ export function info(message: string) {
   // eslint-disable-next-line no-console
   console.info(`${prefixes.info} ${message}`);
 }
+
+export function event(message: string) {
+  // eslint-disable-next-line no-console
+  console.info(`${prefixes.event} ${message}`);
+}
+
+export function ready(message: string) {
+  // eslint-disable-next-line no-console
+  console.info(`${prefixes.ready} ${message}`);
+}