TS Server Plugin rename supoort transform user input

[mantou132]

🔍 Search Terms

rename, ts server, plugin

✅ Viability Checklist

• 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, new syntax sugar for JS, etc.)
• This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
• This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

⭐ Suggestion

Current ls interface:

interface LanguageService {
  ...
  findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean, preferences: UserPreferences): readonly RenameLocation[] | undefined;
  ...
}

Add textStyle property to RenameLocation

interface RenameLocation extends DocumentSpan {
    readonly prefixText?: string;
    readonly suffixText?: string;
    readonly textStyle?: 'origin' | 'kebab' | 'camel'
}

As far as I know, this does not require changing the LSP

📃 Motivating Example

When renaming, some templates need to perform symbol conversion

💻 Use Cases

my case:

@customElements('e-my')
class MyElement extends GemElement {
  @emitter sayHi
}

html`<e-my @say-hi=${console.log}></e-my>`

When I rename an emitter name(camelCase), I want the event name(kebabCase) in the html template to transform

@customElements('e-my')
class MyElement extends GemElement {
  @emitter goodBye
}

html`<e-my @good-bye=${console.log}></e-my>`

example: https://github.com/mantou132/gem/blob/main/packages/ts-gem-plugin/src/decorate-ts.ts#L159

vscode issue: microsoft/vscode#248912

[RyanCavanaugh]

With the changing architecture of the new native TypeScript implementation, we're not going to be further expanding the scope of the existing language service surface area. We'll have more guidance soon on how these scenarios can be achieved in the new codebase; stay tuned.

[typescript-bot]

This issue has been marked as "Declined" and has seen no recent activity. It has been automatically closed for house-keeping purposes.