@satisfactory-dev/docdown 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright 2011-2016 John-David Dalton
+Copyright 2026 SignpostMarv
+
+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,33 @@
+# Satisfactory.dev docdown Fork
+
+[![Coverage Status](https://coveralls.io/repos/github/satisfactory-dev/docdown/badge.svg?branch=main)](https://coveralls.io/github/satisfactory-dev/docdown?branch=main)
+[![Workflow Status](https://github.com/satisfactory-dev/docdown/actions/workflows/nodejs.yml/badge.svg?branch=main)](https://github.com/satisfactory-dev/docdown/actions/workflows/nodejs.yml?query=branch%3Amain)
+
+A simple JSDoc to Markdown documentation generator.
+
+Forked from [docdown](https://github.com/jdalton/docdown)
+
+## Docs
+
+* [index.js](doc/index.md)
+* lib
+  - [alias.js](doc/lib/alias.md)
+  - [entry.js](doc/lib/entry.md)
+  - [generator.js](doc/lib/generator.md)
+  - [util.js](doc/lib/util.md)
+
+## Usage
+
+```js
+var docdown = require('@satisfactory-dev/docdown');
+
+var markdown = docdown({
+  'path': filepath,
+  'url': 'https://github.com/username/project/blob/master/my.js'
+});
+```
+
+```Makefile
+docs:
+  node bin/docdown index.js doc/README.md style=github title="docdown <sup>$(shell git rev-parse HEAD)$</sup>" url=https://github.com/username/project/blob/$(shell git rev-parse HEAD)$/my.js
+```

package/bin/docdown.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+/*!
+ * docdown
+ * Copyright 2011-2016 John-David Dalton
+ * Copyright 2026 SignpostMarv
+ * Available under MIT license
+ */
+
+/** Load Node.js modules */
+import {
+  existsSync,
+  readFileSync,
+  writeFileSync,
+} from 'node:fs';
+import {
+  join,
+} from 'node:path';
+
+/** Load other modules */
+import fromContext from '../bin-lib/options.js';
+import help from '../bin-lib/help.js';
+import docdown from '../index.js';
+
+const getOption = fromContext(process.argv);
+
+/** The list of arguments provided */
+var argv = process.argv;
+
+/*----------------------------------------------------------------------------*/
+
+var cwd = process.cwd(),
+    fileName = argv[2],
+    outputFile = argv[3];
+
+if (
+  !fileName ||
+  !outputFile ||
+  argv.includes('-h') ||
+  argv.includes('--help')
+) {
+  console.log(help());
+  process.exit(1);
+}
+
+fileName = join(cwd, fileName);
+outputFile = join(cwd, outputFile);
+
+var options = {
+  'lang': getOption('lang'),
+  'path': fileName,
+  'sort': getOption('sort'),
+  'style': getOption('style'),
+  'title': getOption('title'),
+  'toc': getOption('toc'),
+  'url': getOption('url'),
+  tocLink: getOption('tocLink'),
+};
+
+var output = docdown(options);
+
+const previous = existsSync(outputFile) ? readFileSync(outputFile).toString() : '';
+
+if (
+  !getOption('--force', false) &&
+  options.style == 'github' &&
+  'string' === typeof options.url &&
+  previous != '' &&
+  /\/blob\/[0-9a-f]{40}\//.test(options.url)
+) {
+  const previousWithoutGitCommitHash = previous.replace(/\b[0-9a-f]{40}\b/g, '');
+  const currentWithoutGitCommitHash = output.replace(/\b[0-9a-f]{40}\b/g, '');
+
+  if (previousWithoutGitCommitHash == currentWithoutGitCommitHash) {
+    console.log(
+      `skipping write to ${
+        fileName
+      }, as contents have not changed. pass force argument to force update.`
+    );
+
+    process.exit(0)
+  }
+}
+
+writeFileSync(outputFile, output, 'utf8');
+
+process.exit(0);

package/index.js

@@ -0,0 +1,53 @@
+/*!
+ * docdown
+ * Copyright 2011-2016 John-David Dalton
+ * Copyright 2026 SignpostMarv
+ * Available under MIT license
+ */
+
+import {
+  readFileSync,
+} from 'node:fs';
+
+import {
+  basename,
+} from 'node:path';
+
+import generator from './lib/generator.js';
+
+/**
+ * Generates Markdown documentation based on JSDoc comments.
+ *
+ * @param {Object} options The options object.
+ * @param {string} options.path The input file path.
+ * @param {string} options.url The source URL.
+ * @param {string} [options.lang='js'] The language indicator for code blocks.
+ * @param {boolean} [options.sort=true] Specify whether entries are sorted.
+ * @param {string} [options.style='default'] The hash style for links ('default' or 'github').
+ * @param {string} [options.title='<%= basename(options.path) %> API documentation'] The documentation title.
+ * @param {string} [options.toc='properties'] The table of contents organization style ('categories' or 'properties').
+ * @returns {string} The generated Markdown code.
+ */
+function docdown({
+  lang = 'js',
+  sort = true,
+  style = 'default',
+  title,
+  toc = 'properties',
+  ...options
+} = {}) {
+  if (!options.path || !options.url) {
+    throw new Error('Path and URL must be specified');
+  }
+
+  return generator(readFileSync(options.path, 'utf8'), {
+    ...options,
+    lang,
+    sort,
+    style,
+    title: title == undefined ? basename(options.path) + ' API documentation' : title,
+    toc,
+  });
+}
+
+export default docdown;

package/lib/alias.js

@@ -0,0 +1,220 @@
+/*!
+ * docdown
+ * Copyright 2011-2016 John-David Dalton
+ * Copyright 2026 SignpostMarv
+ * Available under MIT license
+ */
+
+class Alias {
+  /** @type {Object} */
+  #owner;
+
+  /** @type {string} */
+  #name;
+
+  /**
+   * The Alias constructor.
+   *
+   * @param {string} name The alias name.
+   * @param {Object} owner The alias owner.
+   */
+  constructor(name, owner) {
+    this.#owner = owner;
+    this.#name = name;
+  }
+
+  /**
+   * Extracts the entry's `alias` objects.
+   *
+   * @param {number} [index] The index of the array value to return.
+   * @returns {Array|string} Returns the entry's `alias` objects.
+   */
+  getAliases(index) {
+    return index == null ? [] : undefined;
+  }
+
+  /**
+   * Extracts the function call from the owner entry.
+   *
+   * @returns {string} Returns the function call.
+   */
+  getCall() {
+    return this.#owner.getCall();
+  }
+
+  /**
+   * Extracts the owner entry's `category` data.
+   *
+   * @returns {string} Returns the owner entry's `category` data.
+   */
+  getCategory() {
+    return this.#owner.getCategory();
+  }
+
+  /**
+   * Extracts the owner entry's description.
+   *
+   * @returns {string} Returns the owner entry's description.
+   */
+  getDesc() {
+    return this.#owner.getDesc();
+  }
+
+  /**
+   * Extracts the owner entry's `example` data.
+   *
+   * @returns {string} Returns the owner entry's `example` data.
+   */
+  getExample() {
+    return this.#owner.getExample();
+  }
+
+  /**
+   * Extracts the entry's hash value for permalinking.
+   *
+   * @param {string} [style] The hash style.
+   * @returns {string} Returns the entry's hash value (without a hash itself).
+   */
+  getHash(style) {
+    return this.#owner.getHash(style);
+  }
+
+  /**
+   * Resolves the owner entry's line number.
+   *
+   * @returns {number} Returns the owner entry's line number.
+   */
+  getLineNumber() {
+    return this.#owner.getLineNumber();
+  }
+
+  /**
+   * Extracts the owner entry's `member` data.
+   *
+   * @param {number} [index] The index of the array value to return.
+   * @returns {Array|string} Returns the owner entry's `member` data.
+   */
+  getMembers(index) {
+    return this.#owner.getMembers(index);
+  }
+
+  /**
+   * Extracts the owner entry's `name` data.
+   *
+   * @returns {string} Returns the owner entry's `name` data.
+   */
+  getName() {
+    return this.#name;
+  }
+
+  /**
+   * Gets the owner entry object.
+   *
+   * @returns {Object} Returns the owner entry.
+   */
+  getOwner() {
+    return this.#owner;
+  }
+
+  /**
+   * Extracts the owner entry's `param` data.
+   *
+   * @param {number} [index] The index of the array value to return.
+   * @returns {Array} Returns the owner entry's `param` data.
+   */
+  getParams(index) {
+    return this.#owner.getParams(index);
+  }
+
+  /**
+   * Extracts the owner entry's `returns` data.
+   *
+   * @returns {string} Returns the owner entry's `returns` data.
+   */
+  getReturns() {
+    return this.#owner.getReturns();
+  }
+
+  /**
+   * Extracts the owner entry's `since` data.
+   *
+   * @returns {string} Returns the owner entry's `since` data.
+   */
+  getSince() {
+    return this.#owner.getSince();
+  }
+
+  /**
+   * Extracts the owner entry's `type` data.
+   *
+   * @returns {string} Returns the owner entry's `type` data.
+   */
+  getType() {
+    return this.#owner.getType();
+  }
+
+  /**
+   * Checks if the entry is an alias.
+   *
+   * @returns {boolean} Returns `true`.
+   */
+  isAlias() {
+    return true;
+  }
+
+  /**
+   * Checks if the owner entry is a constructor.
+   *
+   * @returns {boolean} Returns `true` if a constructor, else `false`.
+   */
+  isCtor() {
+    return this.#owner.isCtor();
+  }
+
+  /**
+   * Checks if the entry is a function reference.
+   *
+   * @returns {boolean} Returns `true` if the entry is a function reference, else `false`.
+   */
+  isFunction() {
+    return this.#owner.isFunction();
+  }
+
+  /**
+   * Checks if the owner entry is a license.
+   *
+   * @returns {boolean} Returns `true` if a license, else `false`.
+   */
+  isLicense() {
+    return this.#owner.isLicense();
+  }
+
+  /**
+   * Checks if the owner entry *is* assigned to a prototype.
+   *
+   * @returns {boolean} Returns `true` if assigned to a prototype, else `false`.
+   */
+  isPlugin() {
+    return this.#owner.isPlugin();
+  }
+
+  /**
+   * Checks if the owner entry is private.
+   *
+   * @returns {boolean} Returns `true` if private, else `false`.
+   */
+  isPrivate() {
+    return this.#owner.isPrivate();
+  }
+
+  /**
+   * Checks if the owner entry is *not* assigned to a prototype.
+   *
+   * @returns {boolean} Returns `true` if not assigned to a prototype, else `false`.
+   */
+  isStatic() {
+    return this.#owner.isStatic();
+  }
+}
+
+export default Alias;