From b86c07b69c6a23583954b41580494c0bfed2f23f Mon Sep 17 00:00:00 2001 From: Guo Yunhe Date: Fri, 14 Feb 2020 11:34:09 +0200 Subject: [PATCH] eslint-config-adidas-typescript: disable valid-jsdoc In TypeScript project, sometimes the function can explain itself very well and here is no need to document parameters and returns: ```ts /** * ID should only contain letters, numbers, dashes and dots */ export function validateId(id: string): boolean | undefined { if (id.length === 0) { return } const match = id.match(/[A-Za-z0-9\-.]*/) if (match && match.length && match[0] === id) { return true } return false } ``` --- packages/eslint-config-adidas-typescript/index.js | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/eslint-config-adidas-typescript/index.js b/packages/eslint-config-adidas-typescript/index.js index 06ff9ca..c1be945 100644 --- a/packages/eslint-config-adidas-typescript/index.js +++ b/packages/eslint-config-adidas-typescript/index.js @@ -22,6 +22,7 @@ module.exports = { 'no-useless-constructor': 'off', 'semi': 'off', 'space-before-function-paren': 'off', + 'valid-jsdoc': 'off', '@typescript-eslint/adjacent-overload-signatures': 'error', '@typescript-eslint/array-type': [ 'error', { readonly: 'generic', default: 'generic' }], '@typescript-eslint/await-thenable': 'error',