Merge pull request #1 from expatfile/development

build: 🔖 release stable version

Author: HofmannZ

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [16, 18]
 
     steps:
       - name: Checkout
@@ -39,7 +39,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [16, 18]
 
     steps:
       - name: Checkout
@@ -61,7 +61,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [16, 18]
 
     steps:
       - name: Checkout

.npmignore

@@ -12,6 +12,7 @@ jest.config.js
 prettier.config.js
 tsconfig.json
 /.github
+/.vscode
 
 # source
 /src

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Expatfile.tax LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,7 @@
 # next-runtime-env - Runtime Environment Configuration
 
+[![codecov](https://codecov.io/gh/expatfile/next-runtime-env/branch/main/graph/badge.svg?token=mbGgsweFuP)](https://codecov.io/gh/expatfile/next-runtime-env)
+
 Populates your environment at **run-time** rather than **build-time**.
 
 - Isomorphic - Server, browser and middleware compatible.
@@ -13,12 +15,14 @@ Runtime environment variables are used in common best-practice patterns for buil
 1. Add the following lines to your `next.config.js`:
 
 ```js
-const { configureRuntimeEnv } = require('next-runtime-env');
+const {
+  configureRuntimeEnv,
+} = require('next-runtime-env/build/configure-runtime-env');
 
 configureRuntimeEnv();
 ```
 
-This will generates a `__ENV.js` file that contains white-listed environment variables that have a `NEXT_PUBLIC_` prefix.
+This will generates a `__ENV.js` file that contains allow-listed environment variables that have a `NEXT_PUBLIC_` prefix.
 
 2. Add the following to the head section fo your `pages/_document.js`:
 
@@ -27,11 +31,15 @@ This will generates a `__ENV.js` file that contains white-listed environment var
 <script src="/__ENV.js" />
 ```
 
-Done! ✅
+Done!
 
 ### Usage 🧑‍💻
 
-In the browser your variables will be available at `window.__ENV.NEXT_PUBLIC_FOO` and on the server `process.env.NEXT_PUBLIC_FOO`. We have included a helper function to make retrieving a value easier:
+In the browser your variables will be available at `window.__ENV.NEXT_PUBLIC_FOO` and on the server `process.env.NEXT_PUBLIC_FOO`.
+
+#### Helper 😉
+
+We have included a helper function to make retrieving a value easier:
 
 ```bash
 # .env

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

@@ -0,0 +1,57 @@
+import { getPublicEnv } from './get-public-env';
+
+describe('getPublicEnv', () => {
+  afterEach(() => {
+    delete process.env.FOO;
+    delete process.env.BAR;
+    delete process.env.BAR;
+    delete process.env.NEXT_PUBLIC_FOO;
+    delete process.env.NEXT_PUBLIC_BAR;
+    delete process.env.NEXT_PUBLIC_BAZ;
+  });
+
+  it('should return a allow-listed value', () => {
+    process.env.NEXT_PUBLIC_FOO = 'foo';
+
+    expect(getPublicEnv()).toEqual({
+      NEXT_PUBLIC_FOO: 'foo',
+    });
+  });
+
+  it('should return multiple allow-listed values', () => {
+    process.env.NEXT_PUBLIC_FOO = 'foo';
+    process.env.NEXT_PUBLIC_BAR = 'bar';
+    process.env.NEXT_PUBLIC_BAZ = 'baz';
+
+    expect(getPublicEnv()).toEqual({
+      NEXT_PUBLIC_FOO: 'foo',
+      NEXT_PUBLIC_BAR: 'bar',
+      NEXT_PUBLIC_BAZ: 'baz',
+    });
+  });
+
+  it('should not return a non allow-listed value', () => {
+    process.env.FOO = 'foo';
+
+    expect(getPublicEnv()).toEqual({});
+  });
+
+  it('should not return multiple non allow-listed values', () => {
+    process.env.FOO = 'foo';
+    process.env.BAR = 'bar';
+    process.env.BAZ = 'baz';
+
+    expect(getPublicEnv()).toEqual({});
+  });
+
+  it('should not return a mixed list of allow-listed and non allow-listed values', () => {
+    process.env.NEXT_PUBLIC_FOO = 'foo';
+    process.env.BAR = 'bar';
+    process.env.NEXT_PUBLIC_BAZ = 'baz';
+
+    expect(getPublicEnv()).toEqual({
+      NEXT_PUBLIC_FOO: 'foo',
+      NEXT_PUBLIC_BAZ: 'baz',
+    });
+  });
+});

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

@@ -0,0 +1,74 @@
+import fs from 'fs';
+
+import { writeBrowserEnv } from './write-browser-env';
+
+const infoSpy = jest.spyOn(console, 'info');
+
+const base = fs.realpathSync(process.cwd());
+const path = `${base}/public`;
+const file = `${path}/__ENV.js`;
+
+beforeAll(() => {
+  infoSpy.mockImplementation();
+
+  fs.mkdirSync(path);
+});
+
+afterAll(() => {
+  infoSpy.mockRestore();
+
+  fs.rmdirSync(path);
+});
+
+describe('writeBrowserEnv', () => {
+  afterEach(() => {
+    fs.rmSync(file);
+  });
+
+  it('should write an empty env', () => {
+    writeBrowserEnv({});
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      'next-runtime-env: Writing browser runtime env',
+      file
+    );
+
+    const content = fs.readFileSync(file).toString();
+
+    expect(content).toEqual('window.__ENV = {};');
+  });
+
+  it('should write and env with a value', () => {
+    writeBrowserEnv({
+      NEXT_PUBLIC_FOO: 'foo',
+    });
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      'next-runtime-env: Writing browser runtime env',
+      file
+    );
+
+    const content = fs.readFileSync(file).toString();
+
+    expect(content).toEqual('window.__ENV = {"NEXT_PUBLIC_FOO":"foo"};');
+  });
+
+  it('should write and env with multiple values', () => {
+    writeBrowserEnv({
+      NEXT_PUBLIC_FOO: 'foo',
+      NEXT_PUBLIC_BAR: 'bar',
+      NEXT_PUBLIC_BAZ: 'baz',
+    });
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      'next-runtime-env: Writing browser runtime env',
+      file
+    );
+
+    const content = fs.readFileSync(file).toString();
+
+    expect(content).toEqual(
+      'window.__ENV = {"NEXT_PUBLIC_FOO":"foo","NEXT_PUBLIC_BAR":"bar","NEXT_PUBLIC_BAZ":"baz"};'
+    );
+  });
+});

src/helpers/write-browser-env.ts

@@ -1,4 +1,4 @@
-import fs from 'node:fs';
+import fs from 'fs';
 
 /**
  * Writes the environment variables to the public __ENV.js file and make them
@@ -11,7 +11,7 @@ export function writeBrowserEnv(env: NodeJS.ProcessEnv) {
   // eslint-disable-next-line no-console
   console.info('next-runtime-env: Writing browser runtime env', path);
 
-  const populate = `window.__ENV = ${JSON.stringify(env)};`;
+  const content = `window.__ENV = ${JSON.stringify(env)};`;
 
-  fs.writeFileSync(path, populate);
+  fs.writeFileSync(path, content);
 }

src/index.ts

@@ -1,9 +1,10 @@
+/* istanbul ignore file */
+
 // This allows TypeScript to detect our global value.
 declare global {
   interface Window {
     __ENV: NodeJS.ProcessEnv;
   }
 }
 
-export { configureRuntimeEnv } from './configure-runtime-env';
 export { env } from './env';