Added support for automatic APP_ROOT environment variable.

readme.md

@@ -20,16 +20,15 @@ Universal DotEnv - A Robust Environment Configuration for Universal Applications
 ## Features
 
 - Supports loading `.env` files with overriding between different `NODE_ENV` settings and `BUILD_TARGET` configurations.
+- Automatically adds a `APP_ROOT` which points to the absolute root folder.
 - Serializes all `APP_` prefixed environment variables for usage as `raw`, `stringified` or `webpack` (for `DefinePlugin`)
 - Supports variable expansion between different settings.
 - Allows local overrides using files which use a ".local" postfix.
 
 
 ## All Strings
 
-It's always a good concept to keep in mind that environment variables
-are always strings. Even if you define `true` or numbers like `100` they are
-still send over as strings. See also: https://github.com/motdotla/dotenv/issues/51
+It is important to remember that all environment variables are always stored as strings. Even numbers and booleans. The casting to other types must therefore take place in the application code. See also: https://github.com/motdotla/dotenv/issues/51
 
 
 ## Variables

src/__snapshots__/build.test.js.snap

@@ -1,7 +1,8 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Also serializes BUILD_TARGET 1`] = `
+exports[`Serializes BUILD_TARGET 1`] = `
 Object {
+  "APP_ROOT": Any<String>,
   "APP_TEST_IS_CLIENT": "true",
   "APP_TEST_OVERRIDE": "overridden",
   "APP_TEST_PATH": "one/two/three.js",
@@ -10,24 +11,13 @@ Object {
 }
 `;
 
