From 5d2ece9b8fb18ee6864755a645427901a025f60d Mon Sep 17 00:00:00 2001 From: Edie Lemoine Date: Tue, 5 Jan 2021 13:41:18 +0100 Subject: [PATCH] fix(jsdoc): improve preferred types --- src/configurations/plugins/jsdoc.js | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/src/configurations/plugins/jsdoc.js b/src/configurations/plugins/jsdoc.js index 7b70e37..351da0d 100644 --- a/src/configurations/plugins/jsdoc.js +++ b/src/configurations/plugins/jsdoc.js @@ -1,15 +1,30 @@ +const arrayPreferredType = { + 'message': 'Please define a type explicitly. Example: String[]', +}; + module.exports = { 'settings': { 'jsdoc': { 'preferredTypes': { - 'Integer': 'Number', - 'boolean': 'Boolean', - 'integer': 'Number', - 'number' : 'Number', - 'object' : 'Object', - 'string' : 'String', + 'Array' : arrayPreferredType, + 'Array.<>': '[]', + 'Array<>' : '[]', + 'Integer' : 'Number', + 'Promise' : 'Promise<*>', + 'array' : 'Array', + 'boolean' : 'Boolean', + 'event' : 'Event', + 'integer' : 'Number', + 'number' : 'Number', + 'object' : 'Object', + 'promise' : 'Promise', + 'string' : 'String', + '*' : { + 'message': 'Type * is not allowed. Please define a type explicitly.', + }, }, 'tagNamePreference': { + 'TODO' : 'todo', 'arg' : 'param', 'argument': 'param', 'link' : 'see',