Rename mock and require file references

[hjonasson]

Hi 👋

I am both forgetful and lazy. That has caused me to get a broken pipeline too many times when I move files, relying on auto-updates of file paths. That breaks other file references like jest.mock("my-moved-file") or require("my-moved-file")

I know these are not imports, but function calls. However, both are file references for practical purposes, and I would love for this to be covered. Did I use AI to help me with this? Yes. However, I also tested it extensively with a local build of tsserver in various projects, in addition the added unit tests. I also searched open and closed issues for this feature but couldn't find it. My apologies if this has been rejected before.

Before:

import { helper } from "../utils/helper";
jest.mock("../utils/helper");  // ❌ Not updated when file moves

After:

import { helper } from "../shared/utils/helper";
jest.mock("../shared/utils/helper");  // ✅ Now updated automatically

Implementation Details

Changes Made

1. Added updateImportsInTestFrameworkCalls preference (src/compiler/types.ts)

   • New boolean preference in UserPreferences interface
   • Enables/disables the feature (currently defaults to enabled for testing)
   • Will be opt-in once VS Code extension support is added

2. Extended getEditsForFileRename functionality (src/services/getEditsForFileRename.ts)

   • Added getModulePathArgument() function to detect module loading patterns
   • Added updateModuleLoadingCalls() function to traverse AST and update paths
   • Deduplication logic to avoid processing the same literal twice
   • Fixed visitor pattern to properly return forEachChild result

3. Supported Patterns

   • Jest: jest.mock(), jest.unmock(), jest.requireActual(), jest.requireMock(), jest.doMock(), jest.dontMock()
   • Vitest: vitest.mock(), vi.mock()
   • Standard patterns: import(), require() (already supported, now with improved coverage)

Design Decisions

• Extensible pattern matching: New patterns can be easily added to the testFrameworkPatterns array
• Conservative approach: Only updates simple identifier patterns (e.g., jest.mock()), not nested property accesses
• Only string literals: Does not attempt to update template literals with substitutions
• Deduplication: Uses a Set to track already-processed imports, avoiding redundant updates

Testing

• Added fourslash tests for jest.mock, require, and dynamic import patterns
• All 99,036 existing tests pass
• Verified behavior with real-world test files containing multiple jest.mock() calls

Files Changed

• src/compiler/types.ts - Added new preference interface
• src/services/getEditsForFileRename.ts - Implemented feature logic and bug fix
• tests/baselines/reference/api/typescript.d.ts - Updated API baseline
• tests/cases/fourslash/getEditsForFileRename_jestMock.ts - Added test coverage
• tests/cases/fourslash/getEditsForFileRename_requireInTs.ts - Added test coverage
• tests/cases/fourslash/getEditsForFileRename_dynamicImport.ts - Added test coverage

Please verify that:

• There is an associated issue in the Backlog milestone (required) (sorry 🙏 Happy to create one if you like the idea)
• Code is up-to-date with the main branch
• You've successfully run hereby runtests locally
• There are new or updated unit tests validating the change

✅ Refer to CONTRIBUTING.MD for more details.
https://github.com/Microsoft/TypeScript/blob/main/CONTRIBUTING.md

#62835

[typescript-bot]

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

[typescript-bot]

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

[typescript-bot]

Looks like you're introducing a change to the public API surface area. If this includes breaking changes, please document them on our wiki's API Breaking Changes page.

Also, please make sure @DanielRosenwasser and @RyanCavanaugh are aware of the changes, just as a heads up.

[hjonasson]

@hjonasson please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

1. **Definitions**.
   **“Code”** means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   **“Project”** means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative ([www.opensource.org](http://www.opensource.org)).
   **“Submit”** is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   **“Submission”** means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.

2. **Your Submission**. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.

3. **Originality of Work**. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.

4. **Your Employer**. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.

5. **Licenses**.


* **Copyright License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.

* **Patent License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.

* **Other Rights Reserved**. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.


6. **Representations and Warranties**. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. **Notice to Microsoft**. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.

8. **Information about Submissions**. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.

9. **Governing Law/Jurisdiction**. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.

10. **Entire Agreement/Assignment**. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[DanielRosenwasser]

Hey @hjonasson, thanks for the PR but

1. We usually ask that people wait for issues to be triaged appropriately - we can't guarantee we'll take a PR if it's not in-scope.
2. We're avoiding taking new PRs to this codebase, especially language service PRs - see Closing TS 6.0 LS issues #62827 and Locking Resolved Issues/PRs #62623

We're doing most of our work over at typescript-go which we plan to eventually move over here - but we're also trying to avoid new scope, instead focusing on parity. Once we have that, I'd say we could consider new work in this direction.

[hjonasson]

I appreciate the feedback @DanielRosenwasser . Let me brush up on my Go 😆

Could I get your thoughts on where code like this should live. I am hesitant to hardcode tool specifics into the language server itself but I am not sure where else to put it? Jest plugins seem wrong and that would probably require some tsserver support anyway 🤔

[hjonasson]

After having a go at it in Typescript-Go it looks like the file renaming hasn't been implemented yet 🤔 I might give up on this for now.