Skip to content

User-defined segment boundaries#126

Open
alex-rawlings-yyc wants to merge 17 commits into
mainfrom
segment-boundaries
Open

User-defined segment boundaries#126
alex-rawlings-yyc wants to merge 17 commits into
mainfrom
segment-boundaries

Conversation

@alex-rawlings-yyc

@alex-rawlings-yyc alex-rawlings-yyc commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

This change is Reviewable

Summary by CodeRabbit

  • New Features
    • Added user-editable segment boundaries with split/merge controls in the token stream and merge controls in the segment list.
    • Enabled cross-boundary linking by pulling in adjacent-edge tokens, with improved enable/disable behavior and preview highlighting.
    • Persisted custom boundary edits per project, and restored them on reopen; segment list updates react immediately.
  • UI Improvements
    • Improved segment label formatting for merged and split ranges, including clearer verse-range display.
  • Bug Fixes
    • Focus and link-button availability now remain correct after segmentation edits.

@alex-rawlings-yyc alex-rawlings-yyc self-assigned this Jun 24, 2026
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@alex-rawlings-yyc, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 27 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 405bc0f3-9bbc-4e72-9333-76e7953479a5

📥 Commits

Reviewing files that changed from the base of the PR and between 7b4be0d and 3505710.

📒 Files selected for processing (2)
  • src/__tests__/components/Interlinearizer.test.tsx
  • src/components/TokenLinkIcon.tsx
📝 Walkthrough

Walkthrough

This PR adds custom segment-boundary editing across the data model, segmentation transforms, UI controls, persistence, and navigation. It also updates segment labels, adjacent-edge linking, and test coverage for boundary-aware behavior.

Changes

User-defined segment boundary editing

