fix(prefer-find-by): handle different spacing correctly for autofix (#472)

* fix(prefer-find-by): stop prefer-find-by fixer to break code when no spaces before bracket

* fix(prefer-find-by): use regex to add findByMethod

Co-authored-by: Marat Dyatko <[email protected]>
Co-authored-by: Mario Beltrán Alarcón <[email protected]>

Author: dyatko

Diff for: lib/rules/prefer-find-by.ts

@@ -464,10 +464,10 @@ export default createTestingLibraryRule<Options, MessageIds>({
               const textDestructuring = sourceCode.getText(
                 allVariableDeclarations
               );
-              const text = `${textDestructuring.substring(
-                0,
-                textDestructuring.length - 2
-              )}, ${findByMethod} }`;
+              const text = textDestructuring.replace(
+                /(\s*})$/,
+                `, ${findByMethod}$1`
+              );
               allFixes.push(fixer.replaceText(allVariableDeclarations, text));
             }
 

Diff for: tests/lib/rules/prefer-find-by.test.ts

@@ -457,6 +457,35 @@ ruleTester.run(RULE_NAME, rule, {
         })
       `,
     })),
+    ...createScenario((waitMethod: string, queryMethod: string) => ({
+      code: `
+        import {${waitMethod}} from '@testing-library/foo';
+        it('tests', async () => {
+          const {${queryMethod}} = render()
+          const submitButton = await ${waitMethod}(() => expect(${queryMethod}('foo', { name: 'baz' })).not.toBeNull())
+        })
+      `,
+      errors: [
+        {
+          messageId: 'preferFindBy',
+          data: {
+            queryVariant: getFindByQueryVariant(queryMethod),
+            queryMethod: queryMethod.split('By')[1],
+            prevQuery: queryMethod,
+            waitForMethodName: waitMethod,
+          },
+        },
+      ],
+      output: `
+        import {${waitMethod}} from '@testing-library/foo';
+        it('tests', async () => {
+          const {${queryMethod}, ${buildFindByMethod(queryMethod)}} = render()
+          const submitButton = await ${buildFindByMethod(
+            queryMethod
+          )}('foo', { name: 'baz' })
+        })
+      `,
+    })),
     ...createScenario((waitMethod: string, queryMethod: string) => ({
       code: `
         import {${waitMethod}} from '@testing-library/foo';