@satisfactory-dev/docdown 0.1.0 → 0.1.1

package/bin-lib/help.js

@@ -0,0 +1,21 @@
+/**
+ * Generates the help text for the docdown cli tool
+ *
+ * @return {string} The help text for the docdown cli tool
+ */
+function help() {
+  return [
+    'Usage:',
+    '  docdown inputFile.js outputFile.md [options]',
+    'Options:',
+    '  lang="js"                   The language indicator for code blocks.',
+    '  sort=true|false             Specify whether entries are sorted.',
+    '  style="default|github"      The hash style for links.',
+    '  title="title"               The documentation title.',
+    '  toc="categories|properties" The table of contents organization style.',
+    '  url="url"                   The source URL.',
+    '  --force                     Force the docs to be written to if writing would only leave commit hash-related changes',
+  ].join('\n');
+}
+
+export default help;

package/bin-lib/options.js

@@ -0,0 +1,58 @@
+/*!
+ * docdown
+ * Copyright 2011-2016 John-David Dalton
+ * Copyright 2026 SignpostMarv
+ * Available under MIT license
+ */
+
+/*----------------------------------------------------------------------------*/
+
+/** @typedef {'lang'|'sort'|'style'|'title'|'toc'|'url'|'--force'} OptionName */
+
+/**
+ * Wraps functions in a context provider to enable testing without relying on process.argv
+ *
+ * @param {string[]} context
+ */
+function fromContext(context) {
+  /**
+   * Gets the value for the given option name. If no value is available the
+   * `defaultValue` is returned.
+   *
+   * @param {OptionName} name The name of the option.
+   * @param {string|boolean|undefined} defaultValue The default option value.
+   * @returns {string|boolean|undefined} Returns the option value.
+   */
+  function getOption(name, defaultValue) {
+    return context.reduce(function(result, value) {
+      value = optionToValue(name, value);
+
+      return value == null ? result : value;
+    }, defaultValue);
+  }
+
+  return getOption;
+}
+
+/**
+ * Extracts the option value from an option string.
+ *
+ * @param {OptionName} name The name of the option to inspect.
+ * @param {string} string The options string.
+ * @returns {string|boolean|undefined} Returns the option value, else `undefined`.
+ */
+function optionToValue(name, string) {
+  /** @type {string|undefined} */
+  let result = undefined;
+  const match = string.match(RegExp('^' + name + '(?:=([\\s\\S]+))?$'));
+  if (match) {
+    [, result] = match;
+    result = result ? result.trim() : true;
+  }
+  if (result === 'false') {
+    return false;
+  }
+  return result || undefined;
+}
+
+export default fromContext;

package/package.json

@@ -31,7 +31,8 @@
   "files": [
     "index.js",
     "bin",
+    "bin-lib",
     "lib"
   ],
-  "version": "0.1.0"
+  "version": "0.1.1"
 }