Feature request for file changes event
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
Research direction
Start by reviewing the SDK's existing session-event model against the proposed AssistantFileChangesEvent and AssistantFileChangeData shape. The feature is done when file-change events expose each change's diff, kind, path, and move_path fields so clients can display modified files during an iteration.
Written by the indexing model from the issue text.
Description
This is a feature request.
Currently it seems that we don't receive any events for changed files with their diff, which makes it difficult with the SDK to report nicely what GitHub Copilot has changed during a prompt iteration.
An example of such API in C# could be:
public partial class AssistantFileChangesEvent : SessionEvent
{
[JsonIgnore]
public override string Type => "assistant.file_changes";
[JsonPropertyName("changes")]
public required List<AssistantFileChangeData> Changes { get; set; }
}
public partial class AssistantFileChangeData
{
[JsonPropertyName("diff")]
public string Diff { get; set; } = string.Empty;
[JsonPropertyName("kind")]
public AssistantFileChangeKind Kind { get; set; } = default!;
[JsonPropertyName("path")]
public string Path { get; set; } = string.Empty;
[JsonPropertyName("move_path")]
public string MovePath { get; set; } = string.Empty; // When kind == "update"
}
[JsonConverter(typeof(JsonStringEnumConverter<AssistantFileChangeKind>))]
public enum AssistantFileChangeKind
{
[JsonStringEnumMemberName("add")]
Add,
[JsonStringEnumMemberName("delete")]
Delete,
[JsonStringEnumMemberName("update")]
Update, // Use "move_path"
}
It would allow to display more nicely during a user/assistant iteration the files that were modified.
- Dominant language
- Java
- Stars
- 10.5k
- Forks
- 1.5k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 131
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/copilot-sdk
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2709 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
github/copilot-sdk#2673 ·
-
bug testing
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
github/copilot-sdk#2628 ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2627 · 1 comment ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
github/copilot-sdk#2493 ·
All issues in github/copilot-sdk
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cryptomator/hub#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
johanhaleby/occurrent#1120 ·