microsoft / microsoft/TypeScript

Add diff chunk header lines to Git

Open
#36,185 4 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Community Tooling Experience Enhancement Help Wanted Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

userdiff xfuncname

Suggestion

Please add regular expressions to https://github.com/git/git/blob/master/userdiff.c such that TypeScript constructs can be identified in a predictable manner by the Git diff algorithm.

Use Cases

When I do a git diff or git add -p that includes TypeScript code, it's nice to see the function and/or class names of the changed lines I am looking at.

Examples

  • git diff -- *.ts
  • git add -p -- *.ts

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.
    • Particularly "Provide a structuring mechanism for larger pieces of code."

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 by reviewing Git's userdiff.c, which the issue identifies as the implementation entry point, and inspect how existing language patterns expose function or class names in diff headers. Add TypeScript patterns for .ts files, then verify that git diff and git add -p show the relevant construct names for the examples in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.