Integrated aegir as lint

pkgs/macos/build-universal-kubo-binary.js

@@ -42,7 +42,7 @@ const execLog = (cmd) => {
     await downloadKubo({
       version: kuboVersion,
       platform: 'darwin',
-      arch: arch,
+      arch,
       distUrl: 'https://dist.ipfs.tech',
       installPath: archDir
     })

src/add-to-ipfs.js

@@ -1,12 +1,12 @@
 const { extname, basename } = require('path')
 const { clipboard } = require('electron')
-const { globSource } = require('ipfs-http-client')
+const fs = require('fs-extra')
 const i18n = require('i18next')
+const { globSource } = require('ipfs-http-client')
 const last = require('it-last')
-const fs = require('fs-extra')
+const { analyticsKeys } = require('./analytics/keys')
 const logger = require('./common/logger')
 const { notify, notifyError } = require('./common/notify')
-const { analyticsKeys } = require('./analytics/keys')
 const getCtx = require('./context')
 
 async function copyFileToMfs (ipfs, cid, filename) {
@@ -90,7 +90,7 @@ async function addFileOrDirectory (ipfs, filepath) {
   let cid = null
 
   if (stat.isDirectory()) {
-    const files = globSource(filepath, '**/*', { recursive: true, cidVersion: 1 })
+    const files = globSource(filepath, '**/*')
     const res = await last(ipfs.addAll(files, {
       pin: false,
       wrapWithDirectory: true,
@@ -129,7 +129,7 @@ module.exports = async function (files) {
       const res = await addFileOrDirectory(ipfsd.api, file)
       successes.push(res)
     } catch (e) {
-      failures.push(e.toString())
+      failures.push(String(e))
     }
   }))
 

src/analytics/index.js

@@ -1,10 +1,9 @@
-// @ts-check
+const { existsSync, mkdirSync } = require('fs')
+const { join } = require('path')
 const Countly = require('countly-sdk-nodejs')
 const { ipcMain } = require('electron')
-const { COUNTLY_KEY } = require('../common/consts')
-const { join } = require('path')
 const { app } = require('electron')
-const { existsSync, mkdirSync } = require('fs')
+const { COUNTLY_KEY } = require('../common/consts')
 const ipcMainEvents = require('../common/ipc-main-events')
 const logger = require('../common/logger')
 const getCtx = require('../context')

src/analytics/keys.js

@@ -1,7 +1,6 @@
-// @ts-check
-
 /**
  * This should be an enum once we migrate to typescript
+ *
  * @readonly
  * @type {import('countly-sdk-nodejs').AnalyticsKeys}
  */

src/app-menu.js

@@ -68,6 +68,7 @@ if (process.platform === 'darwin') {
 
   // Edit menu
   template[1].submenu.push(
+    // @ts-ignore
     { type: 'separator' },
     {
       label: 'Speech',
@@ -90,6 +91,7 @@ if (process.platform === 'darwin') {
 
 module.exports = function () {
   logger.info('[appMenu] init...')
+  // @ts-ignore
   const menu = Menu.buildFromTemplate(template)
   Menu.setApplicationMenu(menu)
   logger.info('[appMenu] init done...')

src/auto-launch.js

@@ -1,16 +1,15 @@
-// @ts-check
-const { app } = require('electron')
-const i18n = require('i18next')
 const os = require('os')
 const path = require('path')
+const { app } = require('electron')
 const fs = require('fs-extra')
+const i18n = require('i18next')
 const untildify = require('untildify')
-const createToggler = require('./utils/create-toggler')
+const { AUTO_LAUNCH: CONFIG_KEY } = require('./common/config-keys')
+const { IS_MAC, IS_WIN } = require('./common/consts')
 const logger = require('./common/logger')
 const store = require('./common/store')
-const { IS_MAC, IS_WIN } = require('./common/consts')
-const { AUTO_LAUNCH: CONFIG_KEY } = require('./common/config-keys')
 const { showDialog, recoverableErrorDialog } = require('./dialogs')
+const createToggler = require('./utils/create-toggler')
 
 function isSupported () {
   const plat = os.platform()
@@ -79,7 +78,7 @@ module.exports = async function () {
       return false
     }
 
-    if (newValue === oldValue) return
+    if (newValue === oldValue) { return }
 
     try {
       if (newValue === true) {
@@ -92,7 +91,7 @@ module.exports = async function () {
 
       return true
     } catch (err) {
-      logger.error(`[launch on startup] ${err.toString()}`)
+      logger.error(`[launch on startup] ${String(err)}`)
 
       if (feedback) {
         recoverableErrorDialog(err, {
@@ -105,6 +104,7 @@ module.exports = async function () {
     }
   }
 
+  // @ts-ignore
   activate({ newValue: store.get(CONFIG_KEY, false) })
   createToggler(CONFIG_KEY, activate)
 }

src/auto-updater/index.js

@@ -1,14 +1,14 @@
 const { shell, app, BrowserWindow, Notification } = require('electron')
+const { ipcMain } = require('electron')
 const { autoUpdater } = require('electron-updater')
 const i18n = require('i18next')
-const { ipcMain } = require('electron')
-const logger = require('../common/logger')
-const { showDialog } = require('../dialogs')
+const CONFIG_KEYS = require('../common/config-keys')
 const { IS_MAC, IS_WIN, IS_APPIMAGE } = require('../common/consts')
 const ipcMainEvents = require('../common/ipc-main-events')
-const getCtx = require('../context')
+const logger = require('../common/logger')
 const store = require('../common/store')
-const CONFIG_KEYS = require('../common/config-keys')
+const getCtx = require('../context')
+const { showDialog } = require('../dialogs')
 
 function isAutoUpdateSupported () {
   if (store.get(CONFIG_KEYS.DISABLE_AUTO_UPDATE, false)) {
@@ -54,7 +54,7 @@ function setup () {
     try {
       await autoUpdater.downloadUpdate()
     } catch (err) {
-      logger.error(`[updater] ${err.toString()}`)
+      logger.error(`[updater] ${String(err)}`)
     }
 
     if (!feedback) {

src/automatic-gc.js

@@ -1,9 +1,9 @@
-const createToggler = require('./utils/create-toggler')
-const logger = require('./common/logger')
-const store = require('./common/store')
-const { AUTO_GARBAGE_COLLECTOR: CONFIG_KEY } = require('./common/config-keys')
 const { ipcMain } = require('electron')
+const { AUTO_GARBAGE_COLLECTOR: CONFIG_KEY } = require('./common/config-keys')
 const ipcMainEvents = require('./common/ipc-main-events')
+const logger = require('./common/logger')
+const store = require('./common/store')
+const createToggler = require('./utils/create-toggler')
 
 const gcFlag = '--enable-gc'
 const isEnabled = flags => flags.some(f => f === gcFlag)
@@ -36,7 +36,7 @@ function applyConfig (newFlags) {
 
 module.exports = async function () {
   const activate = ({ newValue, oldValue }) => {
-    if (newValue === oldValue) return
+    if (newValue === oldValue) { return }
 
     try {
       if (newValue === true) {
@@ -47,11 +47,12 @@ module.exports = async function () {
 
       return true
     } catch (err) {
-      logger.error(`[automatic gc] ${err.toString()}`)
+      logger.error(`[automatic gc] ${String(err)}`)
 
       return false
     }
   }
+  // @ts-ignore
   activate({ newValue: store.get(CONFIG_KEY, true) })
   createToggler(CONFIG_KEY, activate)
   logger.info(`[automatic gc] ${store.get(CONFIG_KEY, true) ? 'enabled' : 'disabled'}`)

src/common/config-keys.js

@@ -1,5 +1,6 @@
 /**
  * Configuration key constants for the features in IPFS Desktop.
+ *
  * @constant
  * @type {Record<import('../types').CONFIG_KEYS, string>}
  */
@@ -11,7 +12,8 @@ const CONFIG_KEYS = {
   OPEN_WEBUI_LAUNCH: 'openWebUIAtLaunch',
   MONOCHROME_TRAY_ICON: 'monochromeTrayIcon',
   EXPERIMENT_PUBSUB: 'experiments.pubsub',
-  EXPERIMENT_PUBSUB_NAMESYS: 'experiments.pubsubNamesys'
+  EXPERIMENT_PUBSUB_NAMESYS: 'experiments.pubsubNamesys',
+  AUTO_UPDATE: ''
 }
 
 module.exports = CONFIG_KEYS

src/common/logger.js

@@ -1,9 +1,8 @@
-// @ts-check
-const { createLogger, format, transports } = require('winston')
 const { join } = require('path')
-const { app } = require('electron')
 const { performance } = require('perf_hooks')
 const Countly = require('countly-sdk-nodejs')
+const { app } = require('electron')
+const { createLogger, format, transports } = require('winston')
 const { analyticsKeys } = require('../analytics/keys')
 
 /**
@@ -138,11 +137,11 @@ module.exports = Object.freeze({
     }
   },
 
-  warn: (msg, meta) => {
+  warn: (/** @type {string} */ msg, /** @type {import("winston").LogCallback} */ meta) => {
     logger.warn(msg, meta)
   },
 
-  debug: (msg) => {
+  debug: (/** @type {any} */ msg) => {
     logger.debug(msg)
   },
 

src/common/store.js

@@ -1,6 +1,5 @@
 const { app } = require('electron')
 const Store = require('electron-store')
-
 const logger = require('./logger')
 
 const { fileLogger } = logger

src/common/types.ts

@@ -1,12 +1,12 @@
 export interface DesktopPersistentStore_IpfsdConfig {
-  path: string,
+  path: string
   flags: string[]
 }
 
 export interface DesktopPersistentStore {
 
-  ipfsConfig: DesktopPersistentStore_IpfsdConfig,
-  language: string,
-  experiments: Record<string, boolean>,
+  ipfsConfig: DesktopPersistentStore_IpfsdConfig
+  language: string
+  experiments: Record<string, boolean>
   binaryPath?: string
 }

src/context.js

@@ -1,4 +1,3 @@
-// @ts-check
 const pDefer = require('p-defer')
 const logger = require('./common/logger')
 
@@ -11,9 +10,9 @@ const logger = require('./common/logger')
  * can set a property on the context and other modules can get that property from the context when they need it.
  *
  * Benefits:
- * * Avoid passing the same object to many different modules.
- * * Avoid circular dependencies and makes it easier to test modules in isolation.
- * * Speed up startup time by only loading what we need when we need it.
+ * Avoid passing the same object to many different modules.
+ * Avoid circular dependencies and makes it easier to test modules in isolation.
+ * Speed up startup time by only loading what we need when we need it.
  *
  *
  * | Context property exists? | Is the backing promise fulfilled? | Method called | Is a deferred promise created? | Returned Value                                                                                           |
@@ -26,18 +25,20 @@ const logger = require('./common/logger')
  * | Yes                      | Yes                               | SetProp       | No                             | We throw an error here. Any getProps called for the property prior to this would have a hanging promise. |
  *
  * @extends {Record<string, unknown>}
- * @property {function} launchWebUI
+ * @property {Function} launchWebUI
  */
 class Context {
   constructor () {
     /**
      * Stores prop->value mappings.
+     *
      * @type {Map<string|symbol, unknown>}
      */
     this._properties = new Map()
 
     /**
      * Stores prop->Promise mappings.
+     *
      * @type {Map<string|symbol, pDefer.DeferredPromise<unknown>>}
      */
     this._promiseMap = new Map()
@@ -63,12 +64,13 @@ class Context {
       this._properties.set(propertyName, value)
       this._resolvePropToValue(propertyName, value)
     } catch (e) {
-      logger.error(e)
+      logger.error(String(e))
     }
   }
 
   /**
    * Get the value of a property wrapped in a promise.
+   *
    * @template T
    * @param {ContextProperties} propertyName
    * @returns {Promise<T>}
@@ -93,6 +95,7 @@ class Context {
    * A simple helper to improve DX and UX when calling functions.
    *
    * This function allows you to request a function from AppContext without blocking until you actually need to call it.
+   *
    * @param {ContextProperties} propertyName
    * @returns {(...args: unknown[]) => Promise<unknown>}
    */
@@ -105,7 +108,7 @@ class Context {
         return await originalFn(...args)
       } catch (err) {
         logger.error(`[ctx] Error calling ${String(propertyName)}`)
-        logger.error(err)
+        logger.error(String(err))
         throw err
       }
     }

src/custom-ipfs-binary.js

@@ -1,10 +1,10 @@
-const i18n = require('i18next')
 const { app, dialog } = require('electron')
-const { showDialog } = require('./dialogs')
+const i18n = require('i18next')
 const logger = require('./common/logger')
 const store = require('./common/store')
-const dock = require('./utils/dock')
 const getCtx = require('./context')
+const { showDialog } = require('./dialogs')
+const dock = require('./utils/dock')
 
 const SETTINGS_KEY = 'binaryPath'