feat: add rule check-alignment

ref: Add jsdoc/comment-style-whitespace rule (ref #76)

Author: vulkd

src/index.js

@@ -1,4 +1,5 @@
 /* eslint-disable import/max-dependencies */
+import checkAlignment from './rules/checkAlignment';
 import checkExamples from './rules/checkExamples';
 import checkParamNames from './rules/checkParamNames';
 import checkTagNames from './rules/checkTagNames';
@@ -23,6 +24,7 @@ export default {
   configs: {
     recommended: {
       rules: {
+        'jsdoc/check-alignment': 'warn',
         'jsdoc/check-examples': 'off',
         'jsdoc/check-param-names': 'warn',
         'jsdoc/check-tag-names': 'warn',
@@ -46,6 +48,7 @@ export default {
     }
   },
   rules: {
+    'check-alignment': checkAlignment,
     'check-examples': checkExamples,
     'check-param-names': checkParamNames,
     'check-tag-names': checkTagNames,

src/rules/checkAlignment.js

@@ -0,0 +1,26 @@
+import iterateJsdoc from '../iterateJsdoc';
+
+export default iterateJsdoc(({
+  sourceCode,
+  jsdocNode,
+  report,
+  indent
+}) => {
+  // `indent` is whitespace from line 1 (`/**`), so slice and account for "/".
+  const indentLevel = indent.length + 1;
+  const sourceLines = sourceCode.getText(jsdocNode).split('\n')
+    .slice(1)
+    .map((line) => {
+      return line.split('*')[0];
+    })
+    .filter((line) => {
+      return !line.trim().length;
+    });
+
+  for (const line of sourceLines) {
+    if (line.length !== indentLevel) {
+      report('Expected JSDoc block to be aligned.');
+      break;
+    }
+  }
+});

test/rules/assertions/checkAlignment.js

@@ -0,0 +1,109 @@
+export default {
+  invalid: [
+    {
+      code: `
+        /**
+          * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block to be aligned.'
+        }
+      ]
+    },
+    {
+      code: `
+        /**
+         * @param {Number} foo
+          */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block to be aligned.'
+        }
+      ]
+    },
+    {
+      code: `
+         /**
+         * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block to be aligned.'
+        }
+      ]
+    },
+    {
+      code: `
+         /**
+          * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block to be aligned.'
+        }
+      ]
+    },
+    {
+      code: `
+       /**
+         * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          message: 'Expected JSDoc block to be aligned.'
+        }
+      ]
+    }
+  ],
+  valid: [
+    {
+      code: `
+        /**
+         * Desc
+         *
+         * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `
+    },
+    {
+      code: `
+        /**
+         * Desc
+         *
+         * @param {{
+          foo: Bar,
+          bar: Baz
+         * }} foo
+         *
+         */
+        function quux (foo) {
+
+        }
+      `
+    }
+  ]
+};

test/rules/index.js

@@ -7,6 +7,7 @@ import config from '../../src';
 const ruleTester = new RuleTester();
 
 _.forEach([
+  'check-alignment',
   'check-examples',
   'check-param-names',
   'check-tag-names',