cafe-utility 10.11.0 → 10.13.0

package/index.d.ts

@@ -325,9 +325,11 @@ declare function tickPlaybook<T>(playbook: Playbook<T>): {
     progress: number;
     data: T;
 } | null;
-declare function getArgument(args: string[], key: string): string | null;
-declare function requireStringArgument(args: string[], key: string): string;
-declare function requireNumberArgument(args: string[], key: string): number;
+declare function getArgument(args: string[], key: string, env?: Record<string, string>, envKey?: string): string | null;
+declare function getNumberArgument(args: string[], key: string, env?: Record<string, string>, envKey?: string): number | null;
+declare function getBooleanArgument(args: string[], key: string, env?: Record<string, string>, envKey?: string): boolean | null;
+declare function requireStringArgument(args: string[], key: string, env?: Record<string, string>, envKey?: string): string;
+declare function requireNumberArgument(args: string[], key: string, env?: Record<string, string>, envKey?: string): number;
 declare function bringToFrontInPlace<T>(array: T[], index: number): void;
 declare function bringToFront<T>(array: T[], index: number): T[];
 declare type Point = {
@@ -394,6 +396,8 @@ export declare const Arrays: {
     organiseWithLimits: typeof organiseWithLimits;
     tickPlaybook: typeof tickPlaybook;
     getArgument: typeof getArgument;
+    getBooleanArgument: typeof getBooleanArgument;
+    getNumberArgument: typeof getNumberArgument;
     requireStringArgument: typeof requireStringArgument;
     requireNumberArgument: typeof requireNumberArgument;
     bringToFront: typeof bringToFront;

package/index.js

@@ -1461,7 +1461,7 @@ const dateUnits = [
 function makeDate(numberWithUnit) {
     const number = parseFloat(numberWithUnit)
     if (isNaN(number)) {
-        throw 'makeDate got NaN for input'
+        throw Error('makeDate got NaN for input')
     }
     const unit = numberWithUnit.replace(/^-?[0-9.]+/, '').trim()
     const index = dateUnits.findIndex(value => value[0] === unit.toLowerCase())
@@ -1748,7 +1748,7 @@ function formatNumber(number, options) {
 function makeNumber(numberWithUnit) {
     const number = parseFloat(numberWithUnit)
     if (isNaN(number)) {
-        throw 'makeNumber got NaN for input'
+        throw Error('makeNumber got NaN for input')
     }
     const unit = numberWithUnit.replace(/^-?[0-9.]+/, '').trim()
     const index = shortNumberUnits.findIndex(value => value.toLowerCase() === unit.toLowerCase())
@@ -2207,11 +2207,11 @@ function tickPlaybook(playbook) {
     }
 }
 
-function getArgument(args, key) {
+function getArgument(args, key, env, envKey) {
     const index = args.findIndex(arg => arg.endsWith('-' + key) || arg.includes('-' + key + '='))
     const arg = args[index]
     if (!arg) {
-        return null
+        return (env || {})[envKey || key || ''] || null
     }
     if (arg.includes('=')) {
         return arg.split('=')[1]
@@ -2220,19 +2220,51 @@ function getArgument(args, key) {
     if (next && !next.startsWith('-')) {
         return next
     }
-    return null
+    return (env || {})[envKey || key || ''] || null
+}
+
+function getNumberArgument(args, key, env, envKey) {
+    const value = getArgument(args, key, env, envKey)
+    if (!value) {
+        return null
+    }
+    try {
+        return makeNumber(value)
+    } catch (_a) {
+        throw new Error(`Invalid number argument ${key}: ${value}`)
+    }
+}
+
+function getBooleanArgument(args, key, env, envKey) {
+    const isPresent = args.some(arg => arg.endsWith('-' + key))
+    const value = getArgument(args, key, env, envKey)
+    if (!value && isPresent) {
+        return true
+    }
+    if (!value && !isPresent) {
+        return null
+    }
+    const truthy = ['true', '1', 'yes', 'y', 'on']
+    const falsy = ['false', '0', 'no', 'n', 'off']
+    if (truthy.includes(value.toLowerCase())) {
+        return true
+    }
+    if (falsy.includes(value.toLowerCase())) {
+        return false
+    }
+    throw Error(`Invalid boolean argument ${key}: ${value}`)
 }
 
-function requireStringArgument(args, key) {
-    const value = getArgument(args, key)
+function requireStringArgument(args, key, env, envKey) {
+    const value = getArgument(args, key, env, envKey)
     if (!value) {
         throw new Error(`Missing argument ${key}`)
     }
     return value
 }
 
-function requireNumberArgument(args, key) {
-    const value = requireStringArgument(args, key)
+function requireNumberArgument(args, key, env, envKey) {
+    const value = requireStringArgument(args, key, env, envKey)
     try {
         return makeNumber(value)
     } catch (_a) {
@@ -2581,6 +2613,8 @@ exports.Arrays = {
     organiseWithLimits,
     tickPlaybook,
     getArgument,
+    getBooleanArgument,
+    getNumberArgument,
     requireStringArgument,
     requireNumberArgument,
     bringToFront,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cafe-utility",
-    "version": "10.11.0",
+    "version": "10.13.0",
     "description": "",
     "main": "index.js",
     "exports": {