[HTML5] Add jsdoc2rst tool.

A template for `jsdoc` that generat the HTML5 public classref.

The script can be run via `npm run docs` to print to stdout.

You can dry run via `npm run docs -- --d dry-run` or write to file via
`npm run docs -- -d /path/to/file.rst`

Also update Makefile in `doc/` and add dry run test to CI.

(cherry picked from commit 472482013e760b0c0334d99b7bf21d9bd2a3a206)

.github/workflows/static_checks.yml

@@ -35,11 +35,12 @@ jobs:
         run: |
           bash ./misc/scripts/black_format.sh
 
-      - name: JavaScript style checks via ESLint
+      - name: JavaScript style and documentation checks via ESLint and JSDoc
         run: |
           cd platform/javascript
           npm ci
           npm run lint
+          npm run docs -- -d dry-run
 
       - name: Documentation checks
         run: |

doc/Makefile

@@ -2,6 +2,7 @@ BASEDIR = $(CURDIR)
 CLASSES = $(BASEDIR)/classes/ $(BASEDIR)/../modules/
 OUTPUTDIR = $(BASEDIR)/_build
 TOOLSDIR = $(BASEDIR)/tools
+JSDIR = $(BASEDIR)/../platform/javascript
 
 .ONESHELL:
 
@@ -23,6 +24,10 @@ markdown:
 rst:
 	rm -rf $(OUTPUTDIR)/rst
 	mkdir -p $(OUTPUTDIR)/rst
-	pushd $(OUTPUTDIR)/rst
-	python3 $(TOOLSDIR)/makerst.py $(CLASSES)
-	popd
+	python3 $(TOOLSDIR)/makerst.py -o $(OUTPUTDIR)/rst $(CLASSES)
+
+rstjs:
+	rm -rf $(OUTPUTDIR)/rstjs
+	mkdir -p $(OUTPUTDIR)/rstjs
+	npm --prefix $(JSDIR) ci
+	npm --prefix $(JSDIR) run docs -- --destination $(OUTPUTDIR)/rstjs/html5_shell_classref.rst

platform/javascript/js/jsdoc2rst/publish.js

