@qubit-ltd/jsdoc-theme 1.5.1 → 1.5.2

package/README.md

@@ -1,6 +1,6 @@
 # qubit-jsdoc-theme
 
-[![Stars](https://img.shields.io/github/stars/Haixing-Hu/qubit-jsdoc-theme)](https://github.com/Haixing-Hu/qubit-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/Haixing-Hu/qubit-jsdoc-theme)](https://github.com/Haixing-Hu/qubit-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-1.5.0-005bff) [![Issues Open](https://img.shields.io/github/issues/Haixing-Hu/qubit-jsdoc-theme)](https://github.com/Haixing-Hu/qubit-jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/Haixing-Hu/qubit-jsdoc-theme)](https://github.com/Haixing-Hu/qubit-jsdoc-theme/graphs/contributors) [![license](https://img.shields.io/github/license/Haixing-Hu/qubit-jsdoc-theme)](https://github.com/Haixing-Hu/qubit-jsdoc-theme/blob/master/LICENSE)
+[![Stars](https://img.shields.io/github/stars/qubit-ltd/jsdoc-theme)](https://github.com/qubit-ltd/jsdoc-theme) [![Fork](https://img.shields.io/github/forks/qubit-ltd/jsdoc-theme)](https://github.com/qubit-ltd/jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-1.5.0-005bff) [![Issues Open](https://img.shields.io/github/issues/qubit-ltd/jsdoc-theme)](https://github.com/qubit-ltd/jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/qubit-ltd/jsdoc-theme)](https://github.com/qubit-ltd/jsdoc-theme/graphs/contributors) [![license](https://img.shields.io/github/license/qubit-ltd/jsdoc-theme)](https://github.com/qubit-ltd/jsdoc-theme/blob/master/LICENSE)
 
 <br>
 
@@ -826,8 +826,8 @@ For the base theme changelog, see [clean-jsdoc-theme changelog](https://github.c
 ## Developing
 
 ```bash
-git clone https://github.com/Haixing-Hu/qubit-jsdoc-theme.git
-cd qubit-jsdoc-theme
+git clone https://github.com/qubit-ltd/jsdoc-theme.git
+cd jsdoc-theme
 npm install
 npm install jsdoc --no-save
 npm run build
@@ -844,7 +844,7 @@ This will generate demo documentation in the `output` folder.
 
 ## Contributing
 
-We welcome contributions! Please feel free to submit issues and pull requests on [GitHub](https://github.com/Haixing-Hu/qubit-jsdoc-theme).
+We welcome contributions! Please feel free to submit issues and pull requests on [GitHub](https://github.com/qubit-ltd/jsdoc-theme).
 
 ## Acknowledgments
 
@@ -852,8 +852,8 @@ This project is based on the excellent [clean-jsdoc-theme](https://github.com/an
 
 ## Contributors
 
-<a href="https://github.com/Haixing-Hu/qubit-jsdoc-theme/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=Haixing-Hu/qubit-jsdoc-theme" alt="qubit-jsdoc-theme-contributors" />
+<a href="https://github.com/qubit-ltd/jsdoc-theme/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=qubit-ltd/jsdoc-theme" alt="qubit-jsdoc-theme-contributors" />
 </a>
 
 ## Thanks
@@ -862,7 +862,7 @@ Thanks to [fuse.js](https://fusejs.io/), [hljs](https://highlightjs.org/), [tipp
 
 ## Contact
 
-If you like this project, please give it a <a href="https://github.com/Haixing-Hu/qubit-jsdoc-theme" data-icon="octicon-star" aria-label="Star Haixing-Hu/qubit-jsdoc-theme on GitHub">star</a>.
+If you like this project, please give it a <a href="https://github.com/qubit-ltd/jsdoc-theme" data-icon="octicon-star" aria-label="Star qubit-ltd/jsdoc-theme on GitHub">star</a>.
 
 Mail: <a href="mailto:starfish.hu@gmail.com">starfish.hu@gmail.com</a> <br>
 

package/helpers/i18n.js

@@ -17,7 +17,7 @@ function loadTranslations(language) {
     __dirname,
     "..",
     "i18n",
-    `${language}.json`
+    `${language}.json`,
   );
 
   try {
@@ -29,7 +29,7 @@ function loadTranslations(language) {
   } catch (error) {
     console.warn(
       `Failed to load translations for language: ${language}`,
-      error.message
+      error.message,
     );
   }
   return false;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@qubit-ltd/jsdoc-theme",
-    "version": "1.5.1",
+    "version": "1.5.2",
     "description": "A customized JSDoc theme based on clean-jsdoc-theme, enhanced with properties table and constructor detection features for Qubit projects.",
     "main": "publish.js",
     "author": "Haixing Hu (starfish.hu@gmail.com)",
@@ -12,18 +12,16 @@
         "lint:style": "stylelint-config-prettier-check && stylelint static/styles/",
         "lint": "npm run lint:js && npm run lint:style",
         "prepublishOnly": "npm run lint && npm run build",
-        "deploy": "npm run lint && npm run build && npm publish --registry='https://npm.qubit.ltd/' --access public",
-        "deploy:public": "npm run lint && npm run build && npm publish --registry='https://registry.npmjs.org/' --access public",
-        "deploy:all": "npm run deploy && npm publish --registry='https://registry.npmjs.org/' --access public"
+        "deploy": "npm run lint && npm run build && npm publish --registry='https://registry.npmjs.org/' --access public"
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/Haixing-Hu/qubit-jsdoc-theme.git"
+        "url": "git+https://github.com/qubit-ltd/jsdoc-theme.git"
     },
     "bugs": {
-        "url": "https://github.com/Haixing-Hu/qubit-jsdoc-theme/issues"
+        "url": "https://github.com/qubit-ltd/jsdoc-theme/issues"
     },
-    "homepage": "https://github.com/Haixing-Hu/qubit-jsdoc-theme",
+    "homepage": "https://github.com/qubit-ltd/jsdoc-theme",
     "files": [
         "publish.js",
         "tmpl/**/*",
@@ -62,7 +60,7 @@
         "jsdoc": "^4.0.4",
         "postcss": "^8.5.6",
         "postcss-scss": "^4.0.9",
-        "prettier": "^2.2.1",
+        "prettier": "^3.3.3",
         "stylelint": "^14.9.1",
         "stylelint-config-prettier": "^9.0.3",
         "stylelint-config-sass-guidelines": "^9.0.0",

package/publish.js

@@ -153,7 +153,7 @@ function updateItemName(item) {
 
   if (attributes && attributes.length) {
     itemName = `${itemName}<span class="signature-attributes">${attributes.join(
-      ", "
+      ", ",
     )}</span>`;
   }
 
@@ -307,9 +307,9 @@ function prefixModuleToItemAnchor(item) {
         "a",
         modulename,
         methodname,
-        anchorLink
+        anchorLink,
       );
-    }
+    },
   );
 
   return prettyAnchor || anchor;
@@ -355,14 +355,14 @@ function generateSourceFiles(sourceFiles, packageInfo, encoding = "utf8") {
         kind: "source",
         title: sourceOutFile.replace(".html", ""),
         code: helper.htmlsafe(
-          fs.readFileSync(sourceFiles[file].resolved, encoding)
+          fs.readFileSync(sourceFiles[file].resolved, encoding),
         ),
       };
     } catch (e) {
       logger.error(
         "Error while generating source file %s: %s",
         file,
-        e.message
+        e.message,
       );
     }
 
@@ -371,7 +371,7 @@ function generateSourceFiles(sourceFiles, packageInfo, encoding = "utf8") {
       [source],
       sourceOutFile,
       false,
-      packageInfo
+      packageInfo,
     );
   });
 }
@@ -453,7 +453,7 @@ function buildSidebarMembers({
       if (!hasOwnProp.call(itemsSeen, item.longname)) {
         currentItem.anchor = linktoFn(
           item.longname,
-          item.name.replace(/^module:/, "")
+          item.name.replace(/^module:/, ""),
         );
 
         if (methods.length) {
@@ -721,7 +721,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
 
         if (
           example.match(
-            /^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i
+            /^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i,
           )
         ) {
           caption = RegExp.$1;
@@ -788,7 +788,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
     staticFilePaths =
       conf.default.staticFiles.include || conf.default.staticFiles.paths || [];
     staticFileFilter = new (require("jsdoc/src/filter").Filter)(
-      conf.default.staticFiles
+      conf.default.staticFiles,
     );
     staticFileScanner = new (require("jsdoc/src/scanner").Scanner)();
 
@@ -797,7 +797,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       const extraStaticFiles = staticFileScanner.scan(
         [filePath],
         10,
-        staticFileFilter
+        staticFileFilter,
       );
 
       extraStaticFiles.forEach((fileName) => {
@@ -866,7 +866,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
 
   // output pretty-printed source files by default
   outputSourceFiles = Boolean(
-    conf.default && conf.default.outputSourceFiles !== false
+    conf.default && conf.default.outputSourceFiles !== false,
   );
 
   // add template helpers
@@ -901,7 +901,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
   view.excludeInherited = Boolean(themeOpts.exclude_inherited);
   view.baseURL = getBaseURL(themeOpts);
   view.shouldRemoveScrollbarStyle = Boolean(
-    themeOpts.shouldRemoveScrollbarStyle
+    themeOpts.shouldRemoveScrollbarStyle,
   );
   attachModuleSymbols(find({ longname: { left: "module:" } }), members.modules);
 
@@ -926,7 +926,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       [{ kind: "globalobj" }],
       globalUrl,
       true,
-      packageInfo
+      packageInfo,
     );
   }
 
@@ -950,7 +950,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       .concat(includeFilesListInHomepage ? files : []),
     indexUrl,
     true,
-    packageInfo
+    packageInfo,
   );
 
   // set up the lists that we'll use to generate pages
@@ -975,7 +975,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myModules,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
 
@@ -985,7 +985,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myClasses,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
 
@@ -995,7 +995,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myNamespaces,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
 
@@ -1005,7 +1005,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myMixins,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
 
@@ -1015,7 +1015,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myExternals,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
 
@@ -1025,7 +1025,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
         myInterfaces,
         helper.longnameToUrl[longname],
         true,
-        packageInfo
+        packageInfo,
       );
     }
   });
@@ -1084,7 +1084,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       }
     } catch (error) {
       console.error(
-        "There was some error while creating search array for tutorial."
+        "There was some error while creating search array for tutorial.",
       );
       console.error(error);
     }
@@ -1096,7 +1096,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       generateTutorial(
         `Tutorial: ${child.title}`,
         child,
-        helper.tutorialToUrl(child.name)
+        helper.tutorialToUrl(child.name),
       );
       saveChildren(child);
     });
@@ -1113,7 +1113,7 @@ exports.publish = async function (taffyData, opts, tutorials) {
       path.join(outdir, "data", "search.json"),
       JSON.stringify({
         list: searchList,
-      })
+      }),
     );
   }
 };

package/static/scripts/core.js

@@ -179,7 +179,7 @@ function bringElementIntoView(element, updateHistory = true) {
     setTimeout(
       // eslint-disable-next-line no-undef
       () => tocbotInstance.updateTocListActiveElement(element),
-      60
+      60,
     );
   }
   var navbar = document.querySelector(".navbar-container");
@@ -431,7 +431,7 @@ function localUpdateFontSize(fontSize) {
   html.style.fontSize = fontSize + "px";
 
   var fontSizeText = document.querySelector(
-    "#b77a68a492f343baabea06fad81f651e"
+    "#b77a68a492f343baabea06fad81f651e",
   );
 
   if (fontSizeText) {
@@ -621,7 +621,7 @@ function highlightActiveLinkInSidebar() {
   if (!element) {
     try {
       element = document.querySelector(
-        `.sidebar a[href*='${targetURL.split("#")[0]}']`
+        `.sidebar a[href*='${targetURL.split("#")[0]}']`,
       );
     } catch (e) {
       console.error(e);

package/static/scripts/resize.js

@@ -11,7 +11,7 @@ var NAVBAR_OPTIONS = {};
   var mainSection = document.querySelector("#main");
   var localStorageResizeObject = JSON.parse(
     // eslint-disable-next-line no-undef
-    localStorage.getItem(NAVBAR_RESIZE_LOCAL_STORAGE_KEY)
+    localStorage.getItem(NAVBAR_RESIZE_LOCAL_STORAGE_KEY),
   );
 
   /**
@@ -66,7 +66,7 @@ var NAVBAR_OPTIONS = {};
       NAVBAR_RESIZE_LOCAL_STORAGE_KEY,
       JSON.stringify({
         width: navbar.style.width,
-      })
+      }),
     );
   }