improved JSDoc and fixed ts-ignore highlighted earlier

Author: Pfed-prog

src/auto-launch.js

@@ -95,6 +95,7 @@ module.exports = async function () {
       logger.error(`[launch on startup] ${err.toString()}`)
 
       if (feedback) {
+        // @ts-ignore
         recoverableErrorDialog(err, {
           title: i18n.t('launchAtLoginFailed.title'),
           message: i18n.t('launchAtLoginFailed.message')

src/dialogs/dialog.js

@@ -3,6 +3,23 @@ const i18n = require('i18next')
 const { IS_MAC } = require('../common/consts')
 const dock = require('../utils/dock')
 
+/**
+ * @typedef {object} MessageBoxOptions
+ * @property {string} title
+ * @property {string} message
+ * @property {'none'|'info'|'error'|'question'|'warning'} [type='info']
+ * @property {boolean} [showDock=true]
+ * @property {string[]} [buttons]
+ * @property {boolean} [noLink]
+ */
+
+/**
+ * Show a message box with the specified options.
+ *
+ * @param {MessageBoxOptions} options
+ * @returns {number}
+ */
+
 // NOTE: always send the buttons in the order [OK, Cancel, ...Actions].
 // See this post for more interesting information about the topic:
 // https://medium.muz.li/ok-key-and-cancel-key-which-one-should-be-set-up-on-the-left-4780e86c16eb
@@ -12,40 +29,23 @@ module.exports = function ({
     i18n.t('cancel')
   ], ...opts
 }) {
+  const isInverse = !IS_MAC
+  const defaultId = isInverse ? buttons.length - 1 : 0
+  const cancelId = isInverse ? buttons.length - 2 : 1
+
   const options = {
     type,
-    buttons,
+    buttons: isInverse ? buttons.reverse() : buttons,
     noLink: true,
+    title: IS_MAC ? undefined : title,
+    message: IS_MAC ? title : message,
+    detail: IS_MAC ? message : undefined,
+    default: buttons.length > 1 ? defaultId : undefined,
+    cancelId: buttons.length > 1 ? cancelId : undefined,
     ...opts
   }
 
-  if (IS_MAC) {
-    // @ts-ignore
-    options.message = title
-    // @ts-ignore
-    options.detail = message
-  } else {
-    // @ts-ignore
-    options.title = title
-    // @ts-ignore
-    options.message = message
-  }
-
-  const isInverse = !IS_MAC
-
-  if (isInverse) {
-    options.buttons.reverse()
-  }
-
-  if (buttons.length > 1) {
-    // @ts-ignore
-    options.defaultId = isInverse ? buttons.length - 1 : 0
-    // @ts-ignore
-    options.cancelId = isInverse ? buttons.length - 2 : 1
-  }
-
   if (showDock) { dock.show() }
-  // @ts-ignore
   const selected = dialog.showMessageBoxSync(options)
   if (showDock) { dock.hide() }
 

src/dialogs/errors.js

@@ -99,10 +99,16 @@ function criticalErrorDialog (e) {
 // Shows a recoverable error dialog with the default title and message.
 // Passing an options object alongside the error can be used to override
 // the title and message.
+/**
+ * Displays a recoverable error dialog with the specified title and message.
+ *
+ * @param {any} e - The error object.
+ * @param {{title?: string; message?: string; type?: string;}} options - The options for the error dialog.
+ */
 function recoverableErrorDialog (e, options) {
   const cfg = {
-    title: i18n.t('recoverableErrorDialog.title'),
-    message: i18n.t('recoverableErrorDialog.message'),
+    title: options.title ? options.title : i18n.t('recoverableErrorDialog.title'),
+    message: options.message ? options.message : i18n.t('recoverableErrorDialog.message'),
     type: 'error',
     buttons: [
       i18n.t('close'),
@@ -111,16 +117,7 @@ function recoverableErrorDialog (e, options) {
     ]
   }
 
-  if (options) {
-    if (options.title) {
-      cfg.title = options.title
-    }
-
-    if (options.message) {
-      cfg.message = options.message
-    }
-  }
-
+  // @ts-ignore
   const option = dialog(cfg)
 
   if (option === 1) {

src/i18n.js

@@ -29,7 +29,7 @@ module.exports = async function () {
         loadPath: join(__dirname, '../assets/locales/{{lng}}.json')
       }
     },
-    (err, t) => {
+    (err) => {
       if (err) {
         /**
          * even if an error occurs here, i18n still may work properly.

src/protocol-handlers.js

@@ -2,11 +2,19 @@ const { app, shell } = require('electron')
 const toUri = require('multiaddr-to-uri')
 const getCtx = require('./context')
 
+/**
+ * @param {string} protocol
+ * @param {string} part
+ * @param {string} base
+ */
 function openLink (protocol, part, base) {
   shell.openExternal(`${base}/${protocol}/${part}`)
   return true
 }
 
+/**
+ * @param {{ toString: () => string | string[]; encapsulate: (arg0: string) => any; }} addr
+ */
 function parseAddr (addr) {
   return toUri(addr.toString().includes('/http') ? addr : addr.encapsulate('/http'))
 }

src/run-gc.js

@@ -63,6 +63,7 @@ module.exports = function runGarbageCollector () {
     } catch (err) {
       // @ts-ignore
       logger.error(`[run gc] ${err.stack}`)
+      // @ts-ignore
       recoverableErrorDialog(err, {
         title: i18n.t('runGarbageCollectorErrored.title'),
         message: i18n.t('runGarbageCollectorErrored.message')

src/tray.js

@@ -18,6 +18,10 @@ const runGarbageCollector = require('./run-gc')
 const { SHORTCUT: SCREENSHOT_SHORTCUT, takeScreenshot } = require('./take-screenshot')
 const createToggler = require('./utils/create-toggler')
 
+/**
+ * @param {string} key
+ * @param {string} label
+ */
 function buildCheckbox (key, label) {
   return {
     id: key,

src/webui/index.js

@@ -1,4 +1,3 @@
-// @ts-check
 const { join } = require('path')
 const { performance } = require('perf_hooks')
 const { URL } = require('url')
@@ -22,6 +21,11 @@ const openExternal = require('./open-external')
 
 serve({ scheme: 'webui', directory: join(__dirname, '../../assets/webui') })
 
+/**
+ * @typedef {object} Ipfsd
+ * @property {string} apiAddr
+ */
+
 /**
  *
  * @returns {BrowserWindow}
@@ -49,8 +53,7 @@ const createWindow = () => {
     }
   })
 
-  // @ts-ignore
-  window.webContents.once('did-start-loading', (event) => {
+  window.webContents.once('did-start-loading', () => {
     const msg = '[web ui] loading'
     const webContentLoad = logger.start(msg, { withAnalytics: analyticsKeys.WEB_UI_READY })
     window.webContents.once('did-finish-load', () => {
@@ -61,8 +64,8 @@ const createWindow = () => {
       webContentLoad.fail(`${msg}: ${errorDescription}, code: ${errorCode}`)
     })
   })
-  // @ts-ignore
-  window.webContents.once('dom-ready', async (event) => {
+
+  window.webContents.once('dom-ready', async () => {
     const endTime = performance.now()
     try {
       const dur = getSecondsSinceAppStart(endTime)
@@ -73,8 +76,7 @@ const createWindow = () => {
         dur
       })
     } catch (err) {
-      // @ts-ignore
-      logger.error(err)
+      logger.error(String(err))
     }
   })
 
@@ -155,7 +157,7 @@ module.exports = async function () {
   url.hash = '/blank'
   url.searchParams.set('deviceId', await ctx.getProp('countlyDeviceId'))
 
-  ctx.setProp('launchWebUI', async (path, { focus = true, forceRefresh = false } = {}) => {
+  ctx.setProp('launchWebUI', async (/** @type {string} */ path, { focus = true, forceRefresh = false } = {}) => {
     if (window.isDestroyed()) {
       logger.error(`[web ui] window is destroyed, not launching web ui with ${path}`)
       return
@@ -184,12 +186,12 @@ module.exports = async function () {
   const getIpfsd = ctx.getFn('getIpfsd')
   let ipfsdStatus = null
   ipcMain.on(ipcMainEvents.IPFSD, async (status) => {
+    /** @type {Ipfsd} */
+    // @ts-ignore
     const ipfsd = await getIpfsd(true)
     ipfsdStatus = status
 
-    // @ts-ignore
     if (ipfsd && ipfsd.apiAddr !== apiAddress) {
-      // @ts-ignore
       apiAddress = ipfsd.apiAddr
       url.searchParams.set('api', apiAddress.toString())
       updateLanguage()
@@ -200,7 +202,7 @@ module.exports = async function () {
   // Set user agent
   session.defaultSession.webRequest.onBeforeSendHeaders((details, callback) => {
     details.requestHeaders['User-Agent'] = `ipfs-desktop/${VERSION} (Electron ${ELECTRON_VERSION})`
-    callback({ cancel: false, requestHeaders: details.requestHeaders }) // eslint-disable-line
+    callback({ cancel: false, requestHeaders: details.requestHeaders })
   })
 
   const launchWebUI = ctx.getFn('launchWebUI')
@@ -230,8 +232,7 @@ module.exports = async function () {
       splashScreen.destroy()
     } catch (err) {
       logger.error('[web ui] failed to hide splash screen')
-      // @ts-ignore
-      logger.error(err)
+      logger.error(String(err))
     }
   }