Fix FP S2428 (prefer-object-literal): Ignore circular reference assignments (#427)

Co-authored-by: Ilia Kebets <[email protected]>

Author: yassin-kammoun-sonarsource

ruling/snapshots/prefer-object-literal

@@ -9,7 +9,6 @@ src/brackets/src/extensibility/ExtensionManager.js: 313
 src/brackets/src/extensions/default/HealthData/HealthDataManager.js: 53
 src/brackets/src/extensions/default/InlineColorEditor/ColorEditor.js: 557,570,582
 src/brackets/src/extensions/default/JavaScriptRefactoring/RefactoringUtils.js: 365
-src/jest/packages/pretty-format/perf/test.js: 182
 src/jquery/external/sinon/sinon.js: 4500
 src/reveal.js/plugin/search/search.js: 165
 src/spectrum/api/models/user.js: 407

src/rules/prefer-object-literal.ts

@@ -69,9 +69,8 @@ function checkObjectInitialization(
     const objectDeclaration = getObjectDeclaration(statements[index]);
     // eslint-disable-next-line sonarjs/no-collapsible-if
     if (objectDeclaration && isIdentifier(objectDeclaration.id)) {
-      if (
-        isPropertyAssignment(statements[index + 1], objectDeclaration.id, context.getSourceCode())
-      ) {
+      const nextStmt = statements[index + 1];
+      if (isPropertyAssignment(nextStmt, objectDeclaration.id, context.getSourceCode())) {
         context.report({ messageId: 'declarePropertiesInsideObject', node: objectDeclaration });
       }
     }
@@ -103,17 +102,29 @@ function isPropertyAssignment(
       return (
         !left.computed &&
         isSingleLineExpression(right, sourceCode) &&
-        areEquivalent(left.object, objectIdentifier, sourceCode)
+        areEquivalent(left.object, objectIdentifier, sourceCode) &&
+        !isCircularReference(left, right, sourceCode)
       );
     }
   }
   return false;
-}
 
-function isSingleLineExpression(expression: TSESTree.Expression, sourceCode: TSESLint.SourceCode) {
-  const first = sourceCode.getFirstToken(expression)!.loc;
-  const last = sourceCode.getLastToken(expression)!.loc;
-  return first.start.line === last.end.line;
+  function isSingleLineExpression(
+    expression: TSESTree.Expression,
+    sourceCode: TSESLint.SourceCode,
+  ) {
+    const first = sourceCode.getFirstToken(expression)!.loc;
+    const last = sourceCode.getLastToken(expression)!.loc;
+    return first.start.line === last.end.line;
+  }
+
+  function isCircularReference(
+    left: TSESTree.MemberExpression,
+    right: TSESTree.Expression,
+    sourceCode: TSESLint.SourceCode,
+  ) {
+    return areEquivalent(left.object, right, sourceCode);
+  }
 }
 
 export = rule;

tests/rules/prefer-object-literal.test.ts

@@ -75,6 +75,11 @@ ruleTester.run('prefer-literal', rule, {
     {
       code: `var x = {a: 2}; x.b = 5;`,
     },
+    {
+      code: `
+      const O = {};
+      O.self = O;`,
+    },
   ],
   invalid: [
     {