skuba-dive 1.1.0 → 2.0.0

package/README.md

@@ -1,7 +1,7 @@
 # 🤿🌊
 
-![GitHub Release](https://github.com/seek-oss/skuba-dive/workflows/Release/badge.svg?branch=master)
-![GitHub Validate](https://github.com/seek-oss/skuba-dive/workflows/Validate/badge.svg?branch=master)
+[![GitHub Release](https://github.com/seek-oss/skuba-dive/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/skuba-dive/actions?query=workflow%3ARelease)
+[![GitHub Validate](https://github.com/seek-oss/skuba-dive/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/skuba-dive/actions?query=workflow%3AValidate)
 [![Node.js version](https://img.shields.io/badge/node-%3E%3D%2012-brightgreen)](https://nodejs.org/en/)
 [![npm package](https://img.shields.io/npm/v/skuba-dive)](https://www.npmjs.com/package/skuba-dive)
 [![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
@@ -15,7 +15,7 @@ Minimal runtime for [`skuba`](https://github.com/seek-oss/skuba).
   - [Env](#env)
   - [Register](#register)
 - [Design](#design)
-- [Development](#development)
+- [Contributing](https://github.com/seek-oss/skuba-dive/blob/master/CONTRIBUTING.md)
 
 ## API reference
 
@@ -58,21 +58,32 @@ export const environment = Env.oneOf(ENVIRONMENTS)('ENVIRONMENT');
 
 export const port = Env.nonNegativeInteger('PORT', { default: undefined });
 // number | undefined
+
+export const version = Env.string('VERSION', { default: 'local' });
+// string | 'local'
+
+export const flag = Env.boolean('FLAG');
+// boolean
 ```
 
 Each function will throw if its environment variable is not set and `opts.default` is not provided.
 
 ### Register
 
-Runtime hook for:
-
-- Import paths relative to `/src`
-- Stack traces that map back to your `.ts` sources
+Runtime hook for import paths relative to `/src`.
 
-Make a side-effectful import at the top of your entry point, e.g. `/src/app.ts`:
+Make a side-effectful import at the top of your entry point(s):
 
 ```typescript
+// /src/register.ts
+
 import 'skuba-dive/register';
+```
+
+```typescript
+// /src/app.ts
+
+import './register';
 
 import { config } from 'src/config';
 
@@ -92,36 +103,3 @@ See `skuba`'s [goals] and [non-goals] for more information.
 
 [goals]: https://github.com/seek-oss/skuba#goals
 [non-goals]: https://github.com/seek-oss/skuba#non-goals
-
-## Development
-
-### Prerequisites
-
-- Node.js 12+
-- Yarn 1.x
-
-```shell
-yarn install
-```
-
-### Lint
-
-```shell
-# fix
-yarn format
-
-# check
-yarn lint
-```
-
-### Test
-
-```shell
-yarn test
-```
-
-### Build
-
-```shell
-yarn build
-```

package/lib/env/create.d.ts

@@ -2,6 +2,6 @@
  * Create a function that reads an environment variable and runs it through the
  * provided parsing function.
  */
-export declare const create: <T>(parse: (value: string) => T) => <U = T>(name: string, opts?: Readonly<{
+export declare const create: <T>(parse: (value: string, name: string) => T) => <U = T>(name: string, opts?: Readonly<{
     default: U;
 }> | undefined) => T | U;

package/lib/env/create.js

@@ -5,14 +5,15 @@ exports.create = void 0;
  * Create a function that reads an environment variable and runs it through the
  * provided parsing function.
  */
-exports.create = (parse) => (name, opts) => {
+const create = (parse) => (name, opts) => {
     const value = process.env[name];
     if (typeof value !== 'undefined') {
-        return parse(value);
+        return parse(value, name);
     }
     if (typeof opts !== 'undefined') {
         return opts.default;
     }
-    throw Error(`process.env.${name} not set`);
+    throw Error(`process.env.${name} is not set`);
 };
+exports.create = create;
 //# sourceMappingURL=create.js.map

package/lib/env/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/env/create.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,MAAM,GAAG,CAAI,KAA2B,EAAE,EAAE,CAAC,CACxD,IAAY,EACZ,IAA+B,EACxB,EAAE;IACT,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEhC,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;QAChC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;KACrB;IAED,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;IAED,MAAM,KAAK,CAAC,eAAe,IAAI,UAAU,CAAC,CAAC;AAC7C,CAAC,CAAC"}
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/env/create.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,MAAM,GACjB,CAAI,KAAyC,EAAE,EAAE,CACjD,CAAQ,IAAY,EAAE,IAA+B,EAAS,EAAE;IAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEhC,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;QAChC,OAAO,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;KAC3B;IAED,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;IAED,MAAM,KAAK,CAAC,eAAe,IAAI,aAAa,CAAC,CAAC;AAChD,CAAC,CAAC;AAdS,QAAA,MAAM,UAcf"}

package/lib/env/index.js

@@ -7,7 +7,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create"), exports);

package/lib/env/parsers.d.ts

@@ -1,3 +1,4 @@
-export declare const nonNegativeInteger: (input: string) => number;
-export declare const noop: <T>(input: T) => T;
-export declare const oneOf: <T>(choices: readonly T[]) => (input: unknown) => T;
+export declare const nonNegativeInteger: (input: string, name: string) => number;
+export declare const noop: <T>(input: T, _name: string) => T;
+export declare const oneOf: <T>(choices: readonly T[]) => (input: unknown, name: string) => T;
+export declare const boolean: (input: string) => boolean;

package/lib/env/parsers.js

@@ -1,21 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.oneOf = exports.noop = exports.nonNegativeInteger = void 0;
-exports.nonNegativeInteger = (input) => {
+exports.boolean = exports.oneOf = exports.noop = exports.nonNegativeInteger = void 0;
+const nonNegativeInteger = (input, name) => {
     const int = parseInt(input, 10);
     if (int < 0 || !Number.isSafeInteger(int) || input !== String(int)) {
-        throw Error(`not a non-negative integer: '${input}'`);
+        throw Error(`process.env.${name} is not a non-negative integer: '${input}'`);
     }
     return int;
 };
-exports.noop = (input) => input;
-exports.oneOf = (choices) => {
+exports.nonNegativeInteger = nonNegativeInteger;
+const noop = (input, _name) => input;
+exports.noop = noop;
+const oneOf = (choices) => {
     const isChoice = (value) => new Set(choices).has(value);
-    return (input) => {
+    return (input, name) => {
         if (!isChoice(input)) {
-            throw Error(`not a supported choice: '${String(input)}'`);
+            throw Error(`process.env.${name} is not a supported choice: '${String(input)}'. Expected one of: [${choices
+                .map((choice) => `'${String(choice)}'`)
+                .join(', ')}]`);
         }
         return input;
     };
 };
+exports.oneOf = oneOf;
+const falseys = ['false', 'off', 'no', 'n', '0'];
+const boolean = (input) => falseys.includes(input.toLowerCase()) ? false : Boolean(input);
+exports.boolean = boolean;
 //# sourceMappingURL=parsers.js.map

package/lib/env/parsers.js.map

@@ -1 +1 @@
-{"version":3,"file":"parsers.js","sourceRoot":"","sources":["../../src/env/parsers.ts"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG,CAAC,KAAa,EAAU,EAAE;IAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAEhC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE;QAClE,MAAM,KAAK,CAAC,gCAAgC,KAAK,GAAG,CAAC,CAAC;KACvD;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEW,QAAA,IAAI,GAAG,CAAI,KAAQ,EAAK,EAAE,CAAC,KAAK,CAAC;AAEjC,QAAA,KAAK,GAAG,CAAI,OAAqB,EAAE,EAAE;IAChD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmC,EAAE,CACnE,IAAI,GAAG,CAAU,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAEvC,OAAO,CAAC,KAAc,EAA0B,EAAE;QAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,KAAK,CAAC,4BAA4B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAC3D;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"parsers.js","sourceRoot":"","sources":["../../src/env/parsers.ts"],"names":[],"mappings":";;;AAAO,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,IAAY,EAAU,EAAE;IACxE,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAEhC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE;QAClE,MAAM,KAAK,CACT,eAAe,IAAI,oCAAoC,KAAK,GAAG,CAChE,CAAC;KACH;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B;AAEK,MAAM,IAAI,GAAG,CAAI,KAAQ,EAAE,KAAa,EAAK,EAAE,CAAC,KAAK,CAAC;AAAhD,QAAA,IAAI,QAA4C;AAEtD,MAAM,KAAK,GAAG,CAAI,OAAqB,EAAE,EAAE;IAChD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmC,EAAE,CACnE,IAAI,GAAG,CAAU,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAEvC,OAAO,CAAC,KAAc,EAAE,IAAY,EAA0B,EAAE;QAC9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,KAAK,CACT,eAAe,IAAI,gCAAgC,MAAM,CACvD,KAAK,CACN,wBAAwB,OAAO;iBAC7B,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC;iBACtC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjB,CAAC;SACH;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,KAAK,SAiBhB;AAEF,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAE1C,MAAM,OAAO,GAAG,CAAC,KAAa,EAAW,EAAE,CAChD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AADpD,QAAA,OAAO,WAC6C"}

package/lib/env/presets.d.ts

@@ -19,3 +19,9 @@ export declare const oneOf: <T>(choices: readonly T[]) => <U = T>(name: string,
 export declare const string: <U = string>(name: string, opts?: Readonly<{
     default: U;
 }> | undefined) => string | U;
+/**
+ * Read an environment variable as a boolean.
+ */
+export declare const boolean: <U = boolean>(name: string, opts?: Readonly<{
+    default: U;
+}> | undefined) => boolean | U;

package/lib/env/presets.js

@@ -14,12 +14,12 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.string = exports.oneOf = exports.nonNegativeInteger = void 0;
+exports.boolean = exports.string = exports.oneOf = exports.nonNegativeInteger = void 0;
 const create_1 = require("./create");
 const parsers = __importStar(require("./parsers"));
 /**
@@ -27,14 +27,19 @@ const parsers = __importStar(require("./parsers"));
  *
  * This includes (positive) zero.
  */
-exports.nonNegativeInteger = create_1.create(parsers.nonNegativeInteger);
+exports.nonNegativeInteger = (0, create_1.create)(parsers.nonNegativeInteger);
 /**
  * Create a function that reads an environment variable and validates it against
  * the provided array of choices.
  */
-exports.oneOf = (choices) => create_1.create(parsers.oneOf(choices));
+const oneOf = (choices) => (0, create_1.create)(parsers.oneOf(choices));
+exports.oneOf = oneOf;
 /**
  * Read an environment variable as a string.
  */
-exports.string = create_1.create(parsers.noop);
+exports.string = (0, create_1.create)(parsers.noop);
+/**
+ * Read an environment variable as a boolean.
+ */
+exports.boolean = (0, create_1.create)(parsers.boolean);
 //# sourceMappingURL=presets.js.map

package/lib/env/presets.js.map

@@ -1 +1 @@
-{"version":3,"file":"presets.js","sourceRoot":"","sources":["../../src/env/presets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkC;AAClC,mDAAqC;AAErC;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,eAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAErE;;;GAGG;AACU,QAAA,KAAK,GAAG,CAAI,OAAqB,EAAE,EAAE,CAChD,eAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAEjC;;GAEG;AACU,QAAA,MAAM,GAAG,eAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"presets.js","sourceRoot":"","sources":["../../src/env/presets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkC;AAClC,mDAAqC;AAErC;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,IAAA,eAAM,EAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAErE;;;GAGG;AACI,MAAM,KAAK,GAAG,CAAI,OAAqB,EAAE,EAAE,CAChD,IAAA,eAAM,EAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AADpB,QAAA,KAAK,SACe;AAEjC;;GAEG;AACU,QAAA,MAAM,GAAG,IAAA,eAAM,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE3C;;GAEG;AACU,QAAA,OAAO,GAAG,IAAA,eAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC"}

package/lib/index.js

@@ -14,11 +14,12 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = exports.Assert = void 0;
 exports.Assert = __importStar(require("./assert"));
 exports.Env = __importStar(require("./env"));
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,6CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,6CAA6B"}

package/package.json

@@ -1,35 +1,48 @@
 {
-  "name": "skuba-dive",
+  "bugs": {
+    "url": "https://github.com/seek-oss/skuba-dive/issues"
+  },
+  "dependencies": {
+    "module-alias": "^2.2.2"
+  },
   "description": "Minimal runtime for skuba",
-  "version": "1.1.0",
-  "main": "lib",
-  "typings": "lib/index.d.ts",
+  "devDependencies": {
+    "@types/module-alias": "2.0.1",
+    "skuba": "3.17.2"
+  },
+  "engines": {
+    "node": ">=14.18"
+  },
   "files": [
     "lib/**/*.d.ts",
     "lib/**/*.js",
     "lib/**/*.js.map",
     "register.js"
   ],
-  "sideEffects": true,
+  "homepage": "https://github.com/seek-oss/skuba-dive#readme",
   "license": "MIT",
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "name": "skuba-dive",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/seek-oss/skuba-dive.git"
+  },
   "scripts": {
     "build": "skuba build",
     "format": "skuba format",
     "lint": "skuba lint",
-    "release": "yarn build && semantic-release --success false",
+    "release": "yarn build && skuba release",
     "test": "skuba test --coverage"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/seek-oss/skuba-dive.git"
-  },
-  "dependencies": {
-    "module-alias": "^2.2.2",
-    "source-map-support": "^0.5.16"
+  "sideEffects": true,
+  "skuba": {
+    "entryPoint": "src/index.ts",
+    "template": "oss-npm-package",
+    "type": "package",
+    "version": "3.7.3"
   },
-  "devDependencies": {
-    "@types/module-alias": "2.0.0",
-    "semantic-release": "17.0.8",
-    "skuba": "3.5.1"
-  }
+  "types": "./lib/index.d.ts",
+  "version": "2.0.0"
 }

package/register.js

@@ -1,11 +1,12 @@
-// istanbul ignore if
 /**
- * @see {@link https://github.com/kulshekhar/ts-jest/issues/727#issuecomment-422743605}
+ * @see {@link https://nodejs.org/api/deprecations.html#DEP0144}
  */
-if (typeof jest === 'undefined') {
-  require('source-map-support/register');
-}
+const [firstModuleParent] = Object.values(require.cache).filter((m) =>
+  m.children.includes(module),
+);
 
-const { addAlias } = require('module-alias');
+if (typeof firstModuleParent !== 'undefined') {
+  const { addAlias } = require('module-alias');
 
-addAlias('src', module.parent.path);
+  addAlias('src', firstModuleParent.path);
+}