Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Annotations out of sync when waiting for highlighting

Open
#1,171 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
54/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
frontend

Research direction

Start by tracing how fileDiff updates and how the view displays it while highlighting runs in the background; then read the renderAnnotation callback and how annotations are passed to it. Reproduce the hunk-action case described in the issue. Done means annotations and the displayed diff stay in sync during highlighting.

Written by the indexing model from the issue text.

Description

Let's say we compute annotations based on the current fileDiff. When the fileDiff changes, we pass new annotations, however the view currently keeps showing the old fileDiff while the new one is being highlighted in the background.

This can result in a glitchy UI. For example, if the annotation is a hunk action that effectively removes the hunk from the diff, it means that once we update fileDiff, the annotation disappears, while the hunk is still rendered until highlighting is done.

One possible solution would be to keep showing the old annotations as long as the old fileDiff is shown, so they are both in sync. The annotation is passed to renderAnnotation callback, so the caller can check if the annotation is stale by comparing item.fileDiff !== fileDiff (for example, to disable action buttons).

Dominant language
TypeScript
Stars
6.2k
Forks
226
Avg merge
1d 12h
Merged PRs (30d)
34

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from pierrecomputer/pierre

All issues in pierrecomputer/pierre

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.