Merge pull request #92 from zardoy/develop

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",
@@ -105,7 +118,7 @@
         "type-fest": "^2.13.1",
         "typed-jsonfile": "^0.2.1",
         "typescript": "^4.9.3",
-        "vitest": "^0.25.3",
+        "vitest": "^0.26.0",
         "vscode-manifest": "^0.0.4"
     },
     "pnpm": {

pnpm-lock.yaml

@@ -63,10 +63,6 @@ export type Configuration = {
      * @default false
      */
     enableVueSupport: boolean
-    /**
-     * @default true
-     */
-    vueSpecificImprovements: boolean
     /**
      * Temporary setting to enable loading config from other locations (also to expose plugin)
      */

src/configurationType.ts

@@ -14,6 +14,7 @@ import apiCommands from './apiCommands'
 import onCompletionAccepted from './onCompletionAccepted'
 import specialCommands from './specialCommands'
 import vueVolarSupport from './vueVolarSupport'
+import moreCompletions from './moreCompletions'
 
 export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted }) => {
     let webWaitingForConfigSync = false
@@ -65,6 +66,7 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
     }
 
     experimentalPostfixes()
+    moreCompletions()
     void registerEmmet()
     webImports()
     apiCommands()

src/extension.ts

@@ -0,0 +1,29 @@
+import * as vscode from 'vscode'
+import { defaultJsSupersetLangsWithVue } from '@zardoy/vscode-utils/build/langs'
+
+export default () => {
+    vscode.languages.registerCompletionItemProvider(
+        defaultJsSupersetLangsWithVue,
+        {
+            provideCompletionItems(document, position, token, context) {
+                const regex = /\/\/@?[\w-]*/
+                let range = document.getWordRangeAtPosition(position, regex)
+                if (!range) return
+                const rangeText = document.getText(range)
+                if (rangeText !== document.lineAt(position).text.trim()) {
+                    return
+                }
+
+                range = range.with(range.start.translate(0, 2), range.end)
+                const tsDirectives = ['@ts-format-ignore-line', '@ts-format-ignore-region', '@ts-format-ignore-endregion']
+                return tsDirectives.map((directive, i) => {
+                    const completionItem = new vscode.CompletionItem(directive, vscode.CompletionItemKind.Snippet)
+                    completionItem.range = range
+                    completionItem.sortText = `z${i}`
+                    return completionItem
+                })
+            },
+        },
+        '@',
+    )
+}

src/moreCompletions.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) {

src/specialCommands.ts

@@ -65,6 +65,7 @@ export default (proxy: ts.LanguageService, languageService: ts.LanguageService,
         } finally {
             tsFull.codefix.createCodeFixAction = oldCreateCodeFixAction
         }
+        // todo remove when 5.0 is released after 3 months
         // #region fix builtin codefixes/refactorings
         prior.forEach(fix => {
             if (fix.fixName === 'fixConvertConstToLet') {

typescript/src/codeFixes.ts

@@ -1,6 +1,6 @@
 import { GetConfig } from '../types'
 import { findChildContainingPosition, getLineTextBeforePos } from '../utils'
-import { singular } from 'pluralize'
+import pluralize from 'pluralize'
 
 const arrayMethodsToPatch = [
     'forEach',
@@ -31,7 +31,7 @@ export default (entries: ts.CompletionEntry[], position: number, sourceFile: ts.
     if (!nodeBeforeDot) return
 
     const cleanSourceText = getItemNameFromNode(nodeBeforeDot)?.replace(/^(?:all)?(.+?)(?:List)?$/, '$1')
-    let inferredName = cleanSourceText && singular(cleanSourceText)
+    let inferredName = cleanSourceText && pluralize.singular(cleanSourceText)
     const defaultItemName = c('arrayMethodsSnippets.defaultItemName')
     // both can be undefined
     if (inferredName === cleanSourceText) {