From 7d6595e42aa65f6f39e739ddc7dd1518888a9b8f Mon Sep 17 00:00:00 2001 From: Ruslan Kabalin Date: Tue, 22 Mar 2022 20:31:14 +0000 Subject: [PATCH] MDL-74301 eslint: Refactor jsdoc rules. Adding 'plugin:promise/recommended' results in 5k+ jsdoc warnings most of which includes missing return and naming preferences (e.g. 'returns' over 'return' or 'string' over 'String'). This needs to be audited and addressed seprately. --- .eslintrc | 54 ++++++++++++++---------------------------------------- 1 file changed, 14 insertions(+), 40 deletions(-) diff --git a/.eslintrc b/.eslintrc index ac74a7d7f64..182ef246313 100644 --- a/.eslintrc +++ b/.eslintrc @@ -262,46 +262,20 @@ 'promise/avoid-new': 'off', // === JSDocs === - "jsdoc/check-access": [ - 'error', - ], - "jsdoc/check-alignment": 1, // Recommended. - "jsdoc/check-param-names": [ - 'error', - ], - "jsdoc/check-property-names": [ - 'error', - ], - "jsdoc/empty-tags": [ - 'error', - ], - "jsdoc/implements-on-classes": [ - 'error', - ], - "jsdoc/multiline-blocks": [ - 'error', - ], - "jsdoc/require-jsdoc": [ - 'error', - ], - "jsdoc/require-param": [ - 'error', - ], - "jsdoc/require-param-name": [ - 'error', - ], - "jsdoc/require-param-type": [ - 'error', - ], - "jsdoc/require-property": [ - 'error', - ], - "jsdoc/require-property-name": [ - 'error', - ], - "jsdoc/require-property-type": [ - 'error', - ], + 'jsdoc/check-access': 'error', + 'jsdoc/check-alignment': 1, // Recommended. + 'jsdoc/check-param-names': 'error', + 'jsdoc/check-property-names': 'error', + 'jsdoc/empty-tags': 'error', + 'jsdoc/implements-on-classes': 'error', + 'jsdoc/multiline-blocks': 'error', + 'jsdoc/require-jsdoc': 'error', + 'jsdoc/require-param': 'error', + 'jsdoc/require-param-name': 'error', + 'jsdoc/require-param-type': 'error', + 'jsdoc/require-property': 'error', + 'jsdoc/require-property-name': 'error', + 'jsdoc/require-property-type': 'error' }, parserOptions: { 'sourceType': 'module',