feat(check-alignment): add fixer

Author: jasminexie

src/rules/checkAlignment.js

@@ -1,3 +1,4 @@
+import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
@@ -17,14 +18,28 @@ export default iterateJsdoc(({
       return !line.trim().length;
     });
 
+  const fix = (fixer) => {
+    const replacement = sourceCode.getText(jsdocNode).split('\n')
+      .map((line, index) => {
+        // Ignore the first line and all lines not starting with `*`
+        const ignored = !index || line.split('*')[0].trim().length;
+
+        return ignored ? line : indent + ' ' + _.trimStart(line);
+      })
+      .join('\n');
+
+    return fixer.replaceText(jsdocNode, replacement);
+  };
+
   for (const line of sourceLines) {
     if (line.length !== indentLevel) {
-      report('Expected JSDoc block to be aligned.');
+      report('Expected JSDoc block to be aligned.', fix);
       break;
     }
   }
 }, {
   meta: {
+    fixable: 'code',
     type: 'layout'
   }
 });

test/rules/assertions/checkAlignment.js

@@ -13,7 +13,15 @@ export default {
         {
           message: 'Expected JSDoc block to be aligned.'
         }
-      ]
+      ],
+      output: `
+        /**
+         * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `
     },
     {
       code: `
@@ -28,7 +36,15 @@ export default {
         {
           message: 'Expected JSDoc block to be aligned.'
         }
-      ]
+      ],
+      output: `
+        /**
+         * @param {Number} foo
+         */
+        function quux (foo) {
+
+        }
+      `
     },
     {
       code: `
@@ -43,7 +59,15 @@ export default {
         {
           message: 'Expected JSDoc block to be aligned.'
         }
-      ]
+      ],
+      output: `
+         /**
+          * @param {Number} foo
+          */
+        function quux (foo) {
+
+        }
+      `
     },
     {
       code: `
@@ -58,7 +82,15 @@ export default {
         {
           message: 'Expected JSDoc block to be aligned.'
         }
-      ]
+      ],
+      output: `
+         /**
+          * @param {Number} foo
+          */
+        function quux (foo) {
+
+        }
+      `
     },
     {
       code: `
@@ -73,7 +105,15 @@ export default {
         {
           message: 'Expected JSDoc block to be aligned.'
         }
-      ]
+      ],
+      output: `
+       /**
+        * @param {Number} foo
+        */
+        function quux (foo) {
+
+        }
+      `
     }
   ],
   valid: [