fix(eslint-plugin): [member-delimiter-style] autofixer result is not …

…as expected when comments after the delimiter with option `delimiter: 'none'` (#5029)
typescript-eslint · May 21, 2022 · ed7b5f6 · ed7b5f6
1 parent 9f3121b
commit ed7b5f6
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 deletions.
diff --git a/packages/eslint-plugin/src/rules/member-delimiter-style.ts b/packages/eslint-plugin/src/rules/member-delimiter-style.ts
@@ -35,6 +35,7 @@ interface MakeFixFunctionParams {
   optsNone: boolean;
   optsSemi: boolean;
   lastToken: LastTokenType;
+  commentsAfterLastToken: LastTokenType | undefined;
   missingDelimiter: boolean;
   lastTokenLine: string;
   isSingleLine: boolean;
@@ -74,10 +75,29 @@ const isLastTokenEndOfLine = (token: LastTokenType, line: string): boolean => {
   return positionInLine === line.length - 1;
 };
 
+const isCommentsEndOfLine = (
+  token: LastTokenType,
+  comments: LastTokenType | undefined,
+  line: string,
+): boolean => {
+  if (!comments) {
+    return false;
+  }
+
+  if (comments.loc.end.line > token.loc.end.line) {
+    return true;
+  }
+
+  const positionInLine = comments.loc.end.column;
+
+  return positionInLine === line.length;
+};
+
 const makeFixFunction = ({
   optsNone,
   optsSemi,
   lastToken,
+  commentsAfterLastToken,
   missingDelimiter,
   lastTokenLine,
   isSingleLine,
@@ -86,6 +106,7 @@ const makeFixFunction = ({
   if (
     optsNone &&
     !isLastTokenEndOfLine(lastToken, lastTokenLine) &&
+    !isCommentsEndOfLine(lastToken, commentsAfterLastToken, lastTokenLine) &&
     !isSingleLine
   ) {
     return null;
@@ -206,6 +227,10 @@ export default util.createRule<Options, MessageIds>({
         return;
       }
 
+      const commentsAfterLastToken = sourceCode
+        .getCommentsAfter(lastToken)
+        .pop();
+
       const sourceCodeLines = sourceCode.getLines();
       const lastTokenLine = sourceCodeLines[lastToken?.loc.start.line - 1];
 
@@ -255,6 +280,7 @@ export default util.createRule<Options, MessageIds>({
             optsNone,
             optsSemi,
             lastToken,
+            commentsAfterLastToken,
             missingDelimiter,
             lastTokenLine,
             isSingleLine: opts.type === 'single-line',

diff --git a/packages/eslint-plugin/tests/rules/member-delimiter-style.test.ts b/packages/eslint-plugin/tests/rules/member-delimiter-style.test.ts
@@ -3586,5 +3586,41 @@ type Foo = {
         },
       ],
     },
+    {
+      code: `
+type Foo = {
+  a: true; /** something */ /** some
+  thing */ b: true; /** something */ c: false; // something
+}
+      `,
+      output: `
+type Foo = {
+  a: true /** something */ /** some
+  thing */ b: true; /** something */ c: false // something
+}
+      `,
+      options: [
+        {
+          multiline: { delimiter: 'none' },
+        },
+      ],
+      errors: [
+        {
+          messageId: 'unexpectedSemi',
+          line: 3,
+          column: 11,
+        },
+        {
+          messageId: 'unexpectedSemi',
+          line: 4,
+          column: 20,
+        },
+        {
+          messageId: 'unexpectedSemi',
+          line: 4,
+          column: 47,
+        },
+      ],
+    },
   ],
 });