@@ -0,0 +1,354 @@
+/* eslint-disable strict */
+
+'use strict';
+
+const fs = require('fs');
+
+class JSDoclet {
+	constructor(doc) {
+		this.doc = doc;
+		this.description = doc['description'] || '';
+		this.name = doc['name'] || 'unknown';
+		this.longname = doc['longname'] || '';
+		this.types = [];
+		if (doc['type'] && doc['type']['names']) {
+			this.types = doc['type']['names'].slice();
+		}
+		this.type = this.types.length > 0 ? this.types.join('\\|') : '*';
+		this.variable = doc['variable'] || false;
+		this.kind = doc['kind'] || '';
+		this.memberof = doc['memberof'] || null;
+		this.scope = doc['scope'] || '';
+		this.members = [];
+		this.optional = doc['optional'] || false;
+		this.defaultvalue = doc['defaultvalue'];
+		this.summary = doc['summary'] || null;
+		this.classdesc = doc['classdesc'] || null;
+
+		// Parameters (functions)
+		this.params = [];
+		this.returns = doc['returns'] ? doc['returns'][0]['type']['names'][0] : 'void';
+		this.returns_desc = doc['returns'] ? doc['returns'][0]['description'] : null;
+
+		this.params = (doc['params'] || []).slice().map((p) => new JSDoclet(p));
+
+		// Custom tags
+		this.tags = doc['tags'] || [];
+		this.header = this.tags.filter((t) => t['title'] === 'header').map((t) => t['text']).pop() || null;
+	}
+
+	add_member(obj) {
+		this.members.push(obj);
+	}
+
+	is_static() {
+		return this.scope === 'static';
+	}
+
+	is_instance() {
+		return this.scope === 'instance';
+	}
+
+	is_object() {
+		return this.kind === 'Object' || (this.kind === 'typedef' && this.type === 'Object');
+	}
+
+	is_class() {
+		return this.kind === 'class';
+	}
+
+	is_function() {
+		return this.kind === 'function' || (this.kind === 'typedef' && this.type === 'function');
+	}
+
+	is_module() {
+		return this.kind === 'module';
+	}
+}
+
+function format_table(f, data, depth = 0) {
+	if (!data.length) {
+		return;
+	}
+
+	const column_sizes = new Array(data[0].length).fill(0);
+
+	data.forEach((row) => {
+		row.forEach((e, idx) => {
+			column_sizes[idx] = Math.max(e.length, column_sizes[idx]);
+		});
+	});
+
+	const indent = ' '.repeat(depth);
+	let sep = indent;
+	column_sizes.forEach((size) => {
+		sep += '+';
+		sep += '-'.repeat(size + 2);
+	});
+	sep += '+\n';
+	f.write(sep);
+
+	data.forEach((row) => {
+		let row_text = `${indent}|`;
+		row.forEach((entry, idx) => {
+			row_text += ` ${entry.padEnd(column_sizes[idx])} |`;
+		});
+		row_text += '\n';
+		f.write(row_text);
+		f.write(sep);
+	});
+
+	f.write('\n');
+}
+
+function make_header(header, sep) {
+	return `${header}\n${sep.repeat(header.length)}\n\n`;
+}
+
+function indent_multiline(text, depth) {
+	const indent = ' '.repeat(depth);
+	return text.split('\n').map((l) => (l === '' ? l : indent + l)).join('\n');
+}
+
+function make_rst_signature(obj, types = false, style = false) {
+	let out = '';
+	const fmt = style ? '*' : '';
+	obj.params.forEach((arg, idx) => {
+		if (idx > 0) {
+			if (arg.optional) {
+				out += ` ${fmt}[`;
+			}
+			out += ', ';
+		} else {
+			out += ' ';
+			if (arg.optional) {
+				out += `${fmt}[ `;
+			}
+		}
+		if (types) {
+			out += `${arg.type} `;
+		}
+		const variable = arg.variable ? '...' : '';
+		const defval = arg.defaultvalue !== undefined ? `=${arg.defaultvalue}` : '';
+		out += `${variable}${arg.name}${defval}`;
+		if (arg.optional) {
+			out += ` ]${fmt}`;
+		}
+	});
+	out += ' ';
+	return out;
+}
+
+function make_rst_param(f, obj, depth = 0) {
+	const indent = ' '.repeat(depth * 3);
+	f.write(indent);
+	f.write(`:param ${obj.type} ${obj.name}:\n`);
+	f.write(indent_multiline(obj.description, (depth + 1) * 3));
+	f.write('\n\n');
+}
+
+function make_rst_attribute(f, obj, depth = 0, brief = false) {
+	const indent = ' '.repeat(depth * 3);
+	f.write(indent);
+	f.write(`.. js:attribute:: ${obj.name}\n\n`);
+
+	if (brief) {
+		if (obj.summary) {
+			f.write(indent_multiline(obj.summary, (depth + 1) * 3));
+		}
+		f.write('\n\n');
+		return;
+	}
+
+	f.write(indent_multiline(obj.description, (depth + 1) * 3));
+	f.write('\n\n');
+
+	f.write(indent);
+	f.write(`   :type: ${obj.type}\n\n`);
+
+	if (obj.defaultvalue !== undefined) {
+		let defval = obj.defaultvalue;
+		if (defval === '') {
+			defval = '""';
+		}
+		f.write(indent);
+		f.write(`   :value: \`\`${defval}\`\`\n\n`);
+	}
+}
+
+function make_rst_function(f, obj, depth = 0) {
+	let prefix = '';
+	if (obj.is_instance()) {
+		prefix = 'prototype.';
+	}
+
+	const indent = ' '.repeat(depth * 3);
+	const sig = make_rst_signature(obj);
+	f.write(indent);
+	f.write(`.. js:function:: ${prefix}${obj.name}(${sig})\n`);
+	f.write('\n');
+
+	f.write(indent_multiline(obj.description, (depth + 1) * 3));
+	f.write('\n\n');
+
+	obj.params.forEach((param) => {
+		make_rst_param(f, param, depth + 1);
+	});
+
+	if (obj.returns !== 'void') {
+		f.write(indent);
+		f.write('   :return:\n');
+		f.write(indent_multiline(obj.returns_desc, (depth + 2) * 3));
+		f.write('\n\n');
+		f.write(indent);
+		f.write(`   :rtype: ${obj.returns}\n\n`);
+	}
+}
+
+function make_rst_object(f, obj) {
+	let brief = false;
+	// Our custom header flag.
+	if (obj.header !== null) {
+		f.write(make_header(obj.header, '-'));
+		f.write(`${obj.description}\n\n`);
+		brief = true;
+	}
+
+	// Format members table and descriptions
+	const data = [['type', 'name']].concat(obj.members.map((m) => [m.type, `:js:attr:\`${m.name}\``]));
+
+	f.write(make_header('Properties', '^'));
+	format_table(f, data, 0);
+
+	make_rst_attribute(f, obj, 0, brief);
+
+	if (!obj.members.length) {
+		return;
+	}
+
+	f.write('   **Property Descriptions**\n\n');
+
+	// Properties first
+	obj.members.filter((m) => !m.is_function()).forEach((m) => {
+		make_rst_attribute(f, m, 1);
+	});
+
+	// Callbacks last
+	obj.members.filter((m) => m.is_function()).forEach((m) => {
+		make_rst_function(f, m, 1);
+	});
+}
+
+function make_rst_class(f, obj) {
+	const header = obj.header ? obj.header : obj.name;
+	f.write(make_header(header, '-'));
+
+	if (obj.classdesc) {
+		f.write(`${obj.classdesc}\n\n`);
+	}
+
+	const funcs = obj.members.filter((m) => m.is_function());
+	function make_data(m) {
+		const base = m.is_static() ? obj.name : `${obj.name}.prototype`;
+		const params = make_rst_signature(m, true, true);
+		const sig = `:js:attr:\`${m.name} <${base}.${m.name}>\` **(**${params}**)**`;
+		return [m.returns, sig];
+	}
+	const sfuncs = funcs.filter((m) => m.is_static());
+	const ifuncs = funcs.filter((m) => !m.is_static());
+
+	f.write(make_header('Static Methods', '^'));
+	format_table(f, sfuncs.map((m) => make_data(m)));
+
+	f.write(make_header('Instance Methods', '^'));
+	format_table(f, ifuncs.map((m) => make_data(m)));
+
+	const sig = make_rst_signature(obj);
+	f.write(`.. js:class:: ${obj.name}(${sig})\n\n`);
+	f.write(indent_multiline(obj.description, 3));
+	f.write('\n\n');
+
+	obj.params.forEach((p) => {
+		make_rst_param(f, p, 1);
+	});
+
+	f.write('   **Static Methods**\n\n');
+	sfuncs.forEach((m) => {
+		make_rst_function(f, m, 1);
+	});
+
+	f.write('   **Instance Methods**\n\n');
+	ifuncs.forEach((m) => {
+		make_rst_function(f, m, 1);
+	});
+}
+
+function make_rst_module(f, obj) {
+	const header = obj.header !== null ? obj.header : obj.name;
+	f.write(make_header(header, '='));
+	f.write(obj.description);
+	f.write('\n\n');
+}
+
+function write_base_object(f, obj) {
+	if (obj.is_object()) {
+		make_rst_object(f, obj);
+	} else if (obj.is_function()) {
+		make_rst_function(f, obj);
+	} else if (obj.is_class()) {
+		make_rst_class(f, obj);
+	} else if (obj.is_module()) {
+		make_rst_module(f, obj);
+	}
+}
+
+function generate(f, docs) {
+	const globs = [];
+	const SYMBOLS = {};
+	docs.filter((d) => !d.ignore && d.kind !== 'package').forEach((d) => {
+		SYMBOLS[d.name] = d;
+		if (d.memberof) {
+			const up = SYMBOLS[d.memberof];
+			if (up === undefined) {
+				console.log(d); // eslint-disable-line no-console
+				console.log(`Undefined symbol! ${d.memberof}`); // eslint-disable-line no-console
+				throw new Error('Undefined symbol!');
+			}
+			SYMBOLS[d.memberof].add_member(d);
+		} else {
+			globs.push(d);
+		}
+	});
+
+	f.write('.. _doc_html5_shell_classref:\n\n');
+	globs.forEach((obj) => write_base_object(f, obj));
+}
+
+/**
+ * Generate documentation output.
+ *
+ * @param {TAFFY} data - A TaffyDB collection representing
+ *                       all the symbols documented in your code.
+ * @param {object} opts - An object with options information.
+ */
+exports.publish = function (data, opts) {
+	const docs = data().get().filter((doc) => !doc.undocumented && !doc.ignore).map((doc) => new JSDoclet(doc));
+	const dest = opts.destination;
+	if (dest === 'dry-run') {
+		process.stdout.write('Dry run... ');
+		generate({
+			write: function () { /* noop */ },
+		}, docs);
+		process.stdout.write('Okay!\n');
+		return;
+	}
+	if (dest !== '' && !dest.endsWith('.rst')) {
+		throw new Error('Destination file must be either a ".rst" file, or an empty string (for printing to stdout)');
+	}
+	if (dest !== '') {
+		const f = fs.createWriteStream(dest);
+		generate(f, docs);
+	} else {
+		generate(process.stdout, docs);
+	}
+};

