Merge pull request #18256 from timvandermeij/jsdoc-reproducible

Implement reproducibility for the JSDoc builds
mozilla · Jun 16, 2024 · ee94391 · ee94391
2 parents f8acd33 + 9d00025
commit ee94391
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 9 deletions.
diff --git a/gulpfile.mjs b/gulpfile.mjs
@@ -1526,18 +1526,10 @@ gulp.task("jsdoc", function (done) {
   console.log();
   console.log("### Generating documentation (JSDoc)");
 
-  const JSDOC_FILES = ["src/display/api.js"];
-
   fs.rmSync(JSDOC_BUILD_DIR, { recursive: true, force: true });
   fs.mkdirSync(JSDOC_BUILD_DIR, { recursive: true });
 
-  const command =
-    '"node_modules/.bin/jsdoc" -d ' +
-    JSDOC_BUILD_DIR +
-    " " +
-    JSDOC_FILES.join(" ");
-
-  exec(command, done);
+  exec('"node_modules/.bin/jsdoc" -c jsdoc.json', done);
 });
 
 gulp.task("types", function (done) {

diff --git a/jsdoc.json b/jsdoc.json
@@ -0,0 +1,13 @@
+{
+  "source": {
+    "include": ["src/display/api.js"]
+  },
+  "opts": {
+    "destination": "build/jsdoc/"
+  },
+  "templates": {
+    "default": {
+      "includeDate": false
+    }
+  }
+}