Rename autofix introduces errors when name is used as a shorthand property

[bradzacher]

🔎 Search Terms

rename autofix object shorthand property

🕗 Version & Regression Information

• This is the behavior in every version I tried

⏯ Playground Link

https://www.typescriptlang.org/play?#code/FA4MwVwOwYwFwJYHsoAIxKQCgJQC5UBvVABwCckSBTMuATwIGc4yEoBzVAXyOFX9QwUzUhWq06qALyoARLIDcfAWSpwIZNIWUCB5SjXoAaHdyVdgQA

💻 Code

function foo(): { property: string } {
    const property = "";
    return {
        property,
    };
}

🙁 Actual behavior

Screen.Recording.2023-08-14.at.13.16.38.mov

🙂 Expected behavior

When autofix renaming a type property it should consider shorthands and fix appropriately so that it can avoid introducing type errors due to incorrect naming.

  function foo(): { property: string } {
                    ^^^^^^^^ rename to property2
      const property = "";
      return {
-         property,
+         property2: property,
      };
  }

  function foo(): { property: string } {
      const property = "";
            ^^^^^^^^ rename to property2
      return {
-         property,
+         property: property2,
      };
  }

Optionally, it could be extended to be (hugely more complex) for some cases:

  function foo(): { property: string } {
                    ^^^^^^^^ rename to property2
-     const property = "";
+     const property2 = "";
      return {
-         property,
+         property2,
      };
  }

[RyanCavanaugh]

It sounds like you have this option disabled

[bradzacher]

That is the default configuration - the screen recording was taken from the playground.

It seems counter-intuitive to me that the default config refactors to broken code.

[RyanCavanaugh]

It might also seem counter-intuitive that renaming a local identifier should cause a runtime behavior change. But both can't be true (or false) at once.

See #29238 (comment)

[bradzacher]

I'm not quite sure I understand - how is this a runtime behaviour change?

  return {
-   prop,
+   prop: prop2,
  };

The shorthand assignment is syntactic sugar isn't it? So this change has no observable runtime side-effect.

I understand that renaming the prop does have runtime side-effects - which is the intent behind the refactor. But renaming a variable and using the long-hand property assignment to maintain the existing property name doesn't, right?

[typescript-bot]

This issue has been marked as "Question" and has seen no recent activity. It has been automatically closed for house-keeping purposes.