feat: type check & generate defs from jsdoc

.travis.yml

@@ -64,6 +64,7 @@ jobs:
         - npm run build -- $RUN_SINCE --scope={ipfs,ipfs-http-client,ipfs-message-port-*}
         - npm run dep-check -- $RUN_SINCE -- -- -- -i electron-webrtc
         - npm run lint -- $RUN_SINCE --concurrency 1
+        - npm run check -- $RUN_SINCE --concurrency 1
 
     - stage: test
       name: chrome

packages/ipfs-http-client/src/add-all.js

@@ -9,7 +9,6 @@ const anySignal = require('any-signal')
 const AbortController = require('abort-controller').default
 
 module.exports = configure((api) => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../ipfs/src/core/components/add-all').AddAll<import('.').HttpOptions>}
    */

packages/ipfs-http-client/src/add.js

@@ -8,15 +8,13 @@ const configure = require('./lib/configure')
  * @typedef {import("./lib/core").ClientOptions} ClientOptions
  */
 
-// eslint-disable-next-line valid-jsdoc
 /**
  * @param {ClientOptions} options
  */
 module.exports = (options) => {
   const all = addAll(options)
 
   return configure(() => {
-    // eslint-disable-next-line valid-jsdoc
     /**
      * @type {import('../../ipfs/src/core/components/add').Add<import('.').HttpOptions>}
      */

packages/ipfs-http-client/src/bitswap/stat.js

@@ -6,7 +6,6 @@ const configure = require('../lib/configure')
 const toUrlSearchParams = require('../lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/bitswap/stat').Stat<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/bitswap/unwant.js

@@ -5,7 +5,6 @@ const configure = require('../lib/configure')
 const toUrlSearchParams = require('../lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/bitswap/unwant').Unwant<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/bitswap/wantlist-for-peer.js

@@ -5,7 +5,6 @@ const configure = require('../lib/configure')
 const toUrlSearchParams = require('../lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/bitswap/wantlist-for-peer').WantlistForPeer<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/bitswap/wantlist.js

@@ -5,7 +5,6 @@ const configure = require('../lib/configure')
 const toUrlSearchParams = require('../lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/bitswap/wantlist').WantlistFn<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/block/get.js

@@ -6,7 +6,6 @@ const configure = require('../lib/configure')
 const toUrlSearchParams = require('../lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/block/get').BlockGet<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/block/put.js

@@ -10,7 +10,6 @@ const anySignal = require('any-signal')
 const AbortController = require('abort-controller').default
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../../ipfs/src/core/components/block/put').BlockPut<import('..').HttpOptions>}
    */

packages/ipfs-http-client/src/id.js

@@ -6,7 +6,6 @@ const configure = require('./lib/configure')
 const toUrlSearchParams = require('./lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../ipfs/src/core/components/id').Id<import('.').HttpOptions>}
    */

packages/ipfs-http-client/src/index.js

@@ -22,7 +22,6 @@ const urlSource = require('ipfs-utils/src/files/url-source')
  * @property {(format: string) => Promise<any>} [ipld.loadFormat] - an async function that takes the name of an [IPLD format](https://github.com/ipld/interface-ipld-format) as a string and should return the implementation of that codec
  */
 
-// eslint-disable-next-line valid-jsdoc
 /**
  * @param {ClientOptions} options
  */

packages/ipfs-http-client/src/resolve.js

@@ -4,7 +4,6 @@ const configure = require('./lib/configure')
 const toUrlSearchParams = require('./lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../ipfs/src/core/components/resolve').Resolve<import('.').HttpOptions>}
    */

packages/ipfs-http-client/src/version.js

@@ -5,7 +5,6 @@ const configure = require('./lib/configure')
 const toUrlSearchParams = require('./lib/to-url-search-params')
 
 module.exports = configure(api => {
-  // eslint-disable-next-line valid-jsdoc
   /**
    * @type {import('../../ipfs/src/core/components/version').Version<import('.').HttpOptions>}
    */

packages/ipfs/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "ipfs",
+  "rules": {
+    "jsdoc/no-undefined-types": 0
+  }
+}

packages/ipfs/package.json

@@ -35,7 +35,9 @@
   },
   "scripts": {
     "lint": "aegir lint",
-    "build": "aegir build",
+    "build": "npm run build:bundle && npm run build:types",
+    "build:bundle": "aegir build",
+    "build:types": "tsc --emitDeclarationOnly --declarationDir dist",
     "test": "aegir test",
     "test:node": "aegir test -t node",
     "test:browser": "aegir test -t browser",
@@ -193,7 +195,16 @@
     "stream-to-promise": "^3.0.0",
     "string-argv": "^0.3.1",
     "temp-write": "^4.0.0",
-    "wrtc": "^0.4.4"
+    "wrtc": "^0.4.4",
+    "typescript": "4.0.2",
+    "eslint-config-ipfs": "git://github.com/gozala/eslint-config-ipfs#default"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ]
+    }
   },
   "optionalDependencies": {
     "prom-client": "^12.0.0",
@@ -348,4 +359,4 @@
     "Максим Ильин <negamaxi@gmail.com>",
     "Xmader <xmader@outlook.com>"
   ]
-}
+}

