changeTrackers & codeActions improvements: apply some of changes lazily

Author: zardoy

typescript/src/codeActions/custom/changeStringReplaceToRegex.ts

@@ -1,34 +1,32 @@
 import { CodeAction } from '../getCodeActions'
 import escapeStringRegexp from 'escape-string-regexp'
-
-const nodeToSpan = (node: ts.Node): ts.TextSpan => {
-    const start = node.pos + (node.getLeadingTriviaWidth() ?? 0)
-    return { start, length: node.end - start }
-}
+import { getChangesTracker } from '../../utils'
 
 export default {
     id: 'changeStringReplaceToRegex',
     name: 'Change to Regex',
     kind: 'refactor.rewrite.stringToRegex',
-    tryToApply(sourceFile, position, _range, node) {
+    tryToApply(sourceFile, position, _range, node, formatOptions) {
         if (!node || !position) return
         // requires full explicit object selection (be aware of comma) to not be annoying with suggestion
         if (!ts.isStringLiteral(node)) return
         if (!ts.isCallExpression(node.parent) || node.parent.arguments[0] !== node) return
         if (!ts.isPropertyAccessExpression(node.parent.expression)) return
         if (node.parent.expression.name.text !== 'replace') return
-        // though it does to much escaping and ideally should be simplified
-        const edits: ts.TextChange[] = [
-            {
-                span: nodeToSpan(node),
-                newText: `/${escapeStringRegexp(node.text).replaceAll('\n', '\\n').replaceAll('\t', '\\t').replaceAll('\r', '\\r')}/`,
-            },
-        ]
+        if (!formatOptions) return true
+        const changesTracker = getChangesTracker({})
+        const { factory } = ts
+        const replaceNode = factory.createRegularExpressionLiteral(
+            // though it does to much escaping and ideally should be simplified
+            `/${escapeStringRegexp(node.text).replaceAll('\n', '\\n').replaceAll('\t', '\\t').replaceAll('\r', '\\r')}/`,
+        )
+
+        changesTracker.replaceNode(sourceFile, node, replaceNode)
         return {
             edits: [
                 {
                     fileName: sourceFile.fileName,
-                    textChanges: edits,
+                    textChanges: changesTracker.getChanges()[0]!.textChanges,
                 },
             ],
         }

typescript/src/codeActions/custom/objectSwapKeysAndValues.ts

@@ -24,10 +24,17 @@ export default {
     id: 'objectSwapKeysAndValues',
     name: 'Swap Keys and Values in Object',
     kind: 'refactor.rewrite.object.swapKeysAndValues',
-    tryToApply(sourceFile, _position, range, node) {
+    tryToApply(sourceFile, _position, range, node, formatOptions) {
         if (!range || !node) return
         // requires full explicit object selection (be aware of comma) to not be annoying with suggestion
-        if (!approveCast(node, ts.isObjectLiteralExpression) || !(range.pos === node.pos + node.getLeadingTriviaWidth() && range.end === node.end)) return
+        if (
+            !approveCast(node, ts.isObjectLiteralExpression) ||
+            !(range.pos === node.pos + node.getLeadingTriviaWidth() && range.end === node.end) ||
+            node.properties.length === 0
+        ) {
+            return
+        }
+        if (!formatOptions) return true
         const edits: ts.TextChange[] = []
         for (const property of node.properties) {
             if (!ts.isPropertyAssignment(property)) continue
@@ -48,7 +55,6 @@ export default {
                 span: nodeToSpan(initializer),
             })
         }
-        if (!edits.length) return undefined
         return {
             edits: [
                 {

typescript/src/codeActions/getCodeActions.ts

@@ -16,10 +16,11 @@ export type ApplyCodeAction = (
     position: number,
     range: ts.TextRange | undefined,
     node: ts.Node | undefined,
-    formatOptions: ts.FormatCodeSettings,
+    /** undefined when no edits is requested */
+    formatOptions: ts.FormatCodeSettings | undefined,
     languageService: ts.LanguageService,
     languageServiceHost: ts.LanguageServiceHost,
-) => ts.RefactorEditInfo | SimplifiedRefactorInfo[] | undefined
+) => ts.RefactorEditInfo | SimplifiedRefactorInfo[] | true | undefined
 
 export type CodeAction = {
     name: string
@@ -46,7 +47,8 @@ export default (
     const node = findChildContainingPosition(ts, sourceFile, pos)
     const appliableCodeActions = compact(
         codeActions.map(action => {
-            const edits = action.tryToApply(sourceFile, pos, range, node, formatOptions ?? {}, languageService, languageServiceHost)
+            const edits = action.tryToApply(sourceFile, pos, range, node, formatOptions, languageService, languageServiceHost)
+            if (edits === true) return action
             if (!edits) return
             return {
                 ...action,
@@ -76,6 +78,7 @@ export default (
         }),
     )
 
+    const requestingEdit: any = requestingEditsId ? appliableCodeActions.find(({ id }) => id === requestingEditsId) : null
     return {
         info:
             (appliableCodeActions.length && {
@@ -89,6 +92,6 @@ export default (
                 name: REFACTORS_CATEGORY,
             }) ||
             undefined,
-        edit: requestingEditsId ? appliableCodeActions.find(({ id }) => id === requestingEditsId)!.edits : null!,
+        edit: requestingEdit?.edits,
     }
 }

typescript/src/namespaceAutoImports.ts

@@ -61,7 +61,7 @@ export default (
         )
         const changeTracker = getChangesTracker(formatOptions)
         // todo respect sorting?
-        changeTracker.insertNodeAtTopOfFile(sourceFile as FullSourceFile, importDeclaration as any, true)
+        changeTracker.insertNodeAtTopOfFile(sourceFile, importDeclaration, true)
         const changes = changeTracker.getChanges()
         const { textChanges: importTextChanges } = changes[0]!
         textChanges.unshift(...importTextChanges)

typescript/src/utils.ts

@@ -167,9 +167,22 @@ export function addObjectMethodResultInterceptors<T extends Record<string, any>>
     }
 }
 
+type OriginalTypeChecker = import('typescript-full').textChanges.ChangeTracker
+
+type ChangeParameters<T extends any[]> = {
+    [K in keyof T]: T[K] extends import('typescript-full').SourceFile ? ts.SourceFile : T[K] extends import('typescript-full').Node ? ts.Node : T[K]
+}
+
+type ChangesTracker = {
+    [K in keyof OriginalTypeChecker]: (...args: ChangeParameters<Parameters<OriginalTypeChecker[K]>> & any[]) => ReturnType<OriginalTypeChecker[K]>
+}
+
 // have absolutely no idea why such useful utility is not publicly available
 export const getChangesTracker = formatOptions => {
-    return new tsFull.textChanges.ChangeTracker(/* will be normalized by vscode anyway */ '\n', tsFull.formatting.getFormatContext(formatOptions, {}))
+    return new tsFull.textChanges.ChangeTracker(
+        /* will be normalized by vscode anyway */ '\n',
+        tsFull.formatting.getFormatContext(formatOptions, {}),
+    ) as unknown as ChangesTracker
 }
 
 export const dedentString = (string: string, addIndent = '', trimFirstLines = false) => {