chore: use eslint-config-ipfs (#3287)

Gozala · achingbrain · web-flow · commit 916fe406dceb · 2020-10-06T13:00:13.000+01:00
Uses shared eslint config `eslint-config-ipfs` by integrating ipfs/aegir#638. Shared config uses new jsdoc plugin enabling use to remove bunch of `eslint-disable-next-line valid-jsdoc` comments. On the flip side it adds bit more requirements for structuring jsdoc comments. Most changes are generated automatically by eslint with `--fix` flag. This change also intentionally adds `.eslintrc` files to every package with content `{ "extends": "ipfs" }`, so that all the tools that support eslint pick up desired configuration. `eslint-config-ipfs` package itself isn't added to dependencies, because it gets installed as `aegir` dependency. Co-authored-by: achingbrain <alex@achingbrain.net>
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,3 @@
+{
+  "extends": "ipfs"
+}
diff --git a/package.json b/package.json
@@ -71,7 +71,7 @@
     "uint8arrays": "^1.1.0"
   },
   "devDependencies": {
-    "aegir": "^26.0.0",
+    "aegir": "^27.0.0",
     "cross-env": "^7.0.0",
     "go-ipfs": "^0.7.0",
     "interface-ipfs-core": "^0.140.0",
diff --git a/src/add-all.js b/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>}
    */
@@ -51,6 +50,7 @@ module.exports = configure((api) => {
  */
 
 /**
+ * @param {*} input
  * @returns {UnixFSEntry}
  */
 function toCoreInterface ({ name, hash, size, mode, mtime, mtimeNsecs }) {
diff --git a/src/add.js b/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>}
      */
diff --git a/src/bitswap/stat.js b/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>}
    */
diff --git a/src/bitswap/unwant.js b/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>}
    */
diff --git a/src/bitswap/wantlist-for-peer.js b/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>}
    */
diff --git a/src/bitswap/wantlist.js b/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>}
    */
diff --git a/src/block/get.js b/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>}
    */
diff --git a/src/block/put.js b/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>}
    */
diff --git a/src/id.js b/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>}
    */
diff --git a/src/index.js b/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
  */
diff --git a/src/lib/core.js b/src/lib/core.js
@@ -97,13 +97,13 @@ const parseTimeout = (value) => {
 
 /**
  * @typedef {Object} ClientOptions
- * @prop {string} [host]
- * @prop {number} [port]
- * @prop {string} [protocol]
- * @prop {Headers|Record<string, string>} [headers] - Request headers.
- * @prop {number|string} [timeout] - Amount of time until request should timeout in ms or humand readable. https://www.npmjs.com/package/parse-duration for valid string values.
- * @prop {string} [apiPath] - Path to the API.
- * @prop {URL|string} [url] - Full API URL.
+ * @property {string} [host]
+ * @property {number} [port]
+ * @property {string} [protocol]
+ * @property {Headers|Record<string, string>} [headers] - Request headers.
+ * @property {number|string} [timeout] - Amount of time until request should timeout in ms or humand readable. https://www.npmjs.com/package/parse-duration for valid string values.
+ * @property {string} [apiPath] - Path to the API.
+ * @property {URL|string} [url] - Full API URL.
  */
 
 class Client extends HTTP {
diff --git a/src/lib/to-url-search-params.js b/src/lib/to-url-search-params.js
@@ -4,7 +4,7 @@ const modeToString = require('./mode-to-string')
 const mtimeToObject = require('./mtime-to-object')
 
 /**
- * @param {object} params
+ * @param {*} params
  * @returns {URLSearchParams}
  */
 module.exports = ({ arg, searchParams, hashAlg, mtime, mode, ...options } = {}) => {
diff --git a/src/resolve.js b/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>}
    */
diff --git a/src/version.js b/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>}
    */
