feat: add out of the box keybinding to unleash TypeScript's mechanism of overriding variable name in string & comments in renaming files (ctrl+shift+enter) 🚀

Author: zardoy

README.MD

@@ -228,6 +228,34 @@ Some settings examples:
 > Note: changeSorting might not preserve sorting of other existing suggestions which not defined by rules, there is WIP
 > Also I'm thinking of making it learn and syncing of most-used imports automatically
 
+## Rename Features
+
+There is builtin mechanism to rename variable occurrences in strings & comments, it is disabled in VS Code without a way to enable it.
+
+However this extension also has builtin keybinding `Ctrl+Shift+Enter` that can be pressed when input box is visible to enable aforementioned behavior for renaming with preview.
+
+But note renaming in strings & comments will happen only for files in which variable is actually referenced.
+
+You can add this to `keybindings.json` to disable previewing before renaming:
+
+```js
+{
+    "key": "ctrl+shift+enter",
+    "command": "tsEssentialPlugins.acceptRenameWithParams",
+    "args": {
+        "strings": true,
+        "comments": true,
+        // "preview": true // true by default
+        // "alias": true // you can also specify here wether to introduce alias on rename if applicable (overriding global setting)
+    },
+    "when": "renameInputVisible"
+}
+```
+
+Another options that is accepted is
+
+> Note: VS Code has builtin setting to disable introducing aliases (e.g. for imports & object properties)
+
 ## Special Commands List
 
 ### Go to / Select Nodes by Kind

package.json

@@ -53,6 +53,19 @@
                 "category": "TS Essentials"
             }
         ],
+        "keybindings": [
+            {
+                "key": "ctrl+shift+enter",
+                "mac": "cmd+shift+enter",
+                "command": "tsEssentialPlugins.acceptRenameWithParams",
+                "args": {
+                    "strings": true,
+                    "comments": true,
+                    "preview": true
+                },
+                "when": "renameInputVisible && editorLangId =~ /javascript|javascriptreact|typescript|typescriptreact|vue/"
+            }
+        ],
         "typescriptServerPlugins": [
             {
                 "name": "typescript-essential-plugins",

src/specialCommands.ts

@@ -265,6 +265,25 @@ export default () => {
         await vscode.workspace.applyEdit(edit)
     })
 
+    registerExtensionCommand('acceptRenameWithParams' as any, async (_, { preview = false, comments = null, strings = null, alias = null } = {}) => {
+        const editor = vscode.window.activeTextEditor
+        if (!editor) return
+        const {
+            document,
+            selection: { active: position },
+        } = editor
+        await sendCommand<RequestOptionsTypes['acceptRenameWithParams']>('acceptRenameWithParams', {
+            document,
+            position,
+            inputOptions: {
+                alias,
+                comments,
+                strings,
+            } satisfies RequestOptionsTypes['acceptRenameWithParams'],
+        })
+        await vscode.commands.executeCommand(preview ? 'acceptRenameInputWithPreview' : 'acceptRenameInput')
+    })
+
     // its actually a code action, but will be removed from there soon
     vscode.languages.registerCodeActionsProvider(defaultJsSupersetLangsWithVue, {
         async provideCodeActions(document, range, context, token) {

typescript/src/decorateProxy.ts

@@ -1,5 +1,5 @@
 import { getCompletionsAtPosition, PrevCompletionMap, PrevCompletionsAdditionalData } from './completionsAtPosition'
-import { TriggerCharacterCommand } from './ipcTypes'
+import { RequestOptionsTypes, TriggerCharacterCommand } from './ipcTypes'
 import { getNavTreeItems } from './getPatchedNavTree'
 import decorateCodeActions from './codeActions/decorateProxy'
 import decorateSemanticDiagnostics from './semanticDiagnostics'
@@ -25,6 +25,10 @@ export const getInitialProxy = (languageService: ts.LanguageService, proxy = Obj
     return proxy
 }
 
+export const overrideRequestPreferences = {
+    rename: undefined as undefined | RequestOptionsTypes['acceptRenameWithParams'],
+}
+
 export const decorateLanguageService = (
     info: ts.server.PluginCreateInfo,
     existingProxy: ts.LanguageService | undefined,
@@ -109,6 +113,23 @@ export const decorateLanguageService = (
     decorateReferences(proxy, languageService, c)
     decorateDocumentHighlights(proxy, languageService, c)
     decorateWorkspaceSymbolSearch(proxy, languageService, c, languageServiceHost)
+    proxy.findRenameLocations = (fileName, position, findInStrings, findInComments, providePrefixAndSuffixTextForRename) => {
+        if (overrideRequestPreferences.rename) {
+            try {
+                const { comments, strings, alias } = overrideRequestPreferences.rename
+                return languageService.findRenameLocations(
+                    fileName,
+                    position,
+                    strings ?? findInStrings,
+                    comments ?? findInComments,
+                    alias ?? providePrefixAndSuffixTextForRename,
+                )
+            } finally {
+                overrideRequestPreferences.rename = undefined
+            }
+        }
+        return languageService.findRenameLocations(fileName, position, findInStrings, findInComments, providePrefixAndSuffixTextForRename)
+    }
 
     if (pluginSpecificSyntaxServerConfigCheck) {
         if (!__WEB__) {

typescript/src/ipcTypes.ts

@@ -10,6 +10,7 @@ export const triggerCharacterCommands = [
     'getRangeOfSpecialValue',
     'turnArrayIntoObject',
     'getFixAllEdits',
+    'acceptRenameWithParams',
 ] as const
 
 export type TriggerCharacterCommand = typeof triggerCharacterCommands[number]
@@ -57,6 +58,11 @@ export type RequestOptionsTypes = {
         range: [number, number]
         selectedKeyName?: string
     }
+    acceptRenameWithParams: {
+        comments: boolean
+        strings: boolean
+        alias: boolean
+    }
 }
 
 // export type EmmetResult = {

typescript/src/specialCommands/handle.ts

@@ -1,5 +1,6 @@
 import { compact } from '@zardoy/utils'
 import postfixesAtPosition from '../completions/postfixesAtPosition'
+import { overrideRequestPreferences } from '../decorateProxy'
 import { NodeAtPositionResponse, RequestOptionsTypes, RequestResponseTypes, TriggerCharacterCommand, triggerCharacterCommands } from '../ipcTypes'
 import { findChildContainingExactPosition, findChildContainingPosition, getNodePath } from '../utils'
 import getEmmetCompletions from './emmet'
@@ -181,6 +182,14 @@ export default (
             return
         }
     }
+    if (specialCommand === 'acceptRenameWithParams') {
+        changeType<RequestOptionsTypes['acceptRenameWithParams']>(specialCommandArg)
+        overrideRequestPreferences.rename = specialCommandArg
+        return {
+            entries: [],
+            typescriptEssentialsResponse: undefined,
+        }
+    }
     if (specialCommand === 'pickAndInsertFunctionArguments') {
         // const sourceFile = (info.languageService as ReturnType<typeof tsFull['createLanguageService']>).getProgram()!.getSourceFile(fileName)!
         // if (!sourceFile.identifiers) throw new Error('TS: no exposed identifiers map')