platform/javascript/package-lock.json

@@ -43,6 +43,12 @@
         }
       }
     },
+    "@babel/parser": {
+      "version": "7.13.4",
+      "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.13.4.tgz",
+      "integrity": "sha512-uvoOulWHhI+0+1f9L4BoozY7U5cIkZ9PgJqvb041d6vypgUmtVPG4vmGm4pSggjl8BELzvHyUeJSUyEMY6b+qA==",
+      "dev": true
+    },
     "@eslint/eslintrc": {
       "version": "0.1.3",
       "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.1.3.tgz",
@@ -202,6 +208,12 @@
       "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=",
       "dev": true
     },
+    "bluebird": {
+      "version": "3.7.2",
+      "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
+      "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==",
+      "dev": true
+    },
     "brace-expansion": {
       "version": "1.1.11",
       "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
@@ -218,6 +230,15 @@
       "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==",
       "dev": true
     },
+    "catharsis": {
+      "version": "0.8.11",
+      "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.8.11.tgz",
+      "integrity": "sha512-a+xUyMV7hD1BrDQA/3iPV7oc+6W26BgVJO05PGEoatMyIuPScQKsde6i3YorWX1qs+AZjnJ18NqdKoCtKiNh1g==",
+      "dev": true,
+      "requires": {
+        "lodash": "^4.17.14"
+      }
+    },
     "chalk": {
       "version": "4.1.0",
       "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
@@ -362,6 +383,12 @@
         "ansi-colors": "^4.1.1"
       }
     },
