Skip to content

Commit

Permalink
Downgrade valid-jsdoc lint to warn
Browse files Browse the repository at this point in the history
  • Loading branch information
sisou committed Nov 17, 2024
1 parent 3c566d7 commit 98b7658
Show file tree
Hide file tree
Showing 18 changed files with 1 addition and 18 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
},
"ignore": ["constructor"]
}],
"valid-jsdoc": ["error", {
"valid-jsdoc": ["warn", {
"prefer": {
"arg": "param",
"argument": "param",
Expand Down
1 change: 0 additions & 1 deletion src/components/PasswordBox.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
*/

class PasswordBox extends Observable {
// eslint-disable-next-line valid-jsdoc
/**
* @param {?HTMLFormElement} [$el]
* @param {Partial<PasswordBoxOptions>} [options]
Expand Down
1 change: 0 additions & 1 deletion src/components/PasswordSetterBox.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
/* global TemplateTags */

class PasswordSetterBox extends Observable {
// eslint-disable-next-line valid-jsdoc
/**
* @param {?HTMLFormElement} [$el]
* @param {{bgColor?: string, buttonI18nTag?: string}} [options]
Expand Down
1 change: 0 additions & 1 deletion src/components/QrVideoScanner.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
/* global TemplateTags */

class QrVideoScanner extends Observable {
// eslint-disable-next-line valid-jsdoc
/**
* @param {?HTMLDivElement} [$el]
* @param {(result: string) => boolean} [validator]
Expand Down
1 change: 0 additions & 1 deletion src/lib/CookieStorage.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ class CookieStorage {
return !!CookieJar.readCookie(this._getChunkCookieName(name, 0, namespace));
}

// eslint-disable-next-line valid-jsdoc
/**
* @param {string} name
* @param {Uint8Array} data
Expand Down
1 change: 0 additions & 1 deletion src/lib/FiatApi.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Adapted and reduced version of FiatApi.ts from @nimiq/utils
// This file should also be updated whenever FiatApi.ts in @nimiq/utils is updated.
class FiatApi {
// eslint-disable-next-line valid-jsdoc
/**
* @param {Array<FiatApi.SupportedCryptoCurrency>} cryptoCurrencies
* @param {Array<FiatApi.SupportedFiatCurrency>} vsCurrencies
Expand Down
1 change: 0 additions & 1 deletion src/lib/I18n.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ class I18n { // eslint-disable-line no-unused-vars
static translateDom(dom = document.body, enforcedLanguage) {
const language = enforcedLanguage ? this.getClosestSupportedLanguage(enforcedLanguage) : this.language;

/* eslint-disable-next-line valid-jsdoc */ // Multi-line descriptions are not valid JSDoc, apparently
/**
* @param {string} tag
* @param {(element: HTMLElement, translation: string) => void} callback - callback(element, translation) for
Expand Down
1 change: 0 additions & 1 deletion src/lib/JsonUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ class JsonUtils {
return value;
}

/* eslint-disable-next-line valid-jsdoc */
/**
* @param {number} type
* @param {string} value
Expand Down
1 change: 0 additions & 1 deletion src/lib/Key.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ class Key {
return Key.deriveHash(input);
}

// eslint-disable-next-line valid-jsdoc
/**
* @param {unknown} other
* @returns {other is Key}
Expand Down
1 change: 0 additions & 1 deletion src/lib/KeyInfo.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ class KeyInfo {
return new KeyInfo(obj.id, obj.type, encrypted, obj.hasPin, defaultAddress);
}

// eslint-disable-next-line valid-jsdoc
/**
* @param {unknown} other
* @returns {other is KeyInfo}
Expand Down
1 change: 0 additions & 1 deletion src/lib/Observable.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ class Observable { // eslint-disable-line no-unused-vars
this._listeners = new Map();
}

// eslint-disable-next-line valid-jsdoc
/**
* @param {string} type
* @param {(...arg: any[]) => any} callback
Expand Down
1 change: 0 additions & 1 deletion src/lib/QrScanner.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ class QrScanner {
}
}

// eslint-disable-next-line valid-jsdoc
/**
* @param {HTMLVideoElement} video
* @param {(result: string) => any} onDecode
Expand Down
1 change: 0 additions & 1 deletion src/lib/RequestParser.js
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,6 @@ class RequestParser { // eslint-disable-line no-unused-vars
}
}

// eslint-disable-next-line valid-jsdoc
/**
* @template {boolean} T
* @param {any} address
Expand Down
1 change: 0 additions & 1 deletion src/lib/TemplateTags.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
class TemplateTags {
// Let typescript infer return value. (Seems to be impossible to declare it the right way in standard JSDoc)
// eslint-disable-next-line valid-jsdoc
/**
* @template {number} T
* @param {T} variableCount
Expand Down
1 change: 0 additions & 1 deletion src/lib/bitcoin/BitcoinRequestParserMixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
* @typedef {new (...args: any[]) => T} BitcoinRequestParserMixinConstructor;
*/

// eslint-disable-next-line valid-jsdoc
/**
* A mixin to add Bitcoin-related request parsers to a RequestParser class.
*
Expand Down
1 change: 0 additions & 1 deletion src/lib/polygon/PolygonRequestParserMixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
* @typedef {new (...args: any[]) => T} PolygonRequestParserMixinConstructor;
*/

// eslint-disable-next-line valid-jsdoc
/**
* A mixin to add Polygon-related request parsers to a RequestParser class.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ class SignPolygonTransactionApi extends PolygonRequestParserMixin(TopLevelApi) {
return parsedRequest;
}

// eslint-disable-next-line valid-jsdoc
/**
*
* @param {KeyguardRequest.PolygonTransactionInfo} request
Expand Down
1 change: 0 additions & 1 deletion src/request/sign-swap/SignSwapApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,6 @@ class SignSwapApi extends PolygonRequestParserMixin(BitcoinRequestParserMixin(To
return direction;
}

// eslint-disable-next-line valid-jsdoc
/**
*
* @param {Omit<KeyguardRequest.PolygonTransactionInfo, 'amount'>} request
Expand Down

0 comments on commit 98b7658

Please sign in to comment.