dx: add JSDoc generation command in package.json

.gitignore

@@ -3,4 +3,5 @@
 /.vscode/
 /target/
 /logs/
-/dist/
+/dist/
+/docs/js/

README.md

@@ -126,6 +126,17 @@ Builds for macOS may not work on Windows/Linux and vice-versa.
 
 ---
 
+**Generate browsable JSDoc**
+
+```console
+> npm run jsdoc:generate
+```
+
+Useful to navigate quickly available functions in the UI's JS scripts.
+The generated docs will be available in `./docs/js/`.
+
+---
+
 ### Visual Studio Code
 
 All development of the launcher should be done using [Visual Studio Code][vscode].

app/assets/js/authmanager.js

@@ -232,7 +232,7 @@ async function fullMicrosoftAuthFlow(entryCode, authMode) {
  * 
  * @param {number} nowMs Current time milliseconds.
  * @param {number} epiresInS Expires in (seconds)
- * @returns 
+ * @returns {number} Expiration time in milliseconds
  */
 function calculateExpiryDate(nowMs, epiresInS) {
     return nowMs + ((epiresInS-10)*1000)

jsdoc.json

@@ -0,0 +1,12 @@
+{
+  "source": {
+    "include": ["."],
+    "exclude": ["node_modules", "docs", "dist"],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "opts": {
+    "recurse": true,
+    "destination": "./docs/js/"
+  }
+}

package.json

@@ -17,7 +17,8 @@
     "dist:win": "npm run dist -- -w",
     "dist:mac": "npm run dist -- -m",
     "dist:linux": "npm run dist -- -l",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "jsdoc:generate": "npx jsdoc -c jsdoc.json"
   },
   "engines": {
     "node": "22.x.x"
@@ -50,3 +51,4 @@
     "url": "git+https://github.com/dscalzi/HeliosLauncher.git"
   }
 }
+