@nerd-bible/wordgard 0.3.5 → 0.5.2-beta

package/README.md

@@ -1,6 +1,6 @@
 # Wordgard
 
-[ [**WEBSITE**](https://wordgard.net/) | [**DOCS**](https://wordgard.net/docs/) | [**ISSUES**](https://code.haverbeke.berlin/wordgard/wordgard/issues) | [**FORUM**](https://discuss.wordgard.net/)
+[ [**WEBSITE**](https://wordgard.net/) | [**DOCS**](https://wordgard.net/docs/) | [**ISSUES**](https://code.haverbeke.berlin/wordgard/wordgard/issues) | [**FORUM**](https://discuss.wordgard.net/) ]
 
 This is the [Wordgard](https://wordgard.net) package. It implements a
 rich text editor framework for the browser.

package/dist/command.d.ts

@@ -510,8 +510,9 @@ declare const insertLineBreak: Command.Pure;
 /**
 The command that handles enter presses. The default handler will,
 if the selection is not in an inline context, insert an empty
-default textblock in its position. Otherwise it first tries
-`liftEmptyTextblock`, then `splitTextblock`.
+default textblock in its position. Otherwise it first tries {@link
+enterInCode}, then {@link liftEmptyBlock}, and finally {@link
+splitTextblock}.
 */
 declare const enter: Command.Pure;
 /**
@@ -694,6 +695,17 @@ parent, return a transaction that does this.
 */
 declare function liftEmptyBlock(state: GardState): Transaction.Spec | false;
 /**
+If the selection is in a {@link Plot.Spec.preserveWhitespace
+`preserveWhitespace`} textblock, replace the selected content with
+a {@link Schema.lineBreak line break}.
+
+If the selection additionally is a cursor on an otherwise empty
+line after a blank line, split or trunctate (if at end) the parent
+textblock and create a blank default text block in place of the
+empty line.
+*/
+declare function enterInCode(state: GardState): Transaction.Spec | false;
+/**
 Split the textblock at the cursor position, if any. If the
 textblock is the first child of a list item, also split that item,
 unless `splitListItem` is false.
@@ -705,11 +717,11 @@ selection is empty.
 */
 declare function deleteSelection(state: GardState): Transaction.Spec | false;
 /**
-If the cursor is inside an empty textblock, return a transaction
-that deletes the entire block. `dir` determines which way the
-cursor moves after the deletion.
+If the cursor is inside an empty plot, return a transaction that
+deletes the entire plot. `dir` determines which way the cursor
+moves after the deletion.
 */
-declare function deleteEmptyTextblock(state: GardState, dir?: -1 | 1): Transaction.Spec | false;
+declare function deleteEmptyPlot(state: GardState, dir?: -1 | 1): Transaction.Spec | false;
 /**
 If the cursor is at the start of a textblock that can be joined to
 a textblock before it, return a transaction to performs this join.
@@ -793,4 +805,4 @@ updated to perform those joins.
 */
 declare function autoJoinBlocks(state: GardState, tr: Transaction.Spec): Transaction.Spec;
 
-export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyTextblock, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange };
+export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange };

package/dist/command.js

@@ -62,7 +62,7 @@ function liftEmptyBlock(state) {
                 scrollIntoView: true,
                 userEvent: "unwrap.empty"
             };
-        if (level.node.type.isInline || level.node.type.isolating)
+        if (level.node.isInline || level.node.type.isolating)
             break;
         if (index)
             atStart = false;
@@ -79,6 +79,35 @@ function liftEmptyBlock(state) {
     }
     return false;
 }
+function enterInCode(state) {
+    let { sel } = state, { head } = sel;
+    if (!head.parent.node.inlineContent || !head.parent.node.type.preserveWhitespace ||
+        head.parent.start != sel.anchor.parent.start || !state.schema.lineBreak)
+        return false;
+    if (sel.selection.empty && head.parent.parent && !head.inText && head.index > 1 &&
+        head.nodeBefore.type == state.schema.lineBreak.type &&
+        (head.pos == head.parent.end || head.nodeAfter.type == state.schema.lineBreak.type) &&
+        head.parent.node.content[head.index - 2].type == state.schema.lineBreak.type) {
+        let textblock = state.schema.defaultContentPlot(head.parent.parent.node.type);
+        if (textblock?.type.inlineContent)
+            return {
+                changes: {
+                    from: head.pos - 2, to: head.pos + 1,
+                    insert: head.pos == head.parent.end ? [Plot.End, textblock, Plot.End]
+                        : [Plot.End, textblock, Plot.End, head.parent.node.tag]
+                },
+                selection: GardSelection.cursor(head.pos, -1),
+                scrollIntoView: true,
+                userEvent: "split.textblock"
+            };
+    }
+    return {
+        changes: { from: sel.from.pos, to: sel.to.pos, insert: [state.schema.lineBreak] },
+        selection: GardSelection.cursor(sel.from.pos + 1, -1),
+        scrollIntoView: true,
+        userEvent: "input"
+    };
+}
 function splitTextblock(state, splitListItem = true) {
     let { from, to } = state.sel.replacementRange, { schema } = state.doc;
     let before = from.textblockParent;
@@ -150,14 +179,14 @@ function deleteSelection(state) {
         userEvent: "delete.selection"
     });
 }
-function deleteEmptyTextblock(state, dir = -1) {
+function deleteEmptyPlot(state, dir = -1) {
     if (!state.selection.isCursor)
         return false;
-    let block = state.sel.head.textblockParent;
-    if (!block || block.start < block.end || block.before == 0 && block.after == state.doc.length)
+    let plot = state.sel.head.parent;
+    if (!plot.parent || plot.start < plot.end)
         return false;
     return {
-        changes: { from: block.before, to: block.after, fit: true },
+        changes: { from: plot.before, to: plot.after, fit: true },
         selection: (cx, changes) => GardSelection.near(cx, changes.mapPos(state.selection.head), dir),
         scrollIntoView: true,
         userEvent: dir < 0 ? "delete.backward" : "delete.forward"
@@ -174,12 +203,12 @@ function joinBackward(state) {
         if (!scan.parent)
             return false;
         scan = scan.parent;
-        if (scan.node.type.isolating || !scan.node.type.isBlock)
+        if (scan.node.type.isolating || !scan.node.isBlock)
             return false;
     }
     let before = scan.previousSibling, parent = scan.parent.node, pos = scan.start - 1;
     while (before.isLeaf || !before.isTextblock) {
-        if (before.isLeaf || state.isAtom(before.type) || before.type.isolating || !before.type.isBlock)
+        if (before.isLeaf || state.isAtom(before.type) || before.type.isolating || !before.isBlock)
             return false;
         let last = before.content.length - 1;
         if (last < 0)
@@ -216,7 +245,7 @@ function joinListItems(state) {
         let next = scan.parent;
         if (!next)
             return false;
-        if (scan.node.type.isBlock && next.node.type.hasRole(Node.Role.List)) {
+        if (scan.node.isBlock && next.node.type.hasRole(Node.Role.List)) {
             const prev = scan.previousSibling;
             if (!prev || !prev.isLeaf && scan.node.content.some(ch => !state.schema.canContain(prev.type, ch.type)))
                 return false;
@@ -244,12 +273,12 @@ function joinForward(state) {
         if (scan.index < scan.parent.node.content.length - 1)
             break;
         scan = scan.parent;
-        if (scan.node.type.isolating || !scan.node.type.isBlock)
+        if (scan.node.type.isolating || !scan.node.isBlock)
             return false;
     }
     let after = scan.nextSibling, parent = scan.parent.node, pos = scan.after;
     while (after.isLeaf || !after.isTextblock) {
-        if (after.isLeaf || after.type.isolating || state.isAtom(after.type) || !after.type.isBlock || !after.content.length)
+        if (after.isLeaf || after.type.isolating || state.isAtom(after.type) || !after.isBlock || !after.content.length)
             return false;
         parent = after;
         after = after.content[0];
@@ -279,7 +308,7 @@ function deleteBackward(state, word = false) {
     let { parent: scan, index, pos } = sel.head;
     if (!sel.head.inText)
         while (!index) {
-            if (scan.node.type.isolating || !scan.parent)
+            if (scan.node.type.isolating || !scan.parent || (!scan.node.contentLength && scan.node.isInline))
                 return false;
             index = scan.index;
             scan = scan.parent;
@@ -289,12 +318,9 @@ function deleteBackward(state, word = false) {
     for (;;) {
         if (next.isPlot && next.type.isolating)
             return false;
-        if (next.isLeaf || state.isAtom(next.type))
+        if (next.isLeaf || state.isAtom(next.type) || !next.content.length)
             break;
-        let last = next.content.length - 1;
-        if (last < 0)
-            return false;
-        next = next.content[last];
+        next = next.content[next.content.length - 1];
         pos--;
     }
     if (next.is(Leaf.Text)) {
@@ -336,13 +362,14 @@ function deleteBackward(state, word = false) {
     }
     let from = pos - next.length, to = pos;
     let parent = state.doc.resolve(pos).parent;
-    while (parent && parent.node.type.isBlock && parent.node.content.length == 1) {
-        if (!parent.parent)
-            return false;
-        parent = parent.parent;
-        from--;
-        to++;
-    }
+    if (next.isBlock)
+        while (parent && parent.node.isBlock && parent.node.content.length == 1) {
+            if (!parent.parent)
+                return false;
+            parent = parent.parent;
+            from--;
+            to++;
+        }
     return {
         changes: { from, to },
         scrollIntoView: true,
@@ -356,7 +383,7 @@ function deleteForward(state, word = false) {
     let { parent: scan, index, pos } = sel.head;
     if (!sel.head.inText)
         while (index == scan.node.content.length) {
-            if (scan.node.type.isolating || !scan.parent)
+            if (scan.node.type.isolating || !scan.parent || (!scan.node.contentLength && scan.node.isInline))
                 return false;
             index = scan.index + 1;
             scan = scan.parent;
@@ -366,10 +393,8 @@ function deleteForward(state, word = false) {
     for (;;) {
         if (next.isPlot && next.type.isolating)
             return false;
-        if (next.isLeaf || state.isAtom(next.type))
+        if (next.isLeaf || state.isAtom(next.type) || !next.content.length)
             break;
-        if (!next.content.length)
-            return false;
         next = next.content[0];
         pos++;
     }
@@ -412,13 +437,14 @@ function deleteForward(state, word = false) {
     }
     let from = pos, to = pos + next.length;
     let parent = state.doc.resolve(pos).parent;
-    while (parent && parent.node.type.isBlock && parent.node.content.length == 1) {
-        if (!parent.parent)
-            return false;
-        parent = parent.parent;
-        from--;
-        to++;
-    }
+    if (next.isBlock)
+        while (parent && parent.node.isBlock && parent.node.content.length == 1) {
+            if (!parent.parent)
+                return false;
+            parent = parent.parent;
+            from--;
+            to++;
+        }
     return {
         changes: { from, to },
         scrollIntoView: true,
@@ -513,7 +539,7 @@ function findUnwrappable(schema, from, to, query) {
     let outerCandidates = [];
     let { doc } = from;
     doc.iterate(fromStart, toEnd, (node, p, parent) => {
-        if (node.type.isBlock && node.isPlot && !node.inlineContent && parent &&
+        if (node.isBlock && node.isPlot && !node.inlineContent && parent &&
             (fromTextblock ? doc.schema.canContain(parent.type, fromTextblock) : textblockChild(doc.schema, parent.type)) &&
             (!query || schema.matchNode(node.type, query))) {
             let pos = doc.resolveNode(p), depth = pos.depth;
@@ -678,13 +704,13 @@ function autoJoinBlocks(state, tr) {
     let cursor = doc.resolve(0), check = (pos) => {
         cursor = cursor.advance(pos - cursor.pos);
         let before = cursor.nodeBefore, after = cursor.nodeAfter;
-        if (before && after && before.isPlot && before.type.isBlock && after.isPlot && after.type == before.type) {
+        if (before && after && before.isPlot && before.isBlock && after.isPlot && after.type == before.type) {
             let { autoJoin } = after.type.spec;
             if (autoJoin && (typeof autoJoin != "function" || autoJoin(before.tag, after.tag))) {
                 let from = pos - 1, to = pos + 1;
                 for (;;) {
                     let last = before.lastChild, first = after.firstChild;
-                    if (!first || !last || first.isLeaf || last.isLeaf || first.type != last.type || first.type.isInline)
+                    if (!first || !last || first.isLeaf || last.isLeaf || first.type != last.type || first.isInline)
                         break;
                     autoJoin = last.type.spec.autoJoin;
                     if (!autoJoin || (typeof autoJoin == "function" && !autoJoin(last.tag, first.tag)))
@@ -760,21 +786,21 @@ const enter = ({ state }) => {
             userEvent: "insert.textblock"
         };
     }
-    return liftEmptyBlock(state) || splitTextblock(state);
+    return enterInCode(state) || liftEmptyBlock(state) || splitTextblock(state);
 };
 const deleteUnit = ({ state }, dir) => {
     if (state.readOnly)
         return false;
     return deleteSelection(state) || (dir == "forward"
-        ? joinForward(state) || deleteForward(state) || deleteEmptyTextblock(state, 1)
-        : joinListItems(state) || joinBackward(state) || deleteBackward(state) || deleteEmptyTextblock(state, -1));
+        ? joinForward(state) || deleteForward(state) || deleteEmptyPlot(state, 1)
+        : joinListItems(state) || joinBackward(state) || deleteBackward(state) || deleteEmptyPlot(state, -1));
 };
 const deleteWord = ({ state }, dir) => {
     if (state.readOnly)
         return false;
     return deleteSelection(state) || (dir == "forward"
-        ? joinForward(state) || deleteForward(state, true) || deleteEmptyTextblock(state, 1)
-        : joinListItems(state) || joinBackward(state) || deleteBackward(state, true) || deleteEmptyTextblock(state, -1));
+        ? joinForward(state) || deleteForward(state, true) || deleteEmptyPlot(state, 1)
+        : joinListItems(state) || joinBackward(state) || deleteBackward(state, true) || deleteEmptyPlot(state, -1));
 };
 const deleteToLineEnd = (wg, dir) => {
     if (wg.state.readOnly)
@@ -1101,8 +1127,7 @@ function extendSel(base, head) {
 const moveByUnit = ({ state }, { dir, extend }) => {
     let forward = isForward(dir, state), selection = asTextSel(state.selection, forward);
     if (!selection.empty && !extend) {
-        let next = selection.normalCursorAtBound(state, forward);
-        return next ? setSelection(next) : false;
+        return setSelection(GardSelection.near(state, forward ? selection.to : selection.from, forward ? -1 : 1));
     }
     else {
         let next = selection.nextNormalCursor(state, forward);
@@ -1133,10 +1158,10 @@ function nextVertical(wg, sel, forward, distance, allowNode) {
 }
 const moveByLine = (wg, { dir, extend }) => {
     let { state } = wg, { selection } = state, forward = dir == "down";
-    if (state.selection instanceof GardSelection.Node) {
-        let next = !extend && state.selection.normalCursorAtBound(state, forward);
+    if (selection instanceof GardSelection.Node) {
+        let next = !extend && GardSelection.near(state, forward ? selection.to : selection.from, forward ? -1 : 1);
         if (next && !state.doc.resolve(next.head).parent.node.inlineContent)
-            return setSelection(GardSelection.cursor(next.head, next.headSide, state.selection.goalColumn));
+            return setSelection(GardSelection.cursor(next.head, next.headSide, selection.goalColumn));
         selection = GardSelection.cursor(forward ? selection.to : selection.from, undefined, selection.goalColumn);
     }
     else {
@@ -1163,8 +1188,11 @@ const moveByPage = (wg, { dir, extend }) => {
     return moved ? setSelection(extend ? extendSel(selection, moved) : moved) : false;
 };
 const moveToLineSide = (wg, { dir, extend }) => {
-    let pos = wg.moveToLineBoundary(wg.state.selection, isForward(dir, wg.state));
-    return pos ? setSelection(extend ? extendSel(wg.state.selection, pos) : pos) : false;
+    let forward = isForward(dir, wg.state), { selection } = wg.state;
+    let pos = wg.moveToLineBoundary(selection, forward);
+    return pos ? setSelection(extend ? extendSel(selection, pos) : pos)
+        : extend || selection.empty ? false
+            : setSelection(GardSelection.near(wg.state, forward ? selection.to : selection.from));
 };
 const moveToTextblockSide = (wg, { dir, extend }) => {
     let { state } = wg, block = state.sel.head.textblockParent;
@@ -1448,4 +1476,4 @@ const Menu = /*@__PURE__*/(function (Menu) {
     Menu.resolve = resolve;
 ;return Menu})({});
 
-export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyTextblock, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange };
+export { Command, Menu, autoJoinBlocks, canAddMarkInRange, clearNonFitting, deleteBackward, deleteEmptyPlot, deleteForward, deleteLine, deleteSelection, deleteToLineEnd, deleteUnit, deleteWord, doUnwrapBlock, enter, enterInCode, findUnwrappable, findWrappable, insertLineBreak, insertText, joinBackward, joinBlocks, joinForward, joinListItems, liftEmptyBlock, listIsActive, moveByLine, moveByPage, moveByUnit, moveByWord, moveToDocSide, moveToLineSide, moveToTextblockSide, redo, selectAll, selectedTextblocks, setAlignment, setDirection, setTextblockType, splitTextblock, toggleBlock, toggleEmphasis, toggleList, toggleMark, toggleStrong, toggleUnderline, transposeChars, undo, unwrapBlock, wrapBlock, wrapBlockRange };

package/dist/doc.d.ts

@@ -250,7 +250,7 @@ declare class Elt<T = string> {
     /**
     Convert an element (with only string content) to a DOM tree.
     */
-    toDOM(this: Elt<string>, doc?: Document): Element | Text;
+    toDOM(this: Elt<string>, doc?: Document): Element;
 }
 declare namespace Elt {
     /**
@@ -1136,6 +1136,14 @@ declare namespace Node {
         */
         isPlot: boolean;
         /**
+        True when this node is a block node.
+        */
+        isBlock: boolean;
+        /**
+        Indicate whether this is an inline node.
+        */
+        isInline: boolean;
+        /**
         Convert this node to its JSON-serializeable representation.
         */
         toJSON(): Node.JSON;
@@ -1415,6 +1423,8 @@ declare class Leaf<Param = unknown> extends BaseTag<Param> implements Node.Share
     get tokenType(): Token.Type.Node;
     get isLeaf(): true;
     get isPlot(): false;
+    get isInline(): boolean;
+    get isBlock(): boolean;
     get length(): number;
     /**
     Create a text node with the given text and mark set.
@@ -1469,6 +1479,9 @@ declare namespace Leaf {
     a given set of marks. The only leaf with a length that isn't
     always 1. Adjacent text leaves with the same marks are merged
     automatically.
+    
+    Text leaves must not include newline or return characters. Line
+    breaks in the document are modeled with {@link LineBreak} nodes.
     */
     const Text: Leaf.Type<string>;
 }
@@ -1518,6 +1531,8 @@ declare class Plot implements Node.Shared {
     get isTextblock(): boolean;
     get isLeaf(): false;
     get isPlot(): true;
+    get isInline(): boolean;
+    get isBlock(): boolean;
     /**
     True if this is a document node.
     */
@@ -1813,13 +1828,6 @@ declare namespace Plot {
         this to true on a textblock type will prevent that behavior.
         */
         preserveOnSplitAtEnd?: boolean;
-        /**
-        For inline nodes with inline content, this determines whether
-        there are normalized cursor positions directly inside the node.
-        The default is to only have cursor positions right outside the
-        node.
-        */
-        cursorInsideBounds?: boolean;
     }
     /**
     Document plots are used as the top level plot in a document.
@@ -2012,7 +2020,7 @@ declare class ChangeSet {
     position of the range in the original document, `posB` the
     position in the changed document.
     */
-    iterGaps(gap: (fromA: number, toA: number, fromB: number, toB: number) => void, change?: (fromA: number, toA: number, fromB: number, toB: number) => void): void;
+    iterGaps(gap: (fromA: number, toA: number, fromB: number, toB: number, last: boolean) => void, change?: (fromA: number, toA: number, fromB: number, toB: number) => void): void;
     /**
     Iterate over the ranges changed (either replaced or modified) by
     this change desc. Joins adjacent changed ranges together.