Skip to content

fix: always call initSyntax on mount to prevent lost highlighting #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
voglster wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: always call initSyntax on mount to prevent lost highlighting #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions packages/react/src/components/DiffView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,22 +315,23 @@ const DiffViewWithRef = <T extends unknown>(
if (!diffFile) return;

if (props.diffViewHighlight) {
// Always call initSyntax when highlight is enabled.
// initSyntax() is idempotent — when syntax is already initialized with a
// matching highlighter, it efficiently re-syncs syntax line references
// from the underlying File objects without recomputing.
//
// Previously, this effect skipped initSyntax() when the highlighter
// name/type already matched. However, on remount the global File cache
// causes initRaw() → #syncSyntax() to copy highlighter metadata from
// cached File objects into the fresh DiffFile, making it appear that
// syntax was already set up when it wasn't. This left syntax lines null
// and highlighting was lost on subsequent renders.
if (registerHighlighter) {
if (
registerHighlighter.name !== diffFile._getHighlighterName() ||
registerHighlighter.type !== diffFile._getHighlighterType() ||
registerHighlighter.type !== "class"
) {
diffFile.initSyntax({ registerHighlighter: registerHighlighter });
diffFile.notifyAll();
}
} else if (
(!diffFile._getIsCloned() && diffFile._getHighlighterName() !== buildInHighlighter.name) ||
diffFile._getHighlighterType() !== "class"
) {
diffFile.initSyntax({ registerHighlighter: registerHighlighter });
} else {
diffFile.initSyntax();
diffFile.notifyAll();
}
diffFile.notifyAll();
}
}, [diffFile, props.diffViewHighlight, registerHighlighter, diffViewTheme]);

Expand Down
16 changes: 3 additions & 13 deletions packages/solid/src/components/DiffView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,21 +198,11 @@ const InternalDiffView = <T extends unknown>(props: DiffViewProps<T>) => {
if (props.diffViewHighlight) {
const registerHighlighter = props.registerHighlighter;
if (registerHighlighter) {
if (
registerHighlighter.name !== currentDiffFile._getHighlighterName() ||
registerHighlighter.type !== currentDiffFile._getHighlighterType() ||
registerHighlighter.type !== "class"
) {
currentDiffFile.initSyntax({ registerHighlighter: registerHighlighter });
currentDiffFile.notifyAll();
}
} else if (
(!currentDiffFile._getIsCloned() && currentDiffFile._getHighlighterName() !== buildInHighlighter.name) ||
currentDiffFile._getHighlighterType() !== "class"
) {
currentDiffFile.initSyntax({ registerHighlighter: registerHighlighter });
} else {
currentDiffFile.initSyntax();
currentDiffFile.notifyAll();
}
currentDiffFile.notifyAll();
}
}
};
Expand Down
20 changes: 5 additions & 15 deletions packages/svelte/src/lib/components/DiffView.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,23 +164,13 @@
if (enableHighlight) {
const registerHighlighter = props.registerHighlighter;
if (registerHighlighter) {
if (
registerHighlighter.name !== diffFile._getHighlighterName() ||
registerHighlighter.type !== diffFile._getHighlighterType() ||
registerHighlighter.type !== 'class'
) {
diffFile.initSyntax({
registerHighlighter: registerHighlighter
});
diffFile.notifyAll();
}
} else if (
(!diffFile._getIsCloned() && diffFile._getHighlighterName() !== buildInHighlighter.name) ||
diffFile._getHighlighterType() !== 'class'
) {
diffFile.initSyntax({
registerHighlighter: registerHighlighter
});
} else {
diffFile.initSyntax();
diffFile.notifyAll();
}
diffFile.notifyAll();
}
};

Expand Down
20 changes: 5 additions & 15 deletions packages/vue/src/components/DiffView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,23 +165,13 @@ export const DiffView = defineComponent<
if (enableHighlight.value) {
const registerHighlighter = props.registerHighlighter;
if (registerHighlighter) {
if (
registerHighlighter.name !== instance._getHighlighterName() ||
registerHighlighter.type !== instance._getHighlighterType() ||
registerHighlighter.type !== "class"
) {
instance.initSyntax({
registerHighlighter: registerHighlighter,
});
instance.notifyAll();
}
} else if (
(!instance._getIsCloned() && instance._getHighlighterName() !== buildInHighlighter.name) ||
instance._getHighlighterType() !== "class"
) {
instance.initSyntax({
registerHighlighter: registerHighlighter,
});
} else {
instance.initSyntax({});
instance.notifyAll();
}
instance.notifyAll();
}
};

Expand Down