microsoft / microsoft/TypeScript

feat(contentmapper): support whole-symbol rename edit projection

Open
#63,879 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

## Problem

Content Mapper protocol v1 cannot safely rename one semantic symbol when generated and authored spellings differ.

A Vue mapper, for example, needs to project this authored listener:

```vue

```

to a TypeScript reference to the child's `saveItem` declaration. A protocol Atom correctly maps the whole generated `saveItem` span to the whole authored `save-item` span and works for hover, definition, and references. Rename still fails closed even when the Atom advertises `FeatureRename`.

At `bddd2162710e50281fa838456a875fd59ee7c91f` (the Content Mappers PR microsoft/typescript-go#4712 head):

- `GetRenameInfo` skips every mapped input whose fidelity is not exact.
- `getRenameInfoSuccess` rejects a non-exact trigger span.
- `renameEditRange` skips every mapped occurrence whose writeback is not exact.
- the fourslash contract explicitly verifies that Atom origins cannot be renamed.

Changing the projection to verbatim `"save-item"` is not equivalent: TypeScript then sees a different property symbol, so definition/reference navigation no longer reaches the child `saveItem` declaration. It also cannot express the required per-occurrence replacement: renaming to semantic `nextItem` must write `next-item` in the template and `nextItem` in the TypeScript-shaped declaration.

## Requested design

Please add a safe whole-symbol edit projection mechanism for Content Mappers. Two possible shapes:

1. A mapper RPC that receives the complete rename transaction (semantic replacement plus generated/original spans) and returns validated authored text edits.
2. A declared per-segment edit codec/strategy that can map a semantic replacement in both directions for whole-symbol Atom or Alias segments.

The contract should:

- allow prepare-rename from a single whole-symbol Atom without pretending it has verbatim geometry;
- transform each reference's replacement according to its authored spelling;
- validate bounds, overlap, URI ownership, and document versions before returning one atomic workspace edit;
- fail closed if any required occurrence cannot be projected exactly;
- never return edits targeting generated documents;
- preserve the existing exact-only behavior for ordinary Atom segments without an edit projection;
- clarify whether `FeatureRename` is valid on Atom segments in protocol v1, since it is currently accepted by validation but cannot make rename succeed.

## Acceptance test

Given a child declaration named `saveItem` and parent usages authored as both `@saveItem` and `@save-item`:

- rename from any character of either parent usage updates the child declaration and all parent usages;
- rename from the child declaration updates all parent usages;
- semantic replacement `nextItem` writes valid camel/kebab spellings at the corresponding sites;
- semantic or authored replacement input with kebab casing has a defined, deterministic normalization policy;
- hover, definition, and references retain their current Atom fidelity;
- no approximate `(0, 0)` or generated-file edit is returned.

This is not Vue-specific: template languages commonly normalize casing, prefixes, or sigils while keeping one semantic symbol.

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

Start with GetRenameInfo, getRenameInfoSuccess, and renameEditRange, then read the existing fourslash contract that verifies Atom origins cannot be renamed. Compare the two proposed projection shapes against the Content Mappers PR behavior and acceptance test. Done means validated atomic edits support whole-symbol Atom or Alias occurrences without generated-file edits while preserving exact-only behavior otherwise.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.