@smg-automotive/configuration 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 CAR FOR YOU
+
+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.

package/README.md

@@ -0,0 +1,64 @@
+# SMG Automotive Configuration
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+It loads configuration for a specific stage via `dotenv` from `.env/<CONFIG_ENV>`. If no environment is provided it defaults to `NODE_ENV`.
+
+You can add local overrides in `.env/<CONFIG_ENV>.local`. This is useful for temporary or local changes.
+
+## Usage
+```
+npm install @smg-automotive/configuration
+```
+
+Add the following line to your `.gitignore`
+```
+/.env/*.local
+```
+
+The configuration environment can be passed via `CONFIG_ENV` environment variable:
+
+```
+$ CONFIG_ENV=stage-prod npm run dev
+```
+
+In a nextjs project, you can call `loadConfiguration()` in `next.config.js` and pass the result to next as `env`, see https://nextjs.org/docs/api-reference/next.config.js/environment-variables - configuration values will be available on `process.env` both client- and server-side
+
+```
+const configuration = require("@smg-automotive/configuration")
+module.exports = {
+  env: configuration
+}
+```
+
+In any node process, simply require the package in your entry point and access variables on `process.env`. Do this as early in the file as possible, ie. before requiring any files that are accessing config variables
+
+```
+require("@smg-automotive/configuration")
+```
+
+## Development
+```
+npm run build
+```
+
+You can link your local npm package to integrate it with any local project:
+```
+cd configuration-pkg
+npm run build
+
+cd project
+npm link ../configuration-pkg/dist
+```
+
+## Release a new version
+
+New versions are released on the ci using semantic-release as soon as you merge into master. Please
+make sure your merge commit message adheres to the corresponding conventions.
+
+
+## Circle CI
+
+You will need to enable the repository in circle CI ui to be able to build it.
+
+For slack notifications to work you will need to provide the token in circle settings.

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@smg-automotive/configuration",
+  "version": "1.0.0",
+  "description": "SMG Automotive configuration conventions",
+  "scripts": {
+    "version": "npm run build",
+    "build": "rimraf pkg && tsc --outDir pkg",
+    "lint": "eslint --ext js,json .",
+    "format": "npm run lint -- --fix",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "test:debug": "node --inspect-brk --inspect=127.0.0.1:9229 ./node_modules/jest/bin/jest.js --runInBand"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/smg-automotive/configuration-pkg.git"
+  },
+  "author": "CAR FOR YOU",
+  "license": "MIT",
+  "homepage": "https://github.com/smg-automotive/configuration-pkg#readme",
+  "devDependencies": {
+    "@carforyou/eslint-config": "4.0.23",
+    "@types/jest": "27.5.2",
+    "jest": "27.5.1",
+    "rimraf": "3.0.2",
+    "semantic-release": "19.0.3",
+    "ts-jest": "27.1.5"
+  },
+  "dependencies": {
+    "dotenv": "16.0.1",
+    "es-abstract": "1.20.1",
+    "typescript": "4.5.5"
+  },
+  "main": "pkg/index.js",
+  "files": [
+    "pkg/**/*"
+  ],
+  "bugs": {
+    "url": "https://github.com/smg-automotive/configuration-pkg/issues"
+  }
+}

