chore: upgrade aegir and fix linting (#552)

Author: achingbrain

package.json

@@ -63,7 +63,7 @@
     "temp-write": "^4.0.0"
   },
   "devDependencies": {
-    "aegir": "^26.0.0",
+    "aegir": "^28.0.2",
     "benchmark": "^2.1.4",
     "go-ipfs": "^0.7.0",
     "husky": "^4.2.5",

src/endpoint/server.browser.js

@@ -3,14 +3,15 @@
 
 /**
  * Creates an instance of Server.
+ *
  * @class
  */
 class Server {
   /**
-   * @constructor
+   * @class
    * @param {Object} options
    * @param {number} [options.port=43134] - Server port.
-   * @param {function} createNode
+   * @param {Function} createNode
    */
   constructor (options, createNode) {
     options = options || { port: 43134 }
@@ -34,7 +35,6 @@ class Server {
   /**
    * Stop the server
    *
-   * @param {object} [options] - {@link https://hapi.dev/api/?v=18.4.0#-await-serverstopoptions Hapi docs}
    * @returns {Promise}
    */
   stop () {

src/endpoint/server.js

@@ -5,14 +5,15 @@ const routes = require('./routes')
 
 /**
  * Creates an instance of Server.
+ *
  * @class
  */
 class Server {
   /**
-   * @constructor
+   * @class
    * @param {Object} options
    * @param {number} [options.port=43134] - Server port.
-   * @param {function} createFactory
+   * @param {Function} createFactory
    */
   constructor (options = { port: 43134, host: 'localhost' }, createFactory) {
     this.options = options

src/factory.js

@@ -56,7 +56,7 @@ class Factory {
    *
    * @param {ControllerOptions} options - Controller type
    *
-   * @returns {Promise<String>}
+   * @returns {Promise<string>}
    */
   async tmpDir (options) {
     options = merge(this.opts, options)
@@ -98,6 +98,7 @@ class Factory {
 
   /**
    * Spawn an IPFSd Controller
+   *
    * @param {ControllerOptions} options
    * @returns {Promise<ControllerDaemon>}
    */
@@ -149,6 +150,7 @@ class Factory {
 
   /**
    * Stop all controllers
+   *
    * @returns {Promise<ControllerDaemon[]>}
    */
   async clean () {

src/index.js

@@ -54,6 +54,7 @@ module.exports = {
 
 /**
  * Same as https://github.com/ipfs/js-ipfs/blob/master/README.md#ipfs-constructor
+ *
  * @typedef {Object} IpfsOptions
  * @property {string|Object} [repo] - The file path at which to store the IPFS node’s data. Alternatively, you can set up a customized storage system by providing an ipfs.Repo instance.
  * @property {boolean|Object} [init=true] - Initialize the repo when creating the IPFS node. Instead of a boolean, you may provide an object with custom initialization options. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionsinit
@@ -65,7 +66,7 @@ module.exports = {
  * @property {object} [EXPERIMENTAL] - Enable and configure experimental features. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionsexperimental Default: `{ ipnsPubsub: false, sharding: false }`
  * @property  {object} [config] - Modify the default IPFS node config. This object will be merged with the default config; it will not replace it. The default config is documented in the js-ipfs config file docs. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionsconfig
  * @property {object} [ipld] - Modify the default IPLD config. This object will be merged with the default config; it will not replace it. Check IPLD docs for more information on the available options. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionsipld
- * @property {object|function} [libp2p] - The libp2p option allows you to build your libp2p node by configuration, or via a bundle function. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionslibp2p
+ * @property {object | Function} [libp2p] - The libp2p option allows you to build your libp2p node by configuration, or via a bundle function. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionslibp2p
  * @property {object} [connectionManager] - Configure the libp2p connection manager. https://github.com/ipfs/js-ipfs/blob/master/README.md#optionsconnectionmanager
  * @property {boolean} [offline=false] - Run the node offline.
  */
@@ -75,7 +76,7 @@ module.exports = {
  * @property {boolean} [test=false] - Flag to activate custom config for tests.
  * @property {boolean} [remote] - Use remote endpoint to spawn the controllers. Defaults to `true` when not in node.
  * @property {string} [endpoint] - Endpoint URL to manage remote Controllers. (Defaults: 'http://localhost:43134').
- * @property {Boolean} [disposable=true] - A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits.
+ * @property {boolean} [disposable=true] - A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits.
  * @property {string} [type] - The daemon type, see below the options:
  * - go - spawn go-ipfs daemon node
  * - js - spawn js-ipfs daemon node
@@ -84,10 +85,10 @@ module.exports = {
  * @property {Array} [args] - Custom cli args.
  * @property {Object} [ipfsHttpModule] - Reference to a IPFS HTTP Client object.
  * @property {Object} [ipfsModule] - Reference to a IPFS API object.
- * @property {String} [ipfsBin] - Path to a IPFS exectutable.
+ * @property {string} [ipfsBin] - Path to a IPFS exectutable.
  * @property {IpfsOptions} [ipfsOptions] - Options for the IPFS node.
  * @property {boolean} [forceKill] - Whether to use SIGKILL to quit a daemon that does not stop after `.stop()` is called. (default true)
- * @property {Number} [forceKillTimeout] - How long to wait before force killing a daemon in ms. (default 5000)
+ * @property {number} [forceKillTimeout] - How long to wait before force killing a daemon in ms. (default 5000)
  */
 
 /**

src/ipfsd-client.js

@@ -14,11 +14,12 @@ const daemonLog = {
 
 /**
  * Controller for remote nodes
+ *
  * @class
  */
 class Client {
   /**
-   * @constructor
+   * @class
    * @param {string} baseUrl
    * @param {Object} remoteState
    * @param {ControllerOptions} options
@@ -184,7 +185,7 @@ class Client {
   /**
    * Get the version of ipfs
    *
-   * @returns {Promise<String>}
+   * @returns {Promise<string>}
    */
   async version () {
     const req = await http.get(

src/ipfsd-daemon.js

@@ -27,12 +27,13 @@ function translateError (err) {
 
 /**
  * Controller for daemon nodes
+ *
  * @class
  *
  */
 class Daemon {
   /**
-   * @constructor
+   * @class
    * @param {ControllerOptions} [opts]
    */
   constructor (opts) {
@@ -153,7 +154,7 @@ class Daemon {
   /**
    * Start the daemon.
    *
-   * @return {Promise<Daemon>}
+   * @returns {Promise<Daemon>}
    */
   async start () {
     const args = ['daemon']
@@ -227,7 +228,7 @@ class Daemon {
   /**
    * Stop the daemon.
    *
-   * @return {Promise<Daemon>}
+   * @returns {Promise<Daemon>}
    */
   async stop () {
     if (!this.started) {
@@ -270,7 +271,7 @@ class Daemon {
   /**
    * Get the pid of the `ipfs daemon` process.
    *
-   * @returns {Promise<Number>}
+   * @returns {Promise<number>}
    */
   pid () {
     if (this.subprocess) {
@@ -286,7 +287,7 @@ class Daemon {
    *
    * @private
    * @param {string} [key] - A specific config to retrieve.
-   * @returns {Promise<Object|String>}
+   * @returns {Promise<Object | string>}
    */
   async _getConfig (key = 'show') {
     const {
@@ -331,7 +332,7 @@ class Daemon {
   /**
    * Get the version of ipfs
    *
-   * @returns {Promise<String>}
+   * @returns {Promise<string>}
    */
   async version () {
     const {

src/utils.browser.js

@@ -11,6 +11,7 @@ const deleteDb = (path) => {
 
 /**
  * close repoPath , repoPath/keys, repoPath/blocks and repoPath/datastore
+ *
  * @param {string} repoPath
  */
 const removeRepo = async (repoPath) => {