Renaming interface members and object shorthand property names

[normalser]

TypeScript Version: nightly (2.1.0-dev.20161102)

Code

interface Test {
    foo: string
}


function bar(): Test {
    const foo = 'foo'
    return { foo }
}

Rename foo on line 2 to foo2

Expected behavior:

interface Test {
    foo2: string
}


function bar(): Test {
    const foo = 'foo'
    return { foo2: foo }
}

Actual behavior:

interface Test {
    foo2: string
}


function bar(): Test {
    const foo = 'foo'
    return { foo2 } // <------- broken code
}

[mhegazy]

the problem is the RenameLocation interface returns to the IDE/Editor a list of rename locations; here you would need to send a list of edits as well. i.e. "foo" => "foo2: foo".

[normalser]

Then maybe this would be easier and still better:

interface Test {
    foo2: string
}


function bar(): Test {
    const foo2 = 'foo'  // <---- rename variable as well, so that next line is not broken
    return { foo2 }
}

[mhegazy]

that might be easier.

[ivan7237d]

Renaming variable wouldn't always work, right? Because if you rename only the foo in Test1:

interface Test1 {
  foo: string;
}

interface Test2 {
  foo: string;
}

function bar(): [Test1, Test2] {
  const foo = 'foo';
  return [{ foo }, { foo }];
}

this should end up looking not like this

interface Test1 {
  foo2: string;
}

interface Test2 {
  foo: string;
}

function bar(): [Test1, Test2] {
  const foo2 = 'foo';
  return [{ foo2 }, { foo2 }];
}

but like this:

interface Test1 {
  foo2: string;
}

interface Test2 {
  foo: string;
}

function bar(): [Test1, Test2] {
  const foo = 'foo';
  return [{ foo2: foo }, { foo }];
}

I thought renaming was pretty safe until I came across this issue... but on the bright side, typechecks should normally catch the errors.

[dgreensp]

Because of this bug, renaming an interface member typically produces incorrect code, from what I've seen. It's almost enough to make me mistrust the "rename symbol" feature... but is this basically the only glaring bug, in people's experience?

[clarkio]

Adding @TimFerrell who also shared this feedback which shows up in Visual Studio Code

[TimFerrell]

Correct, this issue applies to Javascript as well.

[clarkio]

Yes and the refactoring in VS code is driven by TypeScript under the hood. I think once this issue is addressed here in TypeScript it will also address the similar issue you noticed around the refactor features in the editor.

[thorn0]

IMHO. this issue should be labeled as a bug.

[zurfluh]

I stumbled a few times because of this bug. I have seen bugs in our code because of this. I would appreciate this being fixed.

[tmoran-stenoa]

It seems the bug is back on the latest VSCode version (Typescript 5.5.4):

Screen.Recording.2024-12-23.at.10.52.37.PM.mov

"About VSCode" details:

Version: 1.96.1 (Universal)
Commit: 42b266171e51a016313f47d0c48aca9295b9cbb2
Date: 2024-12-17T17:50:05.206Z
Electron: 32.2.6
ElectronBuildId: 10629634
Chromium: 128.0.6613.186
Node.js: 20.18.1
V8: 12.8.374.38-electron.0
OS: Darwin arm64 23.5.0

[RyanCavanaugh]

@tmoran-stenoa likely you have the "Use aliases for renames" option set wrong

[tmoran-stenoa]

@RyanCavanaugh You're right, it was off, works well now that it's enabled. Thank you so much!!