rename_filesystem_entry_by_tsmorph
Renames TypeScript/JavaScript files and folders while automatically updating all import/export paths in the project. Analyzes using tsconfig.json, handles path aliases, and checks for conflicts before applying changes.
Instructions
[Uses ts-morph] Renames one or more TypeScript/JavaScript files and/or folders and updates all import/export paths referencing them throughout the project.
Analyzes the project based on tsconfig.json to find all references to the items being renamed and automatically corrects their paths. Handles various path types, including relative paths, path aliases (e.g., @/), and imports referencing a directory's index.ts (from '.' or from '..'). Checks for conflicts before applying changes.
Usage
Use this tool when you want to rename/move multiple files or folders simultaneously (e.g., renaming util.ts to helper.ts and moving src/data to src/coreData in one operation) and need all the import/export statements referencing them to be updated automatically.
Specify the path to the project's
tsconfig.jsonfile. Must be an absolute path.Provide an array of rename operations. Each object in the array must contain:
oldPath: The current absolute path of the file or folder to rename.newPath: The new desired absolute path for the file or folder.
It's recommended to first run with
dryRun: trueto check which files will be affected.If the preview looks correct, run with
dryRun: false(or omit it) to actually save the changes to the file system.
Parameters
tsconfigPath (string, required): Absolute path to the project's root
tsconfig.jsonfile. Must be an absolute path.renames (array of objects, required): An array where each object specifies a rename operation with:
oldPath (string, required): The current absolute path of the file or folder. Must be an absolute path.
newPath (string, required): The new desired absolute path for the file or folder. Must be an absolute path.
dryRun (boolean, optional): If set to true, prevents making and saving file changes, returning only the list of files that would be affected. Defaults to false.
timeoutSeconds (number, optional): Maximum time in seconds allowed for the operation before it times out. Defaults to 120 seconds.
Result
On success: Returns a message listing the file paths modified or scheduled to be modified.
On failure: Returns a message indicating the error (e.g., path conflict, file not found, timeout).
Remarks
Symbol-based Reference Finding: This tool now primarily uses symbol analysis (identifying exported functions, classes, variables, etc.) to find references across the project, rather than solely relying on path matching.
Path Alias Handling: Path aliases (e.g.,
@/) in import/export statements are updated, but they will be converted to relative paths. If preserving path aliases is crucial, consider using theremove_path_alias_by_tsmorphtool before renaming to convert them to relative paths preemptively.Index File Imports: Imports referencing a directory's
index.tsorindex.tsx(e.g.,import Component from '../components') will be updated to reference the specific index file directly (e.g.,import Component from '../components/index.tsx').Known Limitation (Default Exports): Currently, this tool may not correctly update references for default exports declared using an identifier (e.g.,
export default MyIdentifier;). Default exports using function or class declarations (e.g.,export default function myFunction() {}) are generally handled.Performance: Renaming numerous files/folders or operating in a very large project can take significant time due to the detailed symbol analysis and reference updates.
Conflicts: The tool checks for conflicts (e.g., renaming to an existing path, duplicate targets) before applying changes.
Timeout: Operations exceeding the specified
timeoutSecondswill be canceled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dryRun | No | If true, only show intended changes without modifying files. | |
| renames | Yes | An array of rename operations, each with oldPath and newPath. | |
| timeoutSeconds | No | Maximum time in seconds allowed for the operation before it times out. Defaults to 120. | |
| tsconfigPath | Yes | Absolute path to the project's tsconfig.json file. |