toilscript 0.0.1 → 0.1.0

package/util/options.js

@@ -1,262 +1,262 @@
-/**
- * @fileoverview Command line options utility.
- * @license Apache-2.0
- */
-
-import { path, module } from "./node.js";
-import { stdoutColors } from "./terminal.js";
-
-const require = module.createRequire(import.meta.url);
-
-// type | meaning
-// -----|---------------
-// b    | boolean
-// i    | integer
-// f    | float
-// s    | string
-// I    | integer array
-// F    | float array
-// S    | string array
-
-/** Parses the specified command line arguments according to the given configuration. */
-export function parse(argv, config, propagateDefaults = true) {
-  var options = {};
-  var unknown = [];
-  var args = [];
-  var trailing = [];
-
-  // make an alias map and initialize defaults
-  var aliases = {};
-  Object.keys(config).forEach(key => {
-    if (key.startsWith(" ")) return;
-    var option = config[key];
-    if (option.alias != null) {
-      if (typeof option.alias === "string") aliases[option.alias] = key;
-      else if (Array.isArray(option.alias)) option.alias.forEach(alias => aliases[alias] = key);
-    }
-    if (propagateDefaults && option.default != null) options[key] = option.default;
-  });
-
-  // iterate over argv
-  for (var i = 0, k = (argv = argv.slice()).length; i < k; ++i) {
-    let arg = argv[i];
-    if (arg == "--") { ++i; break; }
-    let match = /^(?:(-\w)(?:=(.*))?|(--\w{2,})(?:=(.*))?)$/.exec(arg), option, key;
-    if (match) {
-      if (config[arg]) option = config[key = arg]; // exact
-      else if (match[1] != null) { // alias
-        option = config[key = aliases[match[1].substring(1)]];
-        if (option && match[2] != null) argv[i--] = match[2];
-      } else if (match[3] != null) { // full
-        option = config[key = match[3].substring(2)];
-        if (option && match[4] != null) argv[i--] = match[4];
-      }
-    } else {
-      if (arg.charCodeAt(0) == 45) option = config[key = arg]; // exact
-      else { args.push(arg); continue; } // argument
-    }
-    if (option) {
-      if (option.value) {
-        // alias setting fixed values
-        Object.keys(option.value).forEach(k => options[k] = option.value[k]);
-      } else if (option.type == null || option.type === "b") {
-        // boolean flag not taking a value
-        options[key] = true;
-      } else {
-        if (i + 1 < argv.length && argv[i + 1].charCodeAt(0) != 45) {
-          // non-boolean with given value
-          switch (option.type) {
-            case "i": options[key] = parseInt(argv[++i], 10); break;
-            case "I": options[key] = (options[key] || []).concat(parseInt(argv[++i], 10)); break;
-            case "f": options[key] = parseFloat(argv[++i]); break;
-            case "F": options[key] = (options[key] || []).concat(parseFloat(argv[++i])); break;
-            case "s": options[key] = String(argv[++i]); break;
-            case "S": options[key] = (options[key] || []).concat(argv[++i].split(",")); break;
-            default: unknown.push(arg); --i;
-          }
-        } else {
-          // non-boolean with omitted value
-          switch (option.type) {
-            case "i":
-            case "f": options[key] = option.default || 0; break;
-            case "s": options[key] = option.default || ""; break;
-            case "I":
-            case "F":
-            case "S": options[key] = option.default || []; break;
-            default: unknown.push(arg);
-          }
-        }
-      }
-    } else unknown.push(arg);
-  }
-  while (i < k) trailing.push(argv[i++]); // trailing
-  if (propagateDefaults) addDefaults(config, options);
-
-  return { options, unknown, arguments: args, trailing };
-}
-
-/** Generates the help text for the specified configuration. */
-export function help(config, options) {
-  if (!options) options = {};
-  var indent = options.indent || 2;
-  var padding = options.padding || 24;
-  var eol = options.eol || "\n";
-  var sbCategories = {};
-  var sbOther = [];
-  Object.keys(config).forEach(key => {
-    var option = config[key];
-    if (option.description == null) return;
-    var text = "";
-    while (text.length < indent) text += " ";
-    text += "--" + key;
-    if (option.alias) text += ", -" + option.alias;
-    while (text.length < padding) text += " ";
-    var sb;
-    if (!options.noCategories && option.category) {
-      if (!(sb = sbCategories[option.category])) {
-        sbCategories[option.category] = sb = [];
-      }
-    } else {
-      sb = sbOther;
-    }
-    if (Array.isArray(option.description)) {
-      sb.push(text + option.description[0] + option.description.slice(1).map(line => {
-        for (let i = 0; i < padding; ++i) line = " " + line;
-        return eol + line;
-      }).join(""));
-    } else sb.push(text + option.description);
-  });
-  var sb = [];
-  var hasCategories = false;
-  Object.keys(sbCategories).forEach(category => {
-    hasCategories = true;
-    sb.push(eol + " " + stdoutColors.gray(category) + eol);
-    sb.push(sbCategories[category].join(eol));
-  });
-  if (hasCategories && sbOther.length) {
-    sb.push(eol + " " + stdoutColors.gray("Other") + eol);
-  }
-  sb.push(sbOther.join(eol));
-  return sb.join(eol);
-}
-
-/** Sanitizes an option value to be a valid value of the option's type. */
-function sanitizeValue(value, type) {
-  if (value != null) {
-    switch (type) {
-      case undefined:
-      case "b": return Boolean(value);
-      case "i": return Math.trunc(value) || 0;
-      case "f": return Number(value) || 0;
-      case "s": {
-        if (value === true) return "";
-        if (value === false) return null;
-        return String(value);
-      }
-      case "I": {
-        if (!Array.isArray(value)) value = [ value ];
-        return value.map(v => Math.trunc(v) || 0);
-      }
-      case "F": {
-        if (!Array.isArray(value)) value = [ value ];
-        return value.map(v => Number(v) || 0);
-      }
-      case "S": {
-        if (!Array.isArray(value)) value = [ value ];
-        return value.map(String);
-      }
-    }
-  }
-  return undefined;
-}
-
-/** Merges two sets of options into one, preferring the current over the parent set. */
-export function merge(config, currentOptions, parentOptions, parentBaseDir) {
-  const mergedOptions = {};
-  for (const [key, { type, mutuallyExclusive, isPath, useNodeResolution, cliOnly }] of Object.entries(config)) {
-    let currentValue = sanitizeValue(currentOptions[key], type);
-    let parentValue = sanitizeValue(parentOptions[key], type);
-    if (currentValue == null) {
-      if (parentValue != null) {
-        // only parent value present
-        if (cliOnly) continue;
-        if (Array.isArray(parentValue)) {
-          let exclude;
-          if (isPath) {
-            parentValue = parentValue.map(value => resolvePath(value, parentBaseDir, useNodeResolution));
-          }
-          if (mutuallyExclusive != null && (exclude = currentOptions[mutuallyExclusive])) {
-            mergedOptions[key] = parentValue.filter(value => !exclude.includes(value));
-          } else {
-            mergedOptions[key] = parentValue.slice();
-          }
-        } else {
-          if (isPath) {
-            parentValue = resolvePath(parentValue, parentBaseDir, useNodeResolution);
-          }
-          mergedOptions[key] = parentValue;
-        }
-      }
-    } else if (parentValue == null) {
-      // only current value present
-      if (Array.isArray(currentValue)) {
-        mergedOptions[key] = currentValue.slice();
-      } else {
-        mergedOptions[key] = currentValue;
-      }
-    } else {
-      // both current and parent values present
-      if (Array.isArray(currentValue)) {
-        if (cliOnly) {
-          mergedOptions[key] = currentValue.slice();
-          continue;
-        }
-        let exclude;
-        if (isPath) {
-          parentValue = parentValue.map(value => resolvePath(value, parentBaseDir, useNodeResolution));
-        }
-        if (mutuallyExclusive != null && (exclude = currentOptions[mutuallyExclusive])) {
-          mergedOptions[key] = [
-            ...currentValue,
-            ...parentValue.filter(value => !currentValue.includes(value) && !exclude.includes(value))
-          ];
-        } else {
-          mergedOptions[key] = [
-            ...currentValue,
-            ...parentValue.filter(value => !currentValue.includes(value)) // dedup
-          ];
-        }
-      } else {
-        mergedOptions[key] = currentValue;
-      }
-    }
-  }
-  return mergedOptions;
-}
-
-/** Normalizes a path. */
-export function normalizePath(p) {
-  const parsed = path.parse(p);
-  if (!parsed.root) {
-    parsed.root = "./";
-  }
-  return path.format(parsed);
-}
-
-/** Resolves a single possibly relative path. Keeps absolute paths, otherwise prepends baseDir. */
-export function resolvePath(p, baseDir, useNodeResolution = false) {
-  if (path.isAbsolute(p)) return p;
-  if (useNodeResolution && !p.startsWith(".") && require.resolve) {
-    return require.resolve(p, { paths: [ baseDir ] });
-  }
-  return normalizePath(path.join(baseDir, p));
-}
-
-/** Populates default values on a parsed options result. */
-export function addDefaults(config, options) {
-  for (const [key, { default: defaultValue }] of Object.entries(config)) {
-    if (options[key] == null && defaultValue != null) {
-      options[key] = defaultValue;
-    }
-  }
-}
+/**
+ * @fileoverview Command line options utility.
+ * @license Apache-2.0
+ */
+
+import { path, module } from "./node.js";
+import { stdoutColors } from "./terminal.js";
+
+const require = module.createRequire(import.meta.url);
+
+// type | meaning
+// -----|---------------
+// b    | boolean
+// i    | integer
+// f    | float
+// s    | string
+// I    | integer array
+// F    | float array
+// S    | string array
+
+/** Parses the specified command line arguments according to the given configuration. */
+export function parse(argv, config, propagateDefaults = true) {
+  var options = {};
+  var unknown = [];
+  var args = [];
+  var trailing = [];
+
+  // make an alias map and initialize defaults
+  var aliases = {};
+  Object.keys(config).forEach(key => {
+    if (key.startsWith(" ")) return;
+    var option = config[key];
+    if (option.alias != null) {
+      if (typeof option.alias === "string") aliases[option.alias] = key;
+      else if (Array.isArray(option.alias)) option.alias.forEach(alias => aliases[alias] = key);
+    }
+    if (propagateDefaults && option.default != null) options[key] = option.default;
+  });
+
+  // iterate over argv
+  for (var i = 0, k = (argv = argv.slice()).length; i < k; ++i) {
+    let arg = argv[i];
+    if (arg == "--") { ++i; break; }
+    let match = /^(?:(-\w)(?:=(.*))?|(--\w{2,})(?:=(.*))?)$/.exec(arg), option, key;
+    if (match) {
+      if (config[arg]) option = config[key = arg]; // exact
+      else if (match[1] != null) { // alias
+        option = config[key = aliases[match[1].substring(1)]];
+        if (option && match[2] != null) argv[i--] = match[2];
+      } else if (match[3] != null) { // full
+        option = config[key = match[3].substring(2)];
+        if (option && match[4] != null) argv[i--] = match[4];
+      }
+    } else {
+      if (arg.charCodeAt(0) == 45) option = config[key = arg]; // exact
+      else { args.push(arg); continue; } // argument
+    }
+    if (option) {
+      if (option.value) {
+        // alias setting fixed values
+        Object.keys(option.value).forEach(k => options[k] = option.value[k]);
+      } else if (option.type == null || option.type === "b") {
+        // boolean flag not taking a value
+        options[key] = true;
+      } else {
+        if (i + 1 < argv.length && argv[i + 1].charCodeAt(0) != 45) {
+          // non-boolean with given value
+          switch (option.type) {
+            case "i": options[key] = parseInt(argv[++i], 10); break;
+            case "I": options[key] = (options[key] || []).concat(parseInt(argv[++i], 10)); break;
+            case "f": options[key] = parseFloat(argv[++i]); break;
+            case "F": options[key] = (options[key] || []).concat(parseFloat(argv[++i])); break;
+            case "s": options[key] = String(argv[++i]); break;
+            case "S": options[key] = (options[key] || []).concat(argv[++i].split(",")); break;
+            default: unknown.push(arg); --i;
+          }
+        } else {
+          // non-boolean with omitted value
+          switch (option.type) {
+            case "i":
+            case "f": options[key] = option.default || 0; break;
+            case "s": options[key] = option.default || ""; break;
+            case "I":
+            case "F":
+            case "S": options[key] = option.default || []; break;
+            default: unknown.push(arg);
+          }
+        }
+      }
+    } else unknown.push(arg);
+  }
+  while (i < k) trailing.push(argv[i++]); // trailing
+  if (propagateDefaults) addDefaults(config, options);
+
+  return { options, unknown, arguments: args, trailing };
+}
+
+/** Generates the help text for the specified configuration. */
+export function help(config, options) {
+  if (!options) options = {};
+  var indent = options.indent || 2;
+  var padding = options.padding || 24;
+  var eol = options.eol || "\n";
+  var sbCategories = {};
+  var sbOther = [];
+  Object.keys(config).forEach(key => {
+    var option = config[key];
+    if (option.description == null) return;
+    var text = "";
+    while (text.length < indent) text += " ";
+    text += "--" + key;
+    if (option.alias) text += ", -" + option.alias;
+    while (text.length < padding) text += " ";
+    var sb;
+    if (!options.noCategories && option.category) {
+      if (!(sb = sbCategories[option.category])) {
+        sbCategories[option.category] = sb = [];
+      }
+    } else {
+      sb = sbOther;
+    }
+    if (Array.isArray(option.description)) {
+      sb.push(text + option.description[0] + option.description.slice(1).map(line => {
+        for (let i = 0; i < padding; ++i) line = " " + line;
+        return eol + line;
+      }).join(""));
+    } else sb.push(text + option.description);
+  });
+  var sb = [];
+  var hasCategories = false;
+  Object.keys(sbCategories).forEach(category => {
+    hasCategories = true;
+    sb.push(eol + " " + stdoutColors.gray(category) + eol);
+    sb.push(sbCategories[category].join(eol));
+  });
+  if (hasCategories && sbOther.length) {
+    sb.push(eol + " " + stdoutColors.gray("Other") + eol);
+  }
+  sb.push(sbOther.join(eol));
+  return sb.join(eol);
+}
+
+/** Sanitizes an option value to be a valid value of the option's type. */
+function sanitizeValue(value, type) {
+  if (value != null) {
+    switch (type) {
+      case undefined:
+      case "b": return Boolean(value);
+      case "i": return Math.trunc(value) || 0;
+      case "f": return Number(value) || 0;
+      case "s": {
+        if (value === true) return "";
+        if (value === false) return null;
+        return String(value);
+      }
+      case "I": {
+        if (!Array.isArray(value)) value = [ value ];
+        return value.map(v => Math.trunc(v) || 0);
+      }
+      case "F": {
+        if (!Array.isArray(value)) value = [ value ];
+        return value.map(v => Number(v) || 0);
+      }
+      case "S": {
+        if (!Array.isArray(value)) value = [ value ];
+        return value.map(String);
+      }
+    }
+  }
+  return undefined;
+}
+
+/** Merges two sets of options into one, preferring the current over the parent set. */
+export function merge(config, currentOptions, parentOptions, parentBaseDir) {
+  const mergedOptions = {};
+  for (const [key, { type, mutuallyExclusive, isPath, useNodeResolution, cliOnly }] of Object.entries(config)) {
+    let currentValue = sanitizeValue(currentOptions[key], type);
+    let parentValue = sanitizeValue(parentOptions[key], type);
+    if (currentValue == null) {
+      if (parentValue != null) {
+        // only parent value present
+        if (cliOnly) continue;
+        if (Array.isArray(parentValue)) {
+          let exclude;
+          if (isPath) {
+            parentValue = parentValue.map(value => resolvePath(value, parentBaseDir, useNodeResolution));
+          }
+          if (mutuallyExclusive != null && (exclude = currentOptions[mutuallyExclusive])) {
+            mergedOptions[key] = parentValue.filter(value => !exclude.includes(value));
+          } else {
+            mergedOptions[key] = parentValue.slice();
+          }
+        } else {
+          if (isPath) {
+            parentValue = resolvePath(parentValue, parentBaseDir, useNodeResolution);
+          }
+          mergedOptions[key] = parentValue;
+        }
+      }
+    } else if (parentValue == null) {
+      // only current value present
+      if (Array.isArray(currentValue)) {
+        mergedOptions[key] = currentValue.slice();
+      } else {
+        mergedOptions[key] = currentValue;
+      }
+    } else {
+      // both current and parent values present
+      if (Array.isArray(currentValue)) {
+        if (cliOnly) {
+          mergedOptions[key] = currentValue.slice();
+          continue;
+        }
+        let exclude;
+        if (isPath) {
+          parentValue = parentValue.map(value => resolvePath(value, parentBaseDir, useNodeResolution));
+        }
+        if (mutuallyExclusive != null && (exclude = currentOptions[mutuallyExclusive])) {
+          mergedOptions[key] = [
+            ...currentValue,
+            ...parentValue.filter(value => !currentValue.includes(value) && !exclude.includes(value))
+          ];
+        } else {
+          mergedOptions[key] = [
+            ...currentValue,
+            ...parentValue.filter(value => !currentValue.includes(value)) // dedup
+          ];
+        }
+      } else {
+        mergedOptions[key] = currentValue;
+      }
+    }
+  }
+  return mergedOptions;
+}
+
+/** Normalizes a path. */
+export function normalizePath(p) {
+  const parsed = path.parse(p);
+  if (!parsed.root) {
+    parsed.root = "./";
+  }
+  return path.format(parsed);
+}
+
+/** Resolves a single possibly relative path. Keeps absolute paths, otherwise prepends baseDir. */
+export function resolvePath(p, baseDir, useNodeResolution = false) {
+  if (path.isAbsolute(p)) return p;
+  if (useNodeResolution && !p.startsWith(".") && require.resolve) {
+    return require.resolve(p, { paths: [ baseDir ] });
+  }
+  return normalizePath(path.join(baseDir, p));
+}
+
+/** Populates default values on a parsed options result. */
+export function addDefaults(config, options) {
+  for (const [key, { default: defaultValue }] of Object.entries(config)) {
+    if (options[key] == null && defaultValue != null) {
+      options[key] = defaultValue;
+    }
+  }
+}

