Merge pull request #244 from brettz9/meta.type

- Add `meta.type`

Author: brettz9

src/rules/checkAlignment.js

@@ -23,4 +23,8 @@ export default iterateJsdoc(({
       break;
     }
   }
+}, {
+  meta: {
+    type: 'layout'
+  }
 });

src/rules/checkExamples.js

@@ -188,9 +188,14 @@ export default iterateJsdoc(({
       );
     });
   });
-}, {returns: [
-  'ArrowFunctionExpression',
-  'ClassDeclaration',
-  'FunctionDeclaration',
-  'FunctionExpression'
-]});
+}, {
+  meta: {
+    type: 'suggestion'
+  },
+  returns: [
+    'ArrowFunctionExpression',
+    'ClassDeclaration',
+    'FunctionDeclaration',
+    'FunctionExpression'
+  ]
+});

src/rules/checkIndentation.js

@@ -11,4 +11,8 @@ export default iterateJsdoc(({
   if (reg.test(text)) {
     report('There must be no indentation.');
   }
+}, {
+  meta: {
+    type: 'layout'
+  }
 });

src/rules/checkParamNames.js

@@ -100,4 +100,8 @@ export default iterateJsdoc(({
   }
 
   validateParameterNamesDeep(targetTagName, jsdocParameterNamesDeep, report);
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/checkSyntax.js

@@ -14,4 +14,8 @@ export default iterateJsdoc(({
       break;
     }
   }
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/checkTagNames.js

@@ -24,6 +24,7 @@ export default iterateJsdoc(({
   });
 }, {
   meta: {
-    fixable: 'code'
+    fixable: 'code',
+    type: 'suggestion'
   }
 });

src/rules/checkTypes.js

@@ -61,6 +61,7 @@ export default iterateJsdoc(({
   });
 }, {
   meta: {
-    fixable: 'code'
+    fixable: 'code',
+    type: 'suggestion'
   }
 });

src/rules/implementsOnClasses.js

@@ -15,4 +15,8 @@ export default iterateJsdoc(({
   }
 
   report('@implements used on a non-constructor function');
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/matchDescription.js

@@ -49,4 +49,8 @@ export default iterateJsdoc(({
 
     return validateDescription(description, tag.tag);
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/newlineAfterDescription.js

@@ -55,6 +55,7 @@ export default iterateJsdoc(({
   }
 }, {
   meta: {
-    fixable: 'whitespace'
+    fixable: 'whitespace',
+    type: 'layout'
   }
 });

src/rules/noUndefinedTypes.js

@@ -77,4 +77,8 @@ export default iterateJsdoc(({
       }
     });
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireDescription.js

@@ -43,5 +43,6 @@ export default iterateJsdoc(({
     return noDefaults ?
       contexts :
       [...new Set([...defaultContexts, ...contexts])];
-  }
+  },
+  type: 'suggestion'
 });

src/rules/requireDescriptionCompleteSentence.js

@@ -128,6 +128,7 @@ export default iterateJsdoc(({
   });
 }, {
   meta: {
-    fixable: 'code'
+    fixable: 'code',
+    type: 'suggestion'
   }
 });

src/rules/requireExample.js

@@ -42,4 +42,8 @@ export default iterateJsdoc(({
       report('Missing JSDoc @' + targetTagName + ' description.');
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireHyphenBeforeParamDescription.js

@@ -45,6 +45,7 @@ export default iterateJsdoc(({
   });
 }, {
   meta: {
-    fixable: 'code'
+    fixable: 'code',
+    type: 'layout'
   }
 });

src/rules/requireParam.js

@@ -43,4 +43,8 @@ export default iterateJsdoc(({
 
     return false;
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireParamDescription.js

@@ -11,4 +11,8 @@ export default iterateJsdoc(({
       report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.', null, jsdocParameter);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireParamName.js

@@ -11,4 +11,8 @@ export default iterateJsdoc(({
       report('There must be an identifier after @param ' + (jsdocParameter.type === '' ? 'type' : 'tag') + '.', null, jsdocParameter);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireParamType.js

@@ -11,4 +11,8 @@ export default iterateJsdoc(({
       report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" type.', null, jsdocParameter);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireReturns.js

@@ -69,4 +69,8 @@ export default iterateJsdoc(({
   )) {
     report('Missing JSDoc @' + tagName + ' declaration.');
   }
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireReturnsCheck.js

@@ -43,4 +43,8 @@ export default iterateJsdoc(({
   if (utils.hasDefinedTypeReturnTag(tags[0]) && !utils.hasReturnValue()) {
     report('JSDoc @' + tagName + ' declaration present but return expression not available in function.');
   }
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireReturnsDescription.js

@@ -17,4 +17,8 @@ export default iterateJsdoc(({
       report('Missing JSDoc @' + targetTagName + ' description.', null, jsdocTag);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/requireReturnsType.js

@@ -11,4 +11,8 @@ export default iterateJsdoc(({
       report('Missing JSDoc @' + targetTagName + ' type.', null, jsdocTag);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });

src/rules/validTypes.js

@@ -46,4 +46,8 @@ export default iterateJsdoc(({
       validTypeParsing(tag.type);
     }
   });
+}, {
+  meta: {
+    type: 'suggestion'
+  }
 });