mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-05 15:03:39 -05:00
106 lines
2.8 KiB
TypeScript
106 lines
2.8 KiB
TypeScript
|
import {
|
||
|
EditorState,
|
||
|
RangeSet,
|
||
|
StateEffect,
|
||
|
StateField,
|
||
|
Transaction,
|
||
|
} from '@codemirror/state'
|
||
|
import {
|
||
|
findCommentsInCut,
|
||
|
findDetachedCommentsInChanges,
|
||
|
restoreCommentsOnPaste,
|
||
|
restoreDetachedComments,
|
||
|
StoredComment,
|
||
|
} from './changes/comments'
|
||
|
import { invertedEffects } from '@codemirror/commands'
|
||
|
import { DocumentContainer } from '@/features/ide-react/editor/document-container'
|
||
|
import { isSplitTestEnabled } from '@/utils/splitTestUtils'
|
||
|
import { buildChangeMarkers } from './track-changes'
|
||
|
|
||
|
const restoreDetachedCommentsEffect = StateEffect.define<RangeSet<any>>({
|
||
|
map: (value, mapping) => {
|
||
|
return value
|
||
|
.update({
|
||
|
filter: (from, to) => {
|
||
|
return from <= mapping.length && to <= mapping.length
|
||
|
},
|
||
|
})
|
||
|
.map(mapping)
|
||
|
},
|
||
|
})
|
||
|
|
||
|
/**
|
||
|
* A custom extension that detects detached comments when a comment is cut and pasted,
|
||
|
* or when a deleted comment is undone
|
||
|
*/
|
||
|
export const trackDetachedComments = ({
|
||
|
currentDoc,
|
||
|
}: {
|
||
|
currentDoc: DocumentContainer
|
||
|
}) => {
|
||
|
// A state field that stored any comments found within the ranges of a "cut" transaction,
|
||
|
// to be restored when pasting matching text.
|
||
|
const cutCommentsState = StateField.define<StoredComment[]>({
|
||
|
create: () => {
|
||
|
return []
|
||
|
},
|
||
|
update: (value, transaction) => {
|
||
|
if (transaction.annotation(Transaction.remote)) {
|
||
|
return value
|
||
|
}
|
||
|
|
||
|
if (!transaction.docChanged) {
|
||
|
return value
|
||
|
}
|
||
|
|
||
|
if (transaction.isUserEvent('delete.cut')) {
|
||
|
return findCommentsInCut(currentDoc, transaction)
|
||
|
}
|
||
|
|
||
|
if (transaction.isUserEvent('input.paste')) {
|
||
|
restoreCommentsOnPaste(currentDoc, transaction, value)
|
||
|
return []
|
||
|
}
|
||
|
|
||
|
return value
|
||
|
},
|
||
|
})
|
||
|
|
||
|
return [
|
||
|
// attach any comments detached by the transaction as an inverted effect, to be applied on undo
|
||
|
invertedEffects.of(transaction => {
|
||
|
if (
|
||
|
transaction.docChanged &&
|
||
|
!transaction.annotation(Transaction.remote)
|
||
|
) {
|
||
|
const detachedComments = findDetachedCommentsInChanges(
|
||
|
currentDoc,
|
||
|
transaction
|
||
|
)
|
||
|
if (detachedComments.size) {
|
||
|
return [restoreDetachedCommentsEffect.of(detachedComments)]
|
||
|
}
|
||
|
}
|
||
|
return []
|
||
|
}),
|
||
|
|
||
|
// restore any detached comments on undo
|
||
|
EditorState.transactionExtender.of(transaction => {
|
||
|
for (const effect of transaction.effects) {
|
||
|
if (effect.is(restoreDetachedCommentsEffect)) {
|
||
|
// send the comments to the ShareJS doc
|
||
|
restoreDetachedComments(currentDoc, transaction, effect.value)
|
||
|
|
||
|
if (isSplitTestEnabled('review-panel-redesign')) {
|
||
|
// return a transaction spec to rebuild the change markers
|
||
|
return buildChangeMarkers()
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
return null
|
||
|
}),
|
||
|
|
||
|
cutCommentsState,
|
||
|
]
|
||
|
}
|