Skip to content

refactor: update getContentLeftDom and getContentRightDom to use options object for parameters #293

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

Merged
levivilet merged 1 commit into from
Apr 28, 2026
Merged

refactor: update getContentLeftDom and getContentRightDom to use options object for parameters #293

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
45 changes: 32 additions & 13 deletions packages/diff-view/src/parts/GetContentLeftDom/GetContentLeftDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,40 @@ import { defaultAllowedLinkSchemes } from '../AllowedLinkSchemes/AllowedLinkSche
import * as ClassNames from '../ClassNames/ClassNames.ts'
import { getContentDom } from '../GetContentDom/GetContentDom.ts'

export const getContentLeftDom = (
contentLeft: string,
errorMessage = '',
interface GetContentLeftDomOptions {
readonly allowedLinkSchemes?: readonly string[]
readonly contentLeft: string
readonly errorCodeFrame?: string
readonly errorMessage?: string
readonly errorStack?: string
readonly inlineChanges?: readonly InlineDiffChange[]
readonly itemHeight?: number
readonly lineNumbers?: boolean
readonly maxLineY?: number
readonly minLineY?: number
readonly tokenizedLines?: readonly TokenizedLine[]
readonly totalLineCount?: number
readonly visibleLines?: readonly VisibleLine[]
}

export const getContentLeftDom = ({
allowedLinkSchemes = defaultAllowedLinkSchemes,
contentLeft,
errorCodeFrame = '',
errorMessage = '',
errorStack = '',
allowedLinkSchemes: readonly string[] = defaultAllowedLinkSchemes,
inlineChanges = [],
itemHeight = 20,
lineNumbers = true,
totalLineCount = contentLeft ? contentLeft.split('\n').length : 1,
maxLineY,
minLineY = 0,
maxLineY = totalLineCount,
inlineChanges: readonly InlineDiffChange[] = [],
tokenizedLines: readonly TokenizedLine[] = [],
visibleLines: readonly VisibleLine[] = [],
itemHeight = 20,
): readonly VirtualDomNode[] => {
tokenizedLines = [],
totalLineCount,
visibleLines = [],
}: GetContentLeftDomOptions): readonly VirtualDomNode[] => {
const resolvedTotalLineCount = totalLineCount ?? (contentLeft ? contentLeft.split('\n').length : 1)
const resolvedMaxLineY = maxLineY ?? resolvedTotalLineCount

return getContentDom(
ClassNames.DiffEditorContentLeft,
contentLeft,
Expand All @@ -29,9 +48,9 @@ export const getContentLeftDom = (
errorStack,
allowedLinkSchemes,
lineNumbers,
totalLineCount,
resolvedTotalLineCount,
minLineY,
maxLineY,
resolvedMaxLineY,
inlineChanges,
'left',
tokenizedLines,
Expand Down
45 changes: 32 additions & 13 deletions packages/diff-view/src/parts/GetContentRightDom/GetContentRightDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,40 @@ import { defaultAllowedLinkSchemes } from '../AllowedLinkSchemes/AllowedLinkSche
import * as ClassNames from '../ClassNames/ClassNames.ts'
import { getContentDom } from '../GetContentDom/GetContentDom.ts'

export const getContentRightDom = (
contentRight: string,
errorMessage = '',
interface GetContentRightDomOptions {
readonly allowedLinkSchemes?: readonly string[]
readonly contentRight: string
readonly errorCodeFrame?: string
readonly errorMessage?: string
readonly errorStack?: string
readonly inlineChanges?: readonly InlineDiffChange[]
readonly itemHeight?: number
readonly lineNumbers?: boolean
readonly maxLineY?: number
readonly minLineY?: number
readonly tokenizedLines?: readonly TokenizedLine[]
readonly totalLineCount?: number
readonly visibleLines?: readonly VisibleLine[]
}

export const getContentRightDom = ({
allowedLinkSchemes = defaultAllowedLinkSchemes,
contentRight,
errorCodeFrame = '',
errorMessage = '',
errorStack = '',
allowedLinkSchemes: readonly string[] = defaultAllowedLinkSchemes,
inlineChanges = [],
itemHeight = 20,
lineNumbers = true,
totalLineCount = contentRight ? contentRight.split('\n').length : 1,
maxLineY,
minLineY = 0,
maxLineY = totalLineCount,
inlineChanges: readonly InlineDiffChange[] = [],
tokenizedLines: readonly TokenizedLine[] = [],
visibleLines: readonly VisibleLine[] = [],
itemHeight = 20,
): readonly VirtualDomNode[] => {
tokenizedLines = [],
totalLineCount,
visibleLines = [],
}: GetContentRightDomOptions): readonly VirtualDomNode[] => {
const resolvedTotalLineCount = totalLineCount ?? (contentRight ? contentRight.split('\n').length : 1)
const resolvedMaxLineY = maxLineY ?? resolvedTotalLineCount

return getContentDom(
ClassNames.DiffEditorContentRight,
contentRight,
Expand All @@ -29,9 +48,9 @@ export const getContentRightDom = (
errorStack,
allowedLinkSchemes,
lineNumbers,
totalLineCount,
resolvedTotalLineCount,
minLineY,
maxLineY,
resolvedMaxLineY,
inlineChanges,
'right',
tokenizedLines,
Expand Down
48 changes: 24 additions & 24 deletions packages/diff-view/src/parts/GetDiffEditorVirtualDom/GetDiffEditorVirtualDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,36 +45,36 @@ export const getDiffEditorVirtualDom = (state: DiffViewState): readonly VirtualD
const showLineNumbers = lineNumbers && renderModeLeft === 'text' && renderModeRight === 'text'
const diffEditorLayoutClass = layout === 'vertical' ? ClassNames.DiffEditorVertical : ClassNames.DiffEditorHorizontal
const sashLayoutClass = layout === 'vertical' ? ClassNames.SashHorizontal : ClassNames.SashVertical
const leftDom = getContentLeftDom(
contentLeft,
errorLeftMessage,
errorLeftCodeFrame,
errorLeftStack,
const leftDom = getContentLeftDom({
allowedLinkSchemes,
showLineNumbers,
totalLineCountLeft,
minLineY,
maxLineY,
contentLeft,
errorCodeFrame: errorLeftCodeFrame,
errorMessage: errorLeftMessage,
errorStack: errorLeftStack,
inlineChanges,
tokenizedLinesLeft,
visibleLinesLeft,
itemHeight,
)
const rightDom = getContentRightDom(
contentRight,
errorRightMessage,
errorRightCodeFrame,
errorRightStack,
allowedLinkSchemes,
showLineNumbers,
totalLineCountRight,
minLineY,
lineNumbers: showLineNumbers,
maxLineY,
minLineY,
tokenizedLines: tokenizedLinesLeft,
totalLineCount: totalLineCountLeft,
visibleLines: visibleLinesLeft,
})
const rightDom = getContentRightDom({
allowedLinkSchemes,
contentRight,
errorCodeFrame: errorRightCodeFrame,
errorMessage: errorRightMessage,
errorStack: errorRightStack,
inlineChanges,
tokenizedLinesRight,
visibleLinesRight,
itemHeight,
)
lineNumbers: showLineNumbers,
maxLineY,
minLineY,
tokenizedLines: tokenizedLinesRight,
totalLineCount: totalLineCountRight,
visibleLines: visibleLinesRight,
})
const scrollBarDom = scrollBarActive ? getScrollBarDom() : []
const dom: readonly VirtualDomNode[] = [
{
Expand Down
65 changes: 44 additions & 21 deletions packages/diff-view/test/GetContentLeftDom.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ import * as ClassNames from '../src/parts/ClassNames/ClassNames.ts'
import { getContentLeftDom } from '../src/parts/GetContentLeftDom/GetContentLeftDom.ts'

test('getContentLeftDom renders each left line inside an EditorRow', (): void => {
const result = getContentLeftDom('before-content\nsecond-line', '', '', '', defaultAllowedLinkSchemes, true, 2, 0, 2)
const result = getContentLeftDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentLeft: 'before-content\nsecond-line',
lineNumbers: true,
maxLineY: 2,
minLineY: 0,
totalLineCount: 2,
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -56,7 +63,14 @@ test('getContentLeftDom renders each left line inside an EditorRow', (): void =>
})

test('getContentLeftDom omits the gutter when line numbers are disabled', (): void => {
const result = getContentLeftDom('before-content\nsecond-line', '', '', '', defaultAllowedLinkSchemes, false, 2, 0, 2)
const result = getContentLeftDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentLeft: 'before-content\nsecond-line',
lineNumbers: false,
maxLineY: 2,
minLineY: 0,
totalLineCount: 2,
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -85,7 +99,11 @@ test('getContentLeftDom omits the gutter when line numbers are disabled', (): vo
})

test('getContentLeftDom renders load errors when available', (): void => {
const result = getContentLeftDom('', 'file not found', '', 'Error: file not found\n at read missing file (/tmp/missing-file.js:12:34)')
const result = getContentLeftDom({
contentLeft: '',
errorMessage: 'file not found',
errorStack: 'Error: file not found\n at read missing file (/tmp/missing-file.js:12:34)',
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -132,11 +150,19 @@ test('getContentLeftDom renders load errors when available', (): void => {
})

test('getContentLeftDom renders paired deletion and insertion on the same row', (): void => {
const result = getContentLeftDom('shared-line\ndeleted-line', '', '', '', defaultAllowedLinkSchemes, true, 2, 0, 2, [
{ leftIndex: 0, rightIndex: 0, type: 0 },
{ leftIndex: 1, rightIndex: 1, type: 2 },
{ leftIndex: 1, rightIndex: 1, type: 1 },
])
const result = getContentLeftDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentLeft: 'shared-line\ndeleted-line',
inlineChanges: [
{ leftIndex: 0, rightIndex: 0, type: 0 },
{ leftIndex: 1, rightIndex: 1, type: 2 },
{ leftIndex: 1, rightIndex: 1, type: 1 },
],
lineNumbers: true,
maxLineY: 2,
minLineY: 0,
totalLineCount: 2,
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -187,19 +213,16 @@ test('getContentLeftDom renders paired deletion and insertion on the same row',
})

test('getContentLeftDom renders syntax-highlighted token spans', (): void => {
const result = getContentLeftDom(
'const answer = 1',
'',
'',
'',
defaultAllowedLinkSchemes,
true,
1,
0,
1,
[],
[['const', 'Token Keyword', ' answer = 1', 'Token Text']],
)
const result = getContentLeftDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentLeft: 'const answer = 1',
inlineChanges: [],
lineNumbers: true,
maxLineY: 1,
minLineY: 0,
tokenizedLines: [['const', 'Token Keyword', ' answer = 1', 'Token Text']],
totalLineCount: 1,
})

expect(result).toEqual([
{
Expand Down
55 changes: 35 additions & 20 deletions packages/diff-view/test/GetContentRightDom.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ import * as ClassNames from '../src/parts/ClassNames/ClassNames.ts'
import { getContentRightDom } from '../src/parts/GetContentRightDom/GetContentRightDom.ts'

test('getContentRightDom renders each right line inside an EditorRow', (): void => {
const result = getContentRightDom('after-content\nsecond-line', '', '', '', defaultAllowedLinkSchemes, true, 2, 0, 2)
const result = getContentRightDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentRight: 'after-content\nsecond-line',
lineNumbers: true,
maxLineY: 2,
minLineY: 0,
totalLineCount: 2,
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -56,7 +63,10 @@ test('getContentRightDom renders each right line inside an EditorRow', (): void
})

test('getContentRightDom renders load errors when available', (): void => {
const result = getContentRightDom('', 'permission denied', '', '')
const result = getContentRightDom({
contentRight: '',
errorMessage: 'permission denied',
})

expect(result).toEqual([
{
Expand All @@ -79,11 +89,19 @@ test('getContentRightDom renders load errors when available', (): void => {
})

test('getContentRightDom renders paired deletion and insertion on the same row', (): void => {
const result = getContentRightDom('shared-line\nadded-line', '', '', '', defaultAllowedLinkSchemes, true, 2, 0, 2, [
{ leftIndex: 0, rightIndex: 0, type: 0 },
{ leftIndex: 1, rightIndex: 1, type: 2 },
{ leftIndex: 1, rightIndex: 1, type: 1 },
])
const result = getContentRightDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentRight: 'shared-line\nadded-line',
inlineChanges: [
{ leftIndex: 0, rightIndex: 0, type: 0 },
{ leftIndex: 1, rightIndex: 1, type: 2 },
{ leftIndex: 1, rightIndex: 1, type: 1 },
],
lineNumbers: true,
maxLineY: 2,
minLineY: 0,
totalLineCount: 2,
})

expect(result).toEqual([
{
Expand Down Expand Up @@ -134,19 +152,16 @@ test('getContentRightDom renders paired deletion and insertion on the same row',
})

test('getContentRightDom renders syntax-highlighted token spans', (): void => {
const result = getContentRightDom(
'const answer = 1',
'',
'',
'',
defaultAllowedLinkSchemes,
true,
1,
0,
1,
[],
[['const', 'Token Keyword', ' answer = 1', 'Token Text']],
)
const result = getContentRightDom({
allowedLinkSchemes: defaultAllowedLinkSchemes,
contentRight: 'const answer = 1',
inlineChanges: [],
lineNumbers: true,
maxLineY: 1,
minLineY: 0,
tokenizedLines: [['const', 'Token Keyword', ' answer = 1', 'Token Text']],
totalLineCount: 1,
})

expect(result).toEqual([
{
Expand Down
Loading