feat: added support for getMoveToRefactoringFileSuggestions, organizeImports, getEditsForFileRename

Author: charlypa

src/exp.js

@@ -148,5 +148,17 @@ for (let file of FILES) {
     await tsServer.openFile(file.getEditsForRefactor.filePath);
     const getEditsForRefactorResponse = await tsServer.getEditsForRefactor(file.getEditsForRefactor.filePath, file.getEditsForRefactor.refactor, file.getEditsForRefactor.action, file.getEditsForRefactor.startLine, file.getEditsForRefactor.startOffset, file.getEditsForRefactor.endLine, file.getEditsForRefactor.endOffset, file.getEditsForRefactor.interactiveRefactorArguments);
     console.log('getEditsForRefactorResponse', JSON.stringify(getEditsForRefactorResponse));
+
+    await tsServer.openFile(file.getMoveToRefactoringFileSuggestions.filePath);
+    const getMoveToRefactoringFileSuggestionsResponse = await tsServer.getMoveToRefactoringFileSuggestions(file.getMoveToRefactoringFileSuggestions.filePath, file.getMoveToRefactoringFileSuggestions.startLine, file.getMoveToRefactoringFileSuggestions.startOffset, file.getMoveToRefactoringFileSuggestions.endLine, file.getMoveToRefactoringFileSuggestions.endOffset/*,file.getMoveToRefactoringFileSuggestions.kind*/);
+    console.log('getMoveToRefactoringFileSuggestionsResponse', JSON.stringify(getMoveToRefactoringFileSuggestionsResponse));
+
+    await tsServer.openFile(file.organizeImports.filePath);
+    const organizeImportsResponse = await tsServer.organizeImports(file.organizeImports.filePath, file.organizeImports.mode);
+    console.log('organizeImportsResponse', JSON.stringify(organizeImportsResponse));
+
+    await tsServer.openFile(file.getEditsForFileRename.oldFilePath);
+    const getEditsForFileRenameResponse = await tsServer.getEditsForFileRename(file.getEditsForFileRename.oldFilePath, file.getEditsForFileRename.newFilePath);
+    console.log('getEditsForFileRenameResponse', JSON.stringify(getEditsForFileRenameResponse));
 }
 //tsServer.exitServer();

src/test/sample/getEditsForFileRename/main.ts

@@ -0,0 +1,4 @@
+// main.ts
+import { greet } from './sample';
+
+console.log(greet('World'));

src/test/sample/getEditsForFileRename/sample.ts

@@ -0,0 +1,4 @@
+// sample.ts
+export function greet(name: string): string {
+    return `Hello, ${name}!`;
+}

src/test/sample/getEditsForFileRename/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es5",              // Specify ECMAScript target version
+    "module": "commonjs",         // Specify module code generation
+    "strict": true,               // Enable all strict type-checking options
+    "esModuleInterop": true,      // Enables compatibility with default imports from CommonJS modules
+    "outDir": "./dist",           // Redirect output structure to the directory
+    "baseUrl": "./",              // Base directory to resolve non-relative module names
+    "paths": {                    // Specify paths for module names
+      "*": ["node_modules/*"]
+    },
+    "skipLibCheck": true,         // Skip type checking of all declaration files (*.d.ts)
+    "forceConsistentCasingInFileNames": true // Disallow inconsistently-cased references to the same file.
+  },
+  "include": [
+    "./**/*.ts"                  // Include all TypeScript files in the project
+  ],
+  "exclude": [
+    "node_modules",              // Exclude the node_modules directory
+    "**/*.spec.ts"               // Exclude test files
+  ]
+}

src/test/sample/getMoveToRefactoringFileSuggestions.ts

@@ -0,0 +1,15 @@
+class MathOperations {
+    // This method is a good candidate to be moved to a separate utility file
+    static add(a: number, b: number): number {
+        return a + b;
+    }
+
+    // This method might stay within this class
+    static subtract(a: number, b: number): number {
+        return a - b;
+    }
+}
+
+// Usage of the class methods
+console.log(MathOperations.add(5, 3));
+console.log(MathOperations.subtract(10, 4));