Layer / File(s) Summary
Contracts and lookup shapes
src/types/interlinearizer.d.ts, src/types/type-guards.ts, src/types/token-layout.ts, src/hooks/useBookIndexes.ts, src/utils/segment-labels.ts, src/utils/verse-ref.ts
Adds segmentation delta types and validation, adjacent-edge focus metadata, expanded book indexes, verse containment checks, and string-based segment labels.
Segmentation transforms and resegmentation
src/utils/segmentation.ts, src/utils/phrase-arc.ts, src/parsers/papi/resegmentBook.ts
Implements pure boundary-edit transforms, detects phrases straddling boundaries, and rebuilds books from custom segmentation deltas.
Boundary-edit state and rendering
src/components/SegmentationStore.tsx, src/components/Interlinearizer.tsx, src/components/SegmentListView.tsx, src/components/SegmentView.tsx, src/components/PhraseStripParts.tsx, src/components/PhraseBox.tsx, src/components/TokenLinkIcon.tsx, src/components/ContinuousView.tsx, src/hooks/useSegmentWindow.ts, src/components/AnalysisStore.tsx, src/tailwind.css, __mocks__/lucide-react.tsx, contributions/localizedStrings.json
Threads segmentation context through the UI, adds boundary controls, adjacent-edge linking, candidate styling, merge-row controls, and boundary-aware focus and recenter behavior.
Draft autosave and project save flow
src/hooks/useDraftProject.ts, src/main.ts, src/services/projectStorage.ts, src/components/modals/ProjectModals.tsx, src/components/InterlinearizerLoader.tsx
Persists segmentation deltas through draft autosave, command handling, storage writes, project open/save, and loader wiring.
Tests and support files
src/__tests__/*, user-questions.md, cspell.json
Adds coverage for segmentation transforms, boundary UI, persistence, navigation, labels, and related copy/support updates.

Estimated code review effort: 5 (Critical) | ~120 minutes

Sequence Diagram(s)

sequenceDiagram
  participant PhraseSlot
  participant BoundaryControl
  participant SegmentationProvider
  participant Interlinearizer
  participant InterlinearizerLoader
  PhraseSlot->>BoundaryControl: render merge or split button
  BoundaryControl->>SegmentationProvider: dispatch.merge or dispatch.split
  SegmentationProvider->>Interlinearizer: forceBreakStraddledPhrases before delegating
  Interlinearizer->>InterlinearizerLoader: segmentationDispatch.merge/split/move
  InterlinearizerLoader->>InterlinearizerLoader: apply transform, autosaveSegmentation
Loading
sequenceDiagram
  participant InterlinearizerLoader
  participant useDraftProject
  participant ProjectModals
  participant saveInterlinearAnalysis
  participant projectStorage
  InterlinearizerLoader->>useDraftProject: autosaveSegmentation(delta)
  useDraftProject->>useDraftProject: debounce persist, increment segmentationVersion
  ProjectModals->>saveInterlinearAnalysis: saveAnalysis(id, analysisJson, segmentationJson)
  saveInterlinearAnalysis->>projectStorage: updateAnalysis(token, id, analysis, segmentation)
  projectStorage-->>ProjectModals: updated project
  ProjectModals->>useDraftProject: markSynced(analysis, segmentation)
Loading

Possibly related PRs

Suggested labels: 🟪Idea, up next

Suggested reviewers: imnasnainaec

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR’s main change: adding user-defined segment boundaries.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch segment-boundaries

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@alex-rawlings-yyc alex-rawlings-yyc linked an issue Jun 24, 2026 that may be closed by this pull request
Base automatically changed from verse-zero to main June 24, 2026 18:18
@alex-rawlings-yyc alex-rawlings-yyc force-pushed the segment-boundaries branch 5 times, most recently from 11eb61a to 1c939f6 Compare July 6, 2026 15:30
coderabbitai[bot]

This comment was marked as outdated.

@alex-rawlings-yyc alex-rawlings-yyc left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alex-rawlings-yyc resolved 1 discussion.
Reviewable status: 0 of 50 files reviewed, all discussions resolved (waiting on alex-rawlings-yyc).

@alex-rawlings-yyc alex-rawlings-yyc marked this pull request as ready for review July 6, 2026 17:50
alex-rawlings-yyc and others added 13 commits July 6, 2026 12:21
Verse-0 superscriptions are ordinary segments now: addBoundaryBefore,
removeBoundaryAt, and moveBoundary no longer refuse edits that touch a
superscription's interior or its bordering boundaries. The UI-side wall
comes out separately.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The resegmented book is derived from the draft's ref-held segmentation,
and the auto-save's setDirty(true) bails out of the re-render once the
draft is already dirty — so clicking merge/split updated the stored
delta without updating the view. useDraftProject now bumps a dedicated
segmentationVersion on every boundary edit, and the loader keys the
resegment memo on it so the new boundaries take effect in place without
remounting the editor.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
After a merge/split a segment no longer corresponds 1:1 to a verse, so
the old verse-number header could repeat or skip. Each segment now
shows a per-chapter sequential segment number (starting at 0 for a
verse-0 superscription) with the verse range it contains beside it,
e.g. "2 (2–3)". The labels are built once over the whole book by a new
pure segment-labels util so the numbering doesn't depend on which
window slice is mounted.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
phrasesStraddlingBoundary finds every phrase a proposed segment
boundary would cut (including the gap between fragments of a
discontiguous phrase) and pairs each with the split point that severs
it cleanly at the boundary. usePhraseLinkByIdGetter exposes a stable,
non-subscribing read of the phrase-link map for event-time callers.
Both are consumed by the boundary-control rework that follows: one
predicate shared by the force-break dispatch and the split-control
suppression so the two can't drift apart.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Segment-boundary editing is no longer a separate mode toggled from the
view options. Instead:

- The between-group slots always carry a boundary control alongside the
  link icon: a split control inside a segment (hover-revealed with the
  slot) and a horizontal-fold merge control at a segment boundary in
  the continuous strip.
- The segment list gets an always-visible full-width merge button in
  the gap between adjacent rows.
- Hovering any of these previews the operation: the affected token
  groups render a new strong phrase-candidate outline (distinct from
  and outranking hover/focus), and hovered row merges outline and tint
  the two rows they would join.
- The not-mid-phrase rule becomes a UI-only guard sharing one predicate
  (phrasesStraddlingBoundary) with the dispatch: the split control
  hides and the cross-segment pull disables at boundaries that would
  cut a phrase, while the wrapped segmentation dispatch force-breaks
  straddled phrases for callers that cannot see them.
- The verse-0 hard wall comes out of the UI to match the model:
  superscriptions merge and split like any other segment. Merged-away
  default verse boundaries render a faint former-boundary tick
  (formerBoundaryRefs replaces verseZeroSegmentIds in the segmentation
  context) so a split can restore the original segmentation.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
A merge/split hands the views a fresh book object while every token
ref survives, and the old code treated that like a book swap:

- Interlinearizer reseeded focusedTokenRef to the active verse's first
  word (or the book's first phrase when a merge removed the active
  verse's segment start). It now keeps a still-resolving focus and
  reseeds only when the token no longer exists in the new book.
- useSegmentWindow faded and recentered on the new segments identity,
  snapping away from the point just clicked. A segments change at an
  unchanged anchor verse now redraws in place with no fade.
- ContinuousView's committed active segment kept naming a segment that
  no longer existed, deactivating every link button until the next
  navigation; a reconcile effect commits the new id when a segmentation
  edit changes the focused token's segment without moving focus. The
  instant-jump reveal also re-centers each frame through the link-slot
  transition so async arc/morpheme layout can't drift the strip
  off-center.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Rewrites the segment-boundaries section for the no-edit-mode UX:
always-available controls (item 5), superscriptions as ordinary
segments (item 6, replacing the hard-wall interim), and silent
force-breaking of straddled phrases (new item 7).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
editing

Persistence: Open now loads a project's stored segmentation (validated)
into
the draft, and Save As / Overwrite send segmentationJson alongside the
analysis, so custom boundaries survive the full save/open loop instead
of
being silently wiped. markSynced compares both the analysis and
segmentation
snapshots, so a boundary edit made during a save round-trip keeps the
draft
dirty.

Boundary edits: the cross-segment pull anchors the moved boundary on the
next
word token (merging wholly when only trailing punctuation remains), so a
pull
can no longer strand a punctuation-only segment or record a punctuation
ref
in addedStarts. Former boundaries are exposed as a word-anchored map so
punct-initial verses show the restore tick and split back to the exact
default boundary. Boundary controls disable while a phrase mode is
active,
closing a path that could restore a phrase spanning two segments.

Segment window: an explicit segmentationVersion signal (threaded from
the
loader) replaces the verse-key inference, so a merge absorbing the
active
verse no longer flashes a recenter fade and a re-tokenized book
recenters
again.

Performance: the loader's book/formerBoundaries memos key on version
counters
(plus isDraftLoading for the initial load) instead of the draft
identity, so
gloss autosaves no longer re-run full-book resegmentation; the
not-mid-phrase
guard is a straddled-boundary set precomputed once per phrase-link
change,
replacing per-slot link scans and store subscriptions.

Cleanups: useBookIndexes owns segmentOrder/fullTokenOrder/wordRefByOrder
in
its single pass; autosaveDraft unifies the analysis/segmentation
autosave
pipelines; ContinuousView shares one holdCentered loop and reuses
commitPendingActiveSegment; saveAnalysis's command schema documents
segmentationJson; user-questions.md describes the shipped always-visible
boundary controls.

@imnasnainaec imnasnainaec left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@imnasnainaec reviewed 4 files and all commit messages, and made 3 comments.
Reviewable status: 4 of 50 files reviewed, 3 unresolved discussions (waiting on alex-rawlings-yyc).


a discussion (no related file):
After splitting or joining, I find the numbering in the segment view confusing. Rather than (e.g.) 1 (1), 2 (1), 3 (1-2), 4(3), ..., what about dropping the segment number and using lettering, like (e.g.) 1a, 1b, 1c-2, 3, ... ?


a discussion (no related file):
The external jumps aren't quite working in this case: split verse 1 and join the second half with verses 2 and 3. An external move to v2 or v3 jumps to the first half of v1, rather than the 1b-3 segment.


contributions/localizedStrings.json line 47 at r2 (raw file):

      "%interlinearizer_tokenChip_defineMorphemes%": "Define morpheme breakdown for {token}",
      "%interlinearizer_linkButton_crossSegmentDisabledTooltip%": "Only a free edge token of an adjacent segment can be linked across a boundary.",
      "%interlinearizer_boundaryControl_merge%": "Merge with previous segment",

⛏️ I think "Merge segments" makes morse sense with the current UI.

Replace the per-chapter segment ordinal with verse-based labels (1a, 1b,
1c–2, 3), and match verses to segments by range containment instead of
exact start-verse match, so external jumps to a verse inside a merged or
split segment land on the segment that contains it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adjust segment boundaries

2 participants