fix(check-alignment): handle zero indent; fixes gajus#1322

brettz9 · Oct 1, 2024 · 34866bc · 34866bc
1 parent 3b18435
commit 34866bc
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 1 deletion.
diff --git a/docs/rules/check-alignment.md b/docs/rules/check-alignment.md
@@ -110,6 +110,13 @@ class Foo {
   quux(a) {}
 }
 // Message: Expected JSDoc block to be aligned.
+
+export const myVar = {/**
+  * This is JSDoc
+  */
+  myProperty: 'hello'
+}
+// Message: Expected JSDoc block to be aligned.
 ````
 
 

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -1999,7 +1999,13 @@ const getIndentAndJSDoc = function (lines, jsdocNode) {
     /** @type {import('estree').SourceLocation} */
     (jsdocNode.loc).start.line - 1
   ];
-  const indnt = sourceLine.charAt(0).repeat(
+
+  let indentChar = sourceLine.charAt(0);
+  if (indentChar !== ' ' && indentChar !== '\t') {
+    indentChar = ' ';
+  }
+
+  const indnt = indentChar.repeat(
     /** @type {import('estree').SourceLocation} */
     (jsdocNode.loc).start.column,
   );

diff --git a/test/rules/assertions/checkAlignment.js b/test/rules/assertions/checkAlignment.js
@@ -236,6 +236,28 @@ function quux (foo) {
         }
       `,
     },
+    {
+      code: `
+export const myVar = {/**
+  * This is JSDoc
+  */
+  myProperty: 'hello'
+}
+`,
+      errors: [
+        {
+          line: 3,
+          message: 'Expected JSDoc block to be aligned.',
+        },
+      ],
+      output: `
+export const myVar = {/**
+                       * This is JSDoc
+                       */
+  myProperty: 'hello'
+}
+`,
+    },
   ],
   valid: [
     {