microsoft / microsoft/TypeScript

Refactor Rename on string parameters for symbol named parameters

Open
#41,674 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

Refactor Rename Symbol Named Parameters

Suggestion

Refactor Rename on string parameters (symbol named properties)

Use Cases

If you refactor rename a method every "reference" should be renamed.
Even the string parameter in e.g. jasmin.createSpyObj:

Examples

This

class MyService 
{
	public myMethod(n: number) {
		return n;
	}
}

const myServiceSpy = jasmine.createSpyObj<MyService>(['myMethod']);
myServiceSpy.myMethod.withArgs(999).and.returnValue(1);

should become

class MyService 
{
	public renamedMethod(n: number) {
		return n;
	}
}

const myServiceSpy = jasmine.createSpyObj<MyService>(['renamedMethod']);
myServiceSpy.renamedMethod.withArgs(999).and.returnValue(1);

after refactor rename.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation file or test is named. Start by locating TypeScript's Refactor Rename entry point and its tests, then trace how symbol references are collected for string parameters. Done means renaming a method also updates matching string names in cases such as jasmine.createSpyObj, without changing unrelated strings.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.