package/util/terminal.d.ts

@@ -1,52 +1,52 @@
-/**
- * @fileoverview Terminal colors utility definitions.
- * @license Apache-2.0
- */
-
-/** Color code for gray. */
-export const GRAY: string;
-/** Color code for red. */
-export const RED: string;
-/** Color code for green. */
-export const GREEN: string;
-/** Color code for yellow. */
-export const YELLOW: string;
-/** Color code for blue. */
-export const BLUE: string;
-/** Color code for magenta. */
-export const MAGENTA: string;
-/** Color code for cyan. */
-export const CYAN: string;
-/** Color code for white. */
-export const WHITE: string;
-/** Code to reset any colors. */
-export const RESET: string;
-
-/** Color utility class. */
-export class Colors {
-  /** Constructs a new instance for the given stream. */
-  constructor(stream: { isTTY: boolean });
-  /** Whether terminal colors are enabled. */
-  enabled: boolean;
-  /** Colors a string in gray if {@link enabled}. */
-  gray(text: string): string;
-  /** Colors a string in red if {@link enabled}. */
-  red(text: string): string;
-  /** Colors a string in green if {@link enabled}. */
-  green(text: string): string;
-  /** Colors a string in yellow if {@link enabled}. */
-  yellow(text: string): string;
-  /** Colors a string in blue if {@link enabled}. */
-  blue(text: string): string;
-  /** Colors a string in magenta if {@link enabled}. */
-  magenta(text: string): string;
-  /** Colors a string in cyan if {@link enabled}. */
-  cyan(text: string): string;
-  /** Colors a string in white if {@link enabled}. */
-  white(text: string): string;
-}
-
-/** Color utility for stdout. */
-export const stdoutColors: Colors;
-/** Color utility for stderr. */
-export const stderrColors: Colors;
+/**
+ * @fileoverview Terminal colors utility definitions.
+ * @license Apache-2.0
+ */
+
+/** Color code for gray. */
+export const GRAY: string;
+/** Color code for red. */
+export const RED: string;
+/** Color code for green. */
+export const GREEN: string;
+/** Color code for yellow. */
+export const YELLOW: string;
+/** Color code for blue. */
+export const BLUE: string;
+/** Color code for magenta. */
+export const MAGENTA: string;
+/** Color code for cyan. */
+export const CYAN: string;
+/** Color code for white. */
+export const WHITE: string;
+/** Code to reset any colors. */
+export const RESET: string;
+
+/** Color utility class. */
+export class Colors {
+  /** Constructs a new instance for the given stream. */
+  constructor(stream: { isTTY: boolean });
+  /** Whether terminal colors are enabled. */
+  enabled: boolean;
+  /** Colors a string in gray if {@link enabled}. */
+  gray(text: string): string;
+  /** Colors a string in red if {@link enabled}. */
+  red(text: string): string;
+  /** Colors a string in green if {@link enabled}. */
+  green(text: string): string;
+  /** Colors a string in yellow if {@link enabled}. */
+  yellow(text: string): string;
+  /** Colors a string in blue if {@link enabled}. */
+  blue(text: string): string;
+  /** Colors a string in magenta if {@link enabled}. */
+  magenta(text: string): string;
+  /** Colors a string in cyan if {@link enabled}. */
+  cyan(text: string): string;
+  /** Colors a string in white if {@link enabled}. */
+  white(text: string): string;
+}
+
+/** Color utility for stdout. */
+export const stdoutColors: Colors;
+/** Color utility for stderr. */
+export const stderrColors: Colors;