packages/ipfs/src/cli/commands/block/put.js

@@ -2,6 +2,8 @@
 
 const fs = require('fs')
 const multibase = require('multibase')
+/** @type {typeof import('it-concat').default} */
+// @ts-ignore - it-contact has invalid type defs for commonjs
 const concat = require('it-concat')
 const { cidToString } = require('../../../utils/cid')
 const parseDuration = require('parse-duration').default

packages/ipfs/src/cli/commands/bootstrap/rm.js

@@ -1,8 +1,5 @@
 'use strict'
 
-const debug = require('debug')
-const log = debug('cli:bootstrap')
-log.error = debug('cli:bootstrap:error')
 const parseDuration = require('parse-duration').default
 
 module.exports = {

packages/ipfs/src/cli/commands/config/profile/apply.js

@@ -27,7 +27,7 @@ module.exports = {
       timeout
     })
     const delta = JSONDiff.diff(diff.original, diff.updated)
-    const res = JSONDiff.formatters.console.format(delta, diff.original)
+    const res = delta && JSONDiff.formatters.console.format(delta, diff.original)
 
     if (res) {
       print(res)

packages/ipfs/src/cli/commands/config/show.js

@@ -1,8 +1,5 @@
 'use strict'
 
-const debug = require('debug')
-const log = debug('cli:config')
-log.error = debug('cli:config:error')
 const parseDuration = require('parse-duration').default
 
 module.exports = {

packages/ipfs/src/cli/commands/daemon.js

@@ -57,7 +57,7 @@ module.exports = {
     if (argv.initConfig) {
       try {
         const raw = fs.readFileSync(argv.initConfig)
-        config = JSON.parse(raw)
+        config = JSON.parse(raw.toString())
       } catch (error) {
         debug(error)
         throw new Error('Default config couldn\'t be found or content isn\'t valid JSON.')
@@ -83,12 +83,15 @@ module.exports = {
 
     try {
       await daemon.start()
+      // @ts-ignore - _httpApi is possibly undefined
       daemon._httpApi._apiServers.forEach(apiServer => {
         print(`API listening on ${apiServer.info.ma}`)
       })
+      // @ts-ignore - _httpApi is possibly undefined
       daemon._httpApi._gatewayServers.forEach(gatewayServer => {
         print(`Gateway (read only) listening on ${gatewayServer.info.ma}`)
       })
+      // @ts-ignore - _httpApi is possibly undefined
       daemon._httpApi._apiServers.forEach(apiServer => {
         print(`Web UI available at ${toUri(apiServer.info.ma)}/webui`)
       })

packages/ipfs/src/cli/commands/dag/put.js

@@ -4,6 +4,8 @@ const mh = require('multihashing-async').multihash
 const multibase = require('multibase')
 const dagCBOR = require('ipld-dag-cbor')
 const dagPB = require('ipld-dag-pb')
+/** @type {typeof import('it-concat').default} */
+// @ts-ignore - incorrect typedefs
 const concat = require('it-concat')
 const CID = require('cids')
 const { cidToString } = require('../../../utils/cid')

packages/ipfs/src/cli/commands/get.js

@@ -3,7 +3,7 @@
 const fs = require('fs')
 const path = require('path')
 const toIterable = require('stream-to-it')
-const pipe = require('it-pipe')
+const { pipe } = require('it-pipe')
 const { map } = require('streaming-iterables')
 const parseDuration = require('parse-duration').default
 

packages/ipfs/src/cli/commands/id.js

@@ -37,6 +37,6 @@ module.exports = {
       return
     }
 
-    print(JSON.stringify(id, '', 2))
+    print(JSON.stringify(id, null, 2))
   }
 }

packages/ipfs/src/cli/commands/init.js

@@ -56,7 +56,7 @@ module.exports = {
     if (argv.defaultConfig) {
       try {
         const raw = fs.readFileSync(argv.defaultConfig)
-        config = JSON.parse(raw)
+        config = JSON.parse(raw.toString())
       } catch (error) {
         debug(error)
         throw new Error('Default config couldn\'t be found or content isn\'t valid JSON.')

packages/ipfs/src/cli/commands/key/import.js

@@ -19,7 +19,7 @@ module.exports = {
       describe: 'Input PEM file',
       type: 'string',
       demandOption: true,
-      coerce: ('input', input => fs.readFileSync(input, 'utf8'))
+      coerce: input => fs.readFileSync(input, 'utf8')
     },
     timeout: {
       type: 'string',

packages/ipfs/src/cli/commands/object/patch/append-data.js

@@ -1,5 +1,7 @@
 'use strict'
 
+/** @type {typeof import('it-concat').default} */
+// @ts-ignore - incorrect type defs
 const concat = require('it-concat')
 const fs = require('fs')
 const multibase = require('multibase')

packages/ipfs/src/cli/commands/object/patch/set-data.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const fs = require('fs')
+/** @type {typeof import('it-concat').default} */
+// @ts-ignore - incorrect type defs
 const concat = require('it-concat')
 const multibase = require('multibase')
 const { cidToString } = require('../../../../utils/cid')

packages/ipfs/src/cli/commands/object/put.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const fs = require('fs')
+/** @type {typeof import('it-concat').default} */
+// @ts-ignore - incorrect type defs
 const concat = require('it-concat')
 const multibase = require('multibase')
 const { cidToString } = require('../../../utils/cid')

packages/ipfs/src/cli/commands/refs-local.js

@@ -23,7 +23,7 @@ module.exports = {
     }
   },
 
-  async handler ({ ctx: { ipfs, print }, timeout, cidBase, multihash }) {
+  async handler ({ ctx: { ipfs, print }, timeout, multihash }) {
     for await (const { ref, err } of ipfs.refs.local({
       timeout
     })) {

packages/ipfs/src/cli/commands/stats/bitswap.js

@@ -1,8 +1,9 @@
 'use strict'
 
 // This is an alias for `bitswap stat`.
-const bitswapStats = require('../bitswap/stat.js')
-// The command needs to be renamed, else it would be `stats stat` instead of
-// `stats bitswap`
-bitswapStats.command = 'bitswap'
+const bitswapStats = Object.assign(require('../bitswap/stat.js'), {
+  // The command needs to be renamed, else it would be `stats stat` instead of
+  // `stats bitswap`
+  command: 'bitswap'
+})
 module.exports = bitswapStats

packages/ipfs/src/cli/commands/swarm/addrs/local.js

@@ -1,8 +1,5 @@
 'use strict'
 
-const debug = require('debug')
-const log = debug('cli:object')
-log.error = debug('cli:object:error')
 const parseDuration = require('parse-duration').default
 
 module.exports = {

packages/ipfs/src/cli/daemon.js

@@ -21,6 +21,7 @@ class Daemon {
       const prometheusClient = require('prom-client')
       const prometheusGcStats = require('prometheus-gc-stats')
       const collectDefaultMetrics = prometheusClient.collectDefaultMetrics
+      // @ts-ignore - timeout isn't in typedefs
       collectDefaultMetrics({ timeout: 5000 })
       prometheusGcStats(prometheusClient.register)()
     }
@@ -42,7 +43,9 @@ class Daemon {
     this._httpApi = await httpApi.start()
 
     // for the CLI to know the where abouts of the API
+    // @ts-ignore - _apiServers is possibly undefined
     if (this._httpApi._apiServers.length) {
+      // @ts-ignore - _apiServers is possibly undefined
       await repo.apiAddr.set(this._httpApi._apiServers[0].info.ma)
     }
 
@@ -54,6 +57,7 @@ class Daemon {
     log('stopping')
     await Promise.all([
       this._httpApi && this._httpApi.stop(),
+      // @ts-ignore - may not have stop if init was false
       this._ipfs && this._ipfs.stop()
     ])
     log('stopped')
@@ -66,6 +70,7 @@ function getLibp2p ({ libp2pOptions, options, config, peerId }) {
   let electronWebRTC
   let wrtc
   try {
+    // @ts-ignore - cant find type info
     electronWebRTC = require('electron-webrtc')()
   } catch (err) {
     log('failed to load optional electron-webrtc dependency')
@@ -94,6 +99,7 @@ function getLibp2p ({ libp2pOptions, options, config, peerId }) {
     const delegateApiOptions = {
       host: delegateAddr.host,
       // port is a string atm, so we need to convert for the check
+      // @ts-ignore - parseInt(input:string) => number
       protocol: parseInt(delegateAddr.port) === 443 ? 'https' : 'http',
       port: delegateAddr.port
     }

packages/ipfs/src/cli/utils.js

@@ -38,7 +38,7 @@ const print = (msg, includeNewline = true, isError = false) => {
 }
 
 print.clearLine = () => {
-  return process.stdout.clearLine()
+  return process.stdout.clearLine(0)
 }
 
 print.cursorTo = (pos) => {
@@ -92,6 +92,7 @@ async function getIpfs (argv) {
       start: false,
       pass: argv.pass
     })
+
     return {
       isDaemon: false,
       ipfs,