fix(jsdoc): improve preferred types

myparcelnl · Jan 5, 2021 · 5d2ece9 · 5d2ece9
1 parent dd64aba
commit 5d2ece9
Showing 1 changed file with 21 additions and 6 deletions.
diff --git 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',