Merge pull request #13 from expatfile/development

chore: 🔖 release stable version

Author: HofmannZ

src/configure.spec.ts

@@ -19,15 +19,39 @@ const mockWriteBrowserEnv = writeBrowserEnv as jest.MockedFunction<
   typeof writeBrowserEnv
 >;
 
+afterEach(() => {
+  mockGetPublicEnv.mockClear();
+  mockWriteBrowserEnv.mockClear();
+});
+
 describe('configureRuntimeEnv()', () => {
   it('should call the helper methods', () => {
     configureRuntimeEnv();
 
     expect(mockGetPublicEnv).toHaveBeenCalledTimes(1);
 
     expect(mockWriteBrowserEnv).toHaveBeenCalledTimes(1);
-    expect(mockWriteBrowserEnv).toHaveBeenCalledWith({
-      NEXT_PUBLIC_FOO: 'foo',
+    expect(mockWriteBrowserEnv).toHaveBeenCalledWith(
+      {
+        NEXT_PUBLIC_FOO: 'foo',
+      },
+      undefined
+    );
+  });
+
+  it('should call the helper methods with options', () => {
+    configureRuntimeEnv({
+      subdirectory: 'subdirectory/',
     });
+
+    expect(mockGetPublicEnv).toHaveBeenCalledTimes(1);
+
+    expect(mockWriteBrowserEnv).toHaveBeenCalledTimes(1);
+    expect(mockWriteBrowserEnv).toHaveBeenCalledWith(
+      {
+        NEXT_PUBLIC_FOO: 'foo',
+      },
+      'subdirectory/'
+    );
   });
 });

src/configure.ts

@@ -1,13 +1,29 @@
 import { getPublicEnv } from './helpers/get-public-env';
 import { writeBrowserEnv } from './helpers/write-browser-env';
 
+export type ConfigureRuntimeEnvOptions = {
+  /**
+   * The subdirectory of `/public` where the `__ENV.js` file should be written
+   * eg. `subdirectory/`to.
+   */
+  subdirectory?: string;
+};
+
 /**
  * Reads all environment variables that start with `NEXT_PUBLIC_` and writes
  * them to the public `__ENV.js` file. This makes them accessible under the
  * `window.__ENV` object.
+ *
+ * Options:
+ * ```ts
+ * type ConfigureRuntimeEnvOptions = {
+ *  // The subdirectory of `/public` where the `__ENV.js` file should be written to. eg. `subdirectory/`
+ *  subdirectory?: string;
+ * };
+ * ```
  */
-export function configureRuntimeEnv() {
+export function configureRuntimeEnv(options?: ConfigureRuntimeEnvOptions) {
   const publicEnv = getPublicEnv();
 
-  writeBrowserEnv(publicEnv);
+  writeBrowserEnv(publicEnv, options?.subdirectory);
 }

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

@@ -21,14 +21,10 @@ beforeAll(() => {
 afterAll(() => {
   infoSpy.mockRestore();
 
-  fs.rmdirSync(path);
+  fs.rmSync(path, { recursive: true, force: true });
 });
 
 describe('writeBrowserEnv()', () => {
-  afterEach(() => {
-    fs.rmSync(file);
-  });
-
   it('should write an empty env', () => {
     writeBrowserEnv({});
 
@@ -37,6 +33,8 @@ describe('writeBrowserEnv()', () => {
     const content = fs.readFileSync(file).toString();
 
     expect(content).toEqual('window.__ENV = {};');
+
+    fs.rmSync(file);
   });
 
   it('should write and env with a value', () => {
@@ -49,6 +47,8 @@ describe('writeBrowserEnv()', () => {
     const content = fs.readFileSync(file).toString();
 
     expect(content).toEqual('window.__ENV = {"NEXT_PUBLIC_FOO":"foo"};');
+
+    fs.rmSync(file);
   });
 
   it('should write and env with multiple values', () => {
@@ -65,5 +65,24 @@ describe('writeBrowserEnv()', () => {
     expect(content).toEqual(
       'window.__ENV = {"NEXT_PUBLIC_FOO":"foo","NEXT_PUBLIC_BAR":"bar","NEXT_PUBLIC_BAZ":"baz"};'
     );
+
+    fs.rmSync(file);
+  });
+
+  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}'.`;
+
+    writeBrowserEnv({}, 'subdirectory/');
+
+    expect(infoSpy).toHaveBeenCalledWith(messageWithSubdirectory);
+
+    const content = fs.readFileSync(fileInSubdirectory).toString();
+
+    expect(content).toEqual('window.__ENV = {};');
+
+    fs.rmSync(fileInSubdirectory);
   });
 });

src/helpers/write-browser-env.ts

@@ -1,18 +1,25 @@
 import fs from 'fs';
+import path from 'path';
 
 import * as log from '../utils/log';
 
 /**
  * Writes the environment variables to the public __ENV.js file and make them
  * accessible under `window.__ENV`.
  */
-export function writeBrowserEnv(env: NodeJS.ProcessEnv) {
+export function writeBrowserEnv(env: NodeJS.ProcessEnv, subdirectory = '') {
   const base = fs.realpathSync(process.cwd());
-  const path = `${base}/public/__ENV.js`;
+  const file = `${base}/public/${subdirectory}__ENV.js`;
 
   const content = `window.__ENV = ${JSON.stringify(env)};`;
 
-  fs.writeFileSync(path, content);
+  const dirname = path.dirname(file);
 
-  log.info(`Wrote browser runtime environment variables to '${path}'.`);
+  if (!fs.existsSync(dirname)) {
+    fs.mkdirSync(dirname, { recursive: true });
+  }
+
+  fs.writeFileSync(file, content);
+
+  log.info(`Wrote browser runtime environment variables to '${file}'.`);
 }