feat: add rule check-indentation

Author: vulkd

src/index.js

@@ -1,5 +1,6 @@
 /* eslint-disable import/max-dependencies */
 import checkExamples from './rules/checkExamples';
+import checkIndentation from './rules/checkIndentation';
 import checkParamNames from './rules/checkParamNames';
 import checkTagNames from './rules/checkTagNames';
 import checkTypes from './rules/checkTypes';
@@ -24,6 +25,7 @@ export default {
     recommended: {
       rules: {
         'jsdoc/check-examples': 'off',
+        'jsdoc/check-indentation': 'off',
         'jsdoc/check-param-names': 'warn',
         'jsdoc/check-tag-names': 'warn',
         'jsdoc/check-types': 'warn',
@@ -47,6 +49,7 @@ export default {
   },
   rules: {
     'check-examples': checkExamples,
+    'check-indentation': checkIndentation,
     'check-param-names': checkParamNames,
     'check-tag-names': checkTagNames,
     'check-types': checkTypes,

src/rules/checkIndentation.js

@@ -0,0 +1,13 @@
+import iterateJsdoc from '../iterateJsdoc';
+
+export default iterateJsdoc(({
+  sourceCode,
+  jsdocNode,
+  report
+}) => {
+  const reg = new RegExp(/^[ \t]+\*[ \t]{2}/m);
+  const text = sourceCode.getText(jsdocNode);
+  if (reg.test(text)) {
+    report('There must be no indentation.');
+  }
+});

test/rules/assertions/checkIndentation.js

@@ -0,0 +1,37 @@
+export default {
+  invalid: [
+    {
+      code: `
+          /**
+           * foo
+           *
+           * @param bar
+           *  baz
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'There must be no indentation.'
+        }
+      ]
+    }
+  ],
+  valid: [
+    {
+      code: `
+          /**
+           * foo
+           *
+           * @param bar
+           * baz
+           */
+          function quux () {
+
+          }
+      `
+    }
+  ]
+};

test/rules/index.js

@@ -8,6 +8,7 @@ const ruleTester = new RuleTester();
 
 _.forEach([
   'check-examples',
+  'check-indentation',
   'check-param-names',
   'check-tag-names',
   'check-types',