+    "entities": {
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz",
+      "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==",
+      "dev": true
+    },
     "error-ex": {
       "version": "1.3.2",
       "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz",
@@ -925,6 +952,51 @@
         "esprima": "^4.0.0"
       }
     },
+    "js2xmlparser": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.1.tgz",
+      "integrity": "sha512-KrPTolcw6RocpYjdC7pL7v62e55q7qOMHvLX1UCLc5AAS8qeJ6nukarEJAF2KL2PZxlbGueEbINqZR2bDe/gUw==",
+      "dev": true,
+      "requires": {
+        "xmlcreate": "^2.0.3"
+      }
+    },
+    "jsdoc": {
+      "version": "3.6.6",
+      "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.6.6.tgz",
+      "integrity": "sha512-znR99e1BHeyEkSvgDDpX0sTiTu+8aQyDl9DawrkOGZTTW8hv0deIFXx87114zJ7gRaDZKVQD/4tr1ifmJp9xhQ==",
+      "dev": true,
+      "requires": {
+        "@babel/parser": "^7.9.4",
+        "bluebird": "^3.7.2",
+        "catharsis": "^0.8.11",
+        "escape-string-regexp": "^2.0.0",
+        "js2xmlparser": "^4.0.1",
+        "klaw": "^3.0.0",
+        "markdown-it": "^10.0.0",
+        "markdown-it-anchor": "^5.2.7",
+        "marked": "^0.8.2",
+        "mkdirp": "^1.0.4",
+        "requizzle": "^0.2.3",
+        "strip-json-comments": "^3.1.0",
+        "taffydb": "2.6.2",
+        "underscore": "~1.10.2"
+      },
+      "dependencies": {
+        "escape-string-regexp": {
+          "version": "2.0.0",
+          "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz",
+          "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==",
+          "dev": true
+        },
+        "mkdirp": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+          "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+          "dev": true
+        }
+      }
+    },
     "json-schema-traverse": {
       "version": "0.4.1",
       "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
@@ -946,6 +1018,15 @@
         "minimist": "^1.2.0"
       }
     },
+    "klaw": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz",
+      "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==",
+      "dev": true,
+      "requires": {
+        "graceful-fs": "^4.1.9"
+      }
+    },
     "levn": {
       "version": "0.4.1",
       "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
@@ -956,6 +1037,15 @@
         "type-check": "~0.4.0"
       }
     },
+    "linkify-it": {
+      "version": "2.2.0",
+      "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz",
+      "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==",
+      "dev": true,
+      "requires": {
+        "uc.micro": "^1.0.1"
+      }
+    },
     "load-json-file": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz",
@@ -984,6 +1074,37 @@
       "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==",
       "dev": true
     },
