Add opt-in user preference for prefix and suffix text on renames

[uniqueiniquity]

Fixes #28679
This PR adds a user preference which, if not set, returns the rename behavior on shorthand properties and import/export specifiers to its state in 3.1.

[amcasey]

this.getHostPreferences().usePrefixAndSuffixTextForRename || false [](start = 16, length = 66)

Since there may be multiple preferences affecting rename behavior (e.g. #28677), would it make more sense to pass in the entire preferences object (e.g. as in getEditsForFileRename)?

[uniqueiniquity]

Switched to passing entire preferences object.
However I only passed it as deep as this call; any deeper would require an API change, so I didn't want to do that unless absolutely necessary.

[sandersn]

Do you have a plan for when and how to remove this code? It's pretty ugly and I think it will only be needed for another 6 months or so. (Maybe more, depending on how long we ship new versions of TS to old versions of VS).

[amcasey]

@sandersn Don't we have to keep this until the newest version of VS without the opt-in is deprecated? I'm guessing that will be longer than 6 months.

[sandersn]

@amcasey Per our in-person discussion, we'll want to ship new TS servers to VS versions that shipped at least 2 years ago. (Plus we haven't done the work to make VS work with the new API anyway.)

[sandersn]

I take it you figured out how to make this work without changing getTypeAtLocation at all? If so, then sounds good. :)

[uniqueiniquity]

@sandersn yep, it was a red herring.

[uniqueiniquity]

@amcasey Can you take another look? I attempted to consolidate conditions like we discussed.

[amcasey]

        if (!(state.options.isForRename && (name.escapedText === InternalSymbolName.Default))) {

This is unaffected by the user preference?

---

Refers to: src/services/findAllReferences.ts:1092 in ad75ce7. [](commit_id = ad75ce7, deletion_comment = False)

[amcasey]

        if (addReferencesHere && !state.options.isForRename && state.markSeenReExportRHS(name)) {

This is unaffected by the user preference?

---

Refers to: src/services/findAllReferences.ts:1103 in ad75ce7. [](commit_id = ad75ce7, deletion_comment = False)

[amcasey]

Still a few questions but generally LGTM.

[weswigham]

Does this being a config setting mean it'll count as fixing #29238?

[amcasey]

@weswigham It means editors will have the option of exposing that as a setting but, arguably, it won't be fixed until they do.

[weswigham]

Since we've had a number of asks for #29238, we should try to make sure it's exposed as a setting in VS and VSCode, at least.

[uniqueiniquity]

@weswigham we can certainly plan to make it optional in VS. AFAIK @mjbvz has already made it the default in VS Code

[uniqueiniquity]

@amcasey Correct on your first comment, in no case do we want to rename the identifier default there. Also correct on your second comment, that behavior should only happen during a non-rename operation.

[justingrant]

@uniqueiniquity - I just tried this new feature for the first time (thank you so much for building it!) and I was surprised that renaming a property of a named, destructured export wouldn't rename the symbol when it's imported in another file. Is this expected? I'll file a separate issue if not expected. Here's the repro:

1. Uncheck the "Rename Shorthand Properties" options for TS and JS
2. Create a new code file env.ts:

type ReadonlyAndNotUndefined<T> = {  readonly [P in keyof T]: string; }
export const {
  APP_NAME,
  MONGODB_CONNECTION_URI, 
  SENDGRID_API_KEY,
  NOTIFICATION_URL_BASE,
  NOTIFICATION_FROM_EMAIL,
} = process.env as ReadonlyAndNotUndefined<typeof process.env>;

3. Create another file, use_env.ts :

import { NOTIFICATION_URL_BASE, SENDGRID_API_KEY, NOTIFICATION_FROM_EMAIL } from './env';

4. In env.ts, use rename symbol (F2) to change the name of NOTIFICATION_FROM_EMAIL

Expected: name is also changed in use_env.ts
Actual: no change to use_env.ts, and a compiler error :

Module '"src/libs/env"' has no exported member 'NOTIFICATION_FROM_EMAIL'. Did you mean 'NOTIFICATION_FROM_EMAIL_2'?

Note that if you export individual variables (not via destructuring export) the rename works fine, e.g.
export const foo = 'bar'; can be renamed to foo2 and the rename will propagate to imports in other files.