-exports[`Also serializes BUILD_TARGET 2`] = `
+exports[`Serializes BUILD_TARGET 2`] = `
 Object {
+  "APP_ROOT": Any<String>,
   "APP_TEST_IS_CLIENT": "\\"true\\"",
   "APP_TEST_OVERRIDE": "\\"overridden\\"",
   "APP_TEST_PATH": "\\"one/two/three.js\\"",
   "BUILD_TARGET": "\\"client\\"",
   "NODE_ENV": "\\"test\\"",
 }
 `;
-
-exports[`Also serializes BUILD_TARGET 3`] = `
-Object {
-  "process.env": Object {
-    "APP_TEST_IS_CLIENT": "\\"true\\"",
-    "APP_TEST_OVERRIDE": "\\"overridden\\"",
-    "APP_TEST_PATH": "\\"one/two/three.js\\"",
-    "BUILD_TARGET": "\\"client\\"",
-    "NODE_ENV": "\\"test\\"",
-  },
-}
-`;

src/__snapshots__/index.test.js.snap

@@ -2,6 +2,7 @@
 
 exports[`Ignores non app-specific settings 1`] = `
 Object {
+  "APP_ROOT": Any<String>,
   "APP_TEST_OVERRIDE": "overridden",
   "APP_TEST_PATH": "one/two/three.js",
   "NODE_ENV": "test",
@@ -10,25 +11,17 @@ Object {
 
 exports[`Ignores non app-specific settings 2`] = `
 Object {
+  "APP_ROOT": Any<String>,
   "APP_TEST_OVERRIDE": "\\"overridden\\"",
   "APP_TEST_PATH": "\\"one/two/three.js\\"",
   "NODE_ENV": "\\"test\\"",
 }
 `;
 
-exports[`Ignores non app-specific settings 3`] = `
-Object {
-  "process.env": Object {
-    "APP_TEST_OVERRIDE": "\\"overridden\\"",
-    "APP_TEST_PATH": "\\"one/two/three.js\\"",
-    "NODE_ENV": "\\"test\\"",
-  },
-}
-`;
-
 exports[`Supports manually defined envs 1`] = `
 Object {
   "APP_DATA": "yellow",
+  "APP_ROOT": Any<String>,
   "APP_TEST_OVERRIDE": "overridden",
   "APP_TEST_PATH": "one/two/three.js",
   "NODE_ENV": "test",
@@ -38,19 +31,9 @@ Object {
 exports[`Supports manually defined envs 2`] = `
 Object {
   "APP_DATA": "\\"yellow\\"",
+  "APP_ROOT": Any<String>,
   "APP_TEST_OVERRIDE": "\\"overridden\\"",
   "APP_TEST_PATH": "\\"one/two/three.js\\"",
   "NODE_ENV": "\\"test\\"",
 }
 `;
-
-exports[`Supports manually defined envs 3`] = `
-Object {
-  "process.env": Object {
-    "APP_DATA": "\\"yellow\\"",
-    "APP_TEST_OVERRIDE": "\\"overridden\\"",
-    "APP_TEST_PATH": "\\"one/two/three.js\\"",
-    "NODE_ENV": "\\"test\\"",
-  },
-}
-`;

src/build.test.js

@@ -1,12 +1,21 @@
 process.env.BUILD_TARGET = "client"
 
+const snapshotOpts = {
+  APP_ROOT: expect.any(String)
+}
+
 /* eslint-disable import/no-commonjs */
 // We can't use ESM when relying on the fact the the env from the top is correctly respected.
 const api = require(".")
 
-test("Also serializes BUILD_TARGET", () => {
+test("Serializes BUILD_TARGET", () => {
   const { raw, stringified, webpack } = api.getEnvironment()
-  expect(raw).toMatchSnapshot()
-  expect(stringified).toMatchSnapshot()
-  expect(webpack).toMatchSnapshot()
+  expect(raw).toMatchSnapshot(snapshotOpts)
+  expect(stringified).toMatchSnapshot(snapshotOpts)
+  expect(webpack).toBeDefined()
+})
+
+test("Exports BUILD_TARGET", () => {
+  const { raw } = api.getEnvironment()
+  expect(raw.BUILD_TARGET).toBe("client")
 })

src/index.js

@@ -63,6 +63,9 @@ export function getEnvironment() {
     raw.BUILD_TARGET = BUILD_TARGET
   }
 
+  // Add hint about root folder
+  raw.APP_ROOT = appRoot.get()
+
   // Stringify all values so we can feed into Webpack DefinePlugin
   const stringified = {}
   const webpack = { "process.env": stringified }

src/index.test.js

@@ -1,22 +1,36 @@
 import { getEnvironment } from "."
 
+const snapshotOpts = {
+  APP_ROOT: expect.any(String)
+}
+
 test("Sets up process.env", () => {
   expect(process.env.APP_TEST_PATH).toBe("one/two/three.js")
   expect(process.env.TEST_IGNORE).toBe("123")
 })
 
 test("Ignores non app-specific settings", () => {
   const { raw, stringified, webpack } = getEnvironment()
-  expect(raw).toMatchSnapshot()
-  expect(stringified).toMatchSnapshot()
-  expect(webpack).toMatchSnapshot()
+  expect(raw).toMatchSnapshot(snapshotOpts)
+  expect(stringified).toMatchSnapshot(snapshotOpts)
+  expect(webpack).toBeDefined()
 })
 
 test("Supports manually defined envs", () => {
   process.env.APP_DATA = "yellow"
   const { raw, stringified, webpack } = getEnvironment()
-  expect(raw).toMatchSnapshot()
-  expect(stringified).toMatchSnapshot()
-  expect(webpack).toMatchSnapshot()
+  expect(raw).toMatchSnapshot(snapshotOpts)
+  expect(stringified).toMatchSnapshot(snapshotOpts)
+  expect(webpack).toBeDefined()
   delete process.env.APP_DATA
 })
+
+test("Exports NODE_ENV", () => {
+  const { raw } = getEnvironment()
+  expect(raw.NODE_ENV).toBe("test")
+})
+
+test("Exports APP_ROOT", () => {
+  const { raw } = getEnvironment()
+  expect(raw.APP_ROOT).toMatch(/universal-dotenv$/)
+})