+    "markdown-it": {
+      "version": "10.0.0",
+      "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz",
+      "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==",
+      "dev": true,
+      "requires": {
+        "argparse": "^1.0.7",
+        "entities": "~2.0.0",
+        "linkify-it": "^2.0.0",
+        "mdurl": "^1.0.1",
+        "uc.micro": "^1.0.5"
+      }
+    },
+    "markdown-it-anchor": {
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-5.3.0.tgz",
+      "integrity": "sha512-/V1MnLL/rgJ3jkMWo84UR+K+jF1cxNG1a+KwqeXqTIJ+jtA8aWSHuigx8lTzauiIjBDbwF3NcWQMotd0Dm39jA==",
+      "dev": true
+    },
+    "marked": {
+      "version": "0.8.2",
+      "resolved": "https://registry.npmjs.org/marked/-/marked-0.8.2.tgz",
+      "integrity": "sha512-EGwzEeCcLniFX51DhTpmTom+dSA/MG/OBUDjnWtHbEnjAH180VzUeAw+oE4+Zv+CoYBWyRlYOTR0N8SO9R1PVw==",
+      "dev": true
+    },
+    "mdurl": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
+      "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=",
+      "dev": true
+    },
     "minimatch": {
       "version": "3.0.4",
       "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
@@ -1287,6 +1408,15 @@
       "integrity": "sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q==",
       "dev": true
     },
+    "requizzle": {
+      "version": "0.2.3",
+      "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.3.tgz",
+      "integrity": "sha512-YanoyJjykPxGHii0fZP0uUPEXpvqfBDxWV7s6GKAiiOsiqhX6vHNyW3Qzdmqp/iq/ExbhaGbVrjB4ruEVSM4GQ==",
+      "dev": true,
+      "requires": {
+        "lodash": "^4.17.14"
+      }
+    },
     "resolve": {
       "version": "1.17.0",
       "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz",
@@ -1513,6 +1643,12 @@
         "string-width": "^3.0.0"
       }
     },
+    "taffydb": {
+      "version": "2.6.2",
+      "resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
+      "integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=",
+      "dev": true
+    },
     "text-table": {
       "version": "0.2.0",
       "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
@@ -1546,6 +1682,18 @@
       "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==",
       "dev": true
     },
+    "uc.micro": {
+      "version": "1.0.6",
+      "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
+      "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==",
+      "dev": true
+    },
+    "underscore": {
+      "version": "1.10.2",
+      "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.10.2.tgz",
+      "integrity": "sha512-N4P+Q/BuyuEKFJ43B9gYuOj4TQUHXX+j2FqguVOpjkssLUUrnJofCcBccJSCoeturDoZU6GorDTHSvUDlSQbTg==",
+      "dev": true
+    },
     "uri-js": {
       "version": "4.4.0",
       "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.0.tgz",
@@ -1600,6 +1748,12 @@
       "requires": {
         "mkdirp": "^0.5.1"
       }
+    },
+    "xmlcreate": {
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.3.tgz",
+      "integrity": "sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==",
+      "dev": true
     }
   }
 }

platform/javascript/package.json

@@ -5,20 +5,24 @@
   "description": "Linting setup for Godot's HTML5 platform code",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "npm run lint:engine && npm run lint:libs && npm run lint:modules",
+    "docs": "jsdoc --template js/jsdoc2rst/ js/engine/engine.js js/engine/config.js --destination ''",
+    "lint": "npm run lint:engine && npm run lint:libs && npm run lint:modules && npm run lint:tools",
     "lint:engine": "eslint \"js/engine/*.js\" --no-eslintrc -c .eslintrc.engine.js",
     "lint:libs": "eslint \"js/libs/*.js\" --no-eslintrc -c .eslintrc.libs.js",
     "lint:modules": "eslint \"../../modules/**/*.js\" --no-eslintrc -c .eslintrc.libs.js",
-    "format": "npm run format:engine && npm run format:libs && npm run format:modules",
+    "lint:tools": "eslint \"js/jsdoc2rst/**/*.js\" --no-eslintrc -c .eslintrc.engine.js",
+    "format": "npm run format:engine && npm run format:libs && npm run format:modules && npm run format:tools",
     "format:engine": "npm run lint:engine -- --fix",
     "format:libs": "npm run lint:libs -- --fix",
-    "format:modules": "npm run lint:modules -- --fix"
+    "format:modules": "npm run lint:modules -- --fix",
+    "format:tools": "npm run lint:tools -- --fix"
   },
   "author": "Godot Engine contributors",
   "license": "MIT",
   "devDependencies": {
     "eslint": "^7.9.0",
     "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.22.0"
+    "eslint-plugin-import": "^2.22.0",
+    "jsdoc": "^3.6.6"
   }
 }