package/pkg/__tests__/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/pkg/__tests__/index.test.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @jest-environment node
+ */
+/* eslint-disable @typescript-eslint/no-var-requires */
+var loadConfiguration_1 = __importDefault(require("../loadConfiguration"));
+beforeEach(function () {
+    process.env.CONFIG_ENV = null;
+    process.env.NODE_ENV = null;
+});
+it("throws error when CONFIG_ENV is undefined", function () {
+    expect(function () {
+        (0, loadConfiguration_1.default)();
+    }).toThrow("Invalid environment");
+});
+it("throws error when CONFIG_ENV has no respective config", function () {
+    process.env.CONFIG_ENV = "invalid";
+    expect(function () {
+        (0, loadConfiguration_1.default)();
+    }).toThrow("Invalid environment");
+});
+it("returns configuration", function () {
+    process.env.CONFIG_ENV = "test";
+    var configuration = (0, loadConfiguration_1.default)();
+    expect(configuration.VIDEO_URL).toEqual("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
+});
+it("allows local overrides", function () {
+    process.env.CONFIG_ENV = "overrides";
+    var configuration = (0, loadConfiguration_1.default)();
+    expect(configuration.VIDEO_URL).toEqual("https://www.youtube.com/watch?v=XSqi5s3rfqk");
+});
+//# sourceMappingURL=index.test.js.map

package/pkg/__tests__/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":";;;;;AAAA;;GAEG;AACH,uDAAuD;AACvD,2EAAoD;AAEpD,UAAU,CAAC;IACT,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAA;IAC7B,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAA;AAC7B,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,2CAA2C,EAAE;IAC9C,MAAM,CAAC;QACL,IAAA,2BAAiB,GAAE,CAAA;IACrB,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,uDAAuD,EAAE;IAC1D,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,SAAS,CAAA;IAClC,MAAM,CAAC;QACL,IAAA,2BAAiB,GAAE,CAAA;IACrB,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,uBAAuB,EAAE;IAC1B,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,MAAM,CAAA;IAC/B,IAAM,aAAa,GAAG,IAAA,2BAAiB,GAAE,CAAA;IACzC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,6CAA6C,CAC9C,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,wBAAwB,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,WAAW,CAAA;IACpC,IAAM,aAAa,GAAG,IAAA,2BAAiB,GAAE,CAAA;IACzC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,6CAA6C,CAC9C,CAAA;AACH,CAAC,CAAC,CAAA"}

package/pkg/index.d.ts

@@ -0,0 +1 @@
+export {};

package/pkg/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var loadConfiguration_1 = __importDefault(require("./loadConfiguration"));
+var configuration = (0, loadConfiguration_1.default)();
+module.exports = configuration;
+//# sourceMappingURL=index.js.map

package/pkg/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,0EAAmD;AACnD,IAAM,aAAa,GAAG,IAAA,2BAAiB,GAAE,CAAA;AAEzC,MAAM,CAAC,OAAO,GAAG,aAAa,CAAA"}

package/pkg/loadConfiguration.d.ts

@@ -0,0 +1,5 @@
+interface Configuration {
+    [key: string]: string | number | boolean;
+}
+declare const loadConfiguration: () => Configuration;
+export default loadConfiguration;

package/pkg/loadConfiguration.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/naming-convention */
+var path_1 = __importDefault(require("path"));
+var fs_1 = __importDefault(require("fs"));
+var dotenv_1 = __importDefault(require("dotenv"));
+if (typeof window !== "undefined") {
+    throw new Error("It looks like you're loading the configuration in the browser. Use process.env.VARIABLE instead");
+}
+var loadEnvFile = function (configPath) {
+    var configuration = dotenv_1.default.config({ path: configPath });
+    // eslint-disable-next-line no-console
+    console.info("> Loading configuration from ".concat(configPath));
+    if (configuration.error) {
+        throw configuration.error;
+    }
+    return configuration.parsed;
+};
+var loadConfiguration = function () {
+    var envDir = path_1.default.join(process.cwd(), ".env");
+    var environments = fs_1.default.readdirSync(envDir);
+    var nodeEnv = process.env.NODE_ENV || "development";
+    var env = process.env.CONFIG_ENV || nodeEnv;
+    var localEnv = "".concat(env, ".local");
+    var version = process.env.VERSION;
+    process.env.CONFIG_ENV = env;
+    if (!environments.includes(env)) {
+        throw new Error("Invalid environment: ".concat(env));
+    }
+    var configPath = path_1.default.resolve(envDir, env);
+    var configuration = __assign({ CONFIG_ENV: env, VERSION: version }, loadEnvFile(configPath));
+    if (environments.includes(localEnv)) {
+        var localConfiguration = loadEnvFile(path_1.default.resolve(envDir, localEnv));
+        return __assign(__assign({}, configuration), localConfiguration);
+    }
+    return configuration;
+};
+exports.default = loadConfiguration;
+//# sourceMappingURL=loadConfiguration.js.map

package/pkg/loadConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadConfiguration.js","sourceRoot":"","sources":["../src/loadConfiguration.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAyD;AACzD,8CAAuB;AACvB,0CAAmB;AACnB,kDAA2B;AAM3B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAA;CACF;AAED,IAAM,WAAW,GAAG,UAAC,UAAkB;IACrC,IAAM,aAAa,GAAG,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAEzD,sCAAsC;IACtC,OAAO,CAAC,IAAI,CAAC,uCAAgC,UAAU,CAAE,CAAC,CAAA;IAE1D,IAAI,aAAa,CAAC,KAAK,EAAE;QACvB,MAAM,aAAa,CAAC,KAAK,CAAA;KAC1B;IAED,OAAO,aAAa,CAAC,MAAM,CAAA;AAC7B,CAAC,CAAA;AAED,IAAM,iBAAiB,GAAG;IACxB,IAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAA;IAC/C,IAAM,YAAY,GAAG,YAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAE3C,IAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAA;IAErD,IAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,OAAO,CAAA;IAC7C,IAAM,QAAQ,GAAG,UAAG,GAAG,WAAQ,CAAA;IAC/B,IAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAA;IAEnC,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,GAAG,CAAA;IAE5B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,+BAAwB,GAAG,CAAE,CAAC,CAAA;KAC/C;IAED,IAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5C,IAAM,aAAa,cACjB,UAAU,EAAE,GAAG,EACf,OAAO,EAAE,OAAO,IACb,WAAW,CAAC,UAAU,CAAC,CAC3B,CAAA;IAED,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACnC,IAAM,kBAAkB,GAAG,WAAW,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAA;QACtE,6BAAY,aAAa,GAAK,kBAAkB,EAAE;KACnD;IAED,OAAO,aAAa,CAAA;AACtB,CAAC,CAAA;AAED,kBAAe,iBAAiB,CAAA"}