src/test/sample/organizeImports.ts

@@ -0,0 +1,24 @@
+// sample.ts
+import { Component } from 'react';
+import { useState } from 'react';
+import { useEffect } from 'react';
+import { render } from 'react-dom';
+import { someUnusedFunction } from './utils';
+
+class MyComponent extends Component {
+    // Component implementation
+}
+
+const App = () => {
+    const [state, setState] = useState(null);
+
+    useEffect(() => {
+        // Effect logic
+    }, []);
+
+    return (
+        <MyComponent />
+    );
+};
+
+render(<App />, document.getElementById('root'));

src/utils/server.js

@@ -1784,6 +1784,111 @@ function createTSServerInstance(inferredProject = true) {
         return sendCommand(command);
     }
 
+    /**
+     * Sends a 'GetMoveToRefactoringFileSuggestions' request to the TypeScript Server. This command retrieves a list of
+     * existing file paths as suggestions for moving a specific piece of code as part of a refactoring process.
+     * The function handles both single-location requests (FileLocationRequestArgs) and range-based requests (FileRangeRequestArgs).
+     *
+     * @param {string} filePath - The absolute path to the TypeScript file.
+     * @param {number} startLine - The starting line number of the range or location (1-based).
+     * @param {number} startOffset - The starting character offset on the start line (1-based).
+     * @param {number} [endLine] - The ending line number of the range (1-based). Optional for single location.
+     * @param {number} [endOffset] - The ending character offset on the end line (1-based). Optional for single location.
+     * @param {string} [kind] - Optional. The kind of refactoring to apply.
+     * @returns {Promise<Object>} A promise that resolves with a list of file paths suggested for the refactoring.
+     * @example
+     * // Example usage for a range in a file
+     * getMoveToRefactoringFileSuggestions('/path/to/file.ts', 5, 1, 7, 1)
+     *   .then(suggestions => {
+     *     console.log('Refactoring File Suggestions:', suggestions);
+     *   })
+     *   .catch(error => {
+     *     console.error('Error getting file suggestions for refactoring:', error);
+     *   });
+     */
+    function getMoveToRefactoringFileSuggestions(filePath, startLine, startOffset, endLine, endOffset, kind) {
+        const args = endLine !== undefined && endOffset !== undefined
+            ? {startLine, startOffset, endLine, endOffset} // FileRangeRequestArgs
+            : {line: startLine, offset: startOffset}; // FileLocationRequestArgs
+
+        const command = {
+            command: "getMoveToRefactoringFileSuggestions",
+            arguments: {
+                file: filePath,
+                ...args,
+                kind: kind
+            }
+        };
+        return sendCommand(command);
+    }
+
+    /**
+     * Sends an 'organizeImports' request to the TypeScript Server. This command organizes the imports in a TypeScript file by:
+     *   1) Removing unused imports.
+     *   2) Coalescing imports from the same module.
+     *   3) Sorting imports.
+     * The scope of the request is limited to a single file. The function allows specifying the mode of import organization.
+     *
+     * @param {string} filePath - The absolute path to the TypeScript file.
+     * @param {string} [mode] - The mode of import organization, which can be 'All', 'SortAndCombine', or 'RemoveUnused'. Default is 'All'.
+     * @param {string} [projectFileName] - Optional. The name of the project that contains the file (e.g., path to 'tsconfig.json').
+     * @returns {Promise<Object>} A promise that resolves with an array of file code edits suggested by the TypeScript server. Each edit includes the file name and an array of text changes.
+     * @example
+     * // Organizing imports in a file with all modes
+     * organizeImports('/path/to/file.ts', 'All', '/path/to/project/tsconfig.json')
+     *   .then(edits => {
+     *     console.log('Organize Imports Edits:', edits);
+     *   })
+     *   .catch(error => {
+     *     console.error('Error organizing imports:', error);
+     *   });
+     */
+    function organizeImports(filePath, mode = 'All', projectFileName) {
+        const command = {
+            command: "organizeImports",
+            arguments: {
+                scope: {
+                    type: "file",
+                    args: {file: filePath, projectFileName: projectFileName}
+                },
+                mode: mode
+            }
+        };
+        return sendCommand(command);
+    }
+
+    /**
+     * Sends a 'getEditsForFileRename' request to the TypeScript Server. This function is used to retrieve
+     * the necessary code edits required when a file is renamed. It updates import paths and references in
+     * other files within the project to reflect the new file name.
+     *
+     * @param {string} oldFilePath - The original path of the file before renaming.
+     * @param {string} newFilePath - The new path of the file after renaming.
+     * @returns {Promise} A promise that resolves with an array of file code edits. Each element in the array
+     *                    is an object containing the file name and an array of text changes. Each text change
+     *                    is an object with 'start', 'end', and 'newText' properties indicating how the text
+     *                    should be modified.
+     * @example
+     * getEditsForFileRename('/path/to/oldFile.ts', '/path/to/newFile.ts')
+     *   .then(edits => {
+     *     console.log('File Rename Edits:', edits);
+     *   })
+     *   .catch(error => {
+     *     console.error('Error getting edits for file rename:', error);
+     *   });
+     */
+    function getEditsForFileRename(oldFilePath, newFilePath) {
+        const command = {
+            command: "getEditsForFileRename",
+            arguments: {
+                oldFilePath: oldFilePath,
+                newFilePath: newFilePath
+            }
+        };
+        return sendCommand(command);
+    }
+
+
     /**
      * Terminates the TypeScript Server process.
      * Warning: Use this function with caution. Prefer using the exitServer function for a graceful shutdown.
@@ -1848,6 +1953,9 @@ function createTSServerInstance(inferredProject = true) {
         getSupportedCodeFixes,
         getApplicableRefactors,
         getEditsForRefactor,
+        getMoveToRefactoringFileSuggestions,
+        organizeImports,
+        getEditsForFileRename,
         exitServer
     };
 }

src/utils/testconfig.js

@@ -200,6 +200,23 @@ export const FILES = [{
         interactiveRefactorArguments: {
             targetFile: '/home/charly/repo/tsIntelligence/src/test/sample/getEditsForRefactor.ts'
         }
+    },
+    getMoveToRefactoringFileSuggestions: {
+        filePath: '/home/charly/repo/tsIntelligence/src/test/sample/getMoveToRefactoringFileSuggestions.ts',
+        startLine: 3,
+        startOffset: 1,
+        endLine: 6,
+        endOffset: 1,
+        kind: ""
+
+    },
+    organizeImports: {
+        filePath: '/home/charly/repo/tsIntelligence/src/test/sample/organizeImports.ts',
+        mode: 'All'
+    },
+    getEditsForFileRename: {
+        oldFilePath: '/home/charly/repo/tsIntelligence/src/test/sample/getEditsForFileRename/sample.ts',
+        newFilePath: '/home/charly/repo/tsIntelligence/src/test/sample/getEditsForFileRename/greetings.ts'
     }
 }, {
     filepath: '/home/charly/repo/vscode/extensions/typescript-language-features/web/src/webServer.ts',
@@ -374,6 +391,23 @@ export const FILES = [{
         interactiveRefactorArguments: {
             targetFile: '/home/charly/repo/tsIntelligence/src/test/sample/getEditsForRefactor.ts'
         }
+    },
+    getMoveToRefactoringFileSuggestions: {
+        filePath: '/home/charly/repo/vscode/extensions/typescript-language-features/web/src/webServer.ts',
+        startLine: 62,
+        startOffset: 1,
+        endLine: 76,
+        endOffset: 3,
+        kind: ""
+
+    },
+    organizeImports: {
+        filePath: '/home/charly/repo/vscode/extensions/typescript-language-features/web/src/webServer.ts',
+        mode: 'All'
+    },
+    getEditsForFileRename: {
+        oldFilePath: '/home/charly/repo/vscode/extensions/typescript-language-features/web/src/fileWatcherManager.ts',
+        newFilePath: '/home/charly/repo/vscode/extensions/typescript-language-features/web/src/fileWatcherManager1.ts'
     }
 // TODO: add testcase for update and open
 }];