Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

4.2 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */
import type { EditorState, Transaction } from "@codemirror/state";
import type { EditorView, ViewUpdate } from "@codemirror/view";
import { getCM } from "@replit/codemirror-vim";
import type { ReactCodeMirrorRef } from "@uiw/react-codemirror";

export function isAtStartOfEditor(ev: { state: EditorState }) {
  const main = ev.state.selection.main;
  return main.from === 0 && main.to === 0;
}

/**
 * Check if the cursor is at the end of the editor.
 *
 * If Vim is enabled, we also allow the second to last character to be selected,
 * since Vim's "normal" mode will select the last character.
 */
export function isAtEndOfEditor(ev: { state: EditorState }, isVim = false) {
  const main = ev.state.selection.main;
  const docLength = ev.state.doc.length;

  if (isVim && main.from === docLength - 1 && main.to === docLength - 1) {
    return true;
  }

  return main.from === docLength && main.to === docLength;
}

export function moveToEndOfEditor(ev: EditorView | undefined) {
  if (!ev) {
    return;
  }
  ev.dispatch({
    selection: {
      anchor: ev.state.doc.length,
      head: ev.state.doc.length,
    },
  });
}

/** We delay the focus and move to end of the editor until React has rendered the prefilled value. */
export function focusInputAndMoveToEnd(
  ref: React.RefObject<ReactCodeMirrorRef | null>,
) {
  requestAnimationFrame(() => {
    const view = ref.current?.view;
    if (!view) {
      return;
    }
    view.focus();
    moveToEndOfEditor(view);
  });
}

/**
 * Scrolls the `.marimo-cell` that owns `view` into view.
 *
 * `EditorView.scrollIntoView` doesn't work in columns mode: it stops at the
 * first overflowing ancestor even if that ancestor doesn't actually scroll,
 * so it never reaches the real horizontally-scrolling container. The
 * browser's native `Element.scrollIntoView` doesn't have that problem.
 *
 * Deferred a frame so CodeMirror's own scroll settles first; otherwise it
 * clamps this scroll right back.
 *
 * https://github.com/marimo-team/marimo/issues/10222
 */
export function scrollOwnerCell(view: EditorView): void {
  const cell = view.dom.closest(".marimo-cell");
  if (!cell) {
    return;
  }

  requestAnimationFrame(() => {
    cell.scrollIntoView({
      behavior: "instant",
      block: "nearest",
      inline: "nearest",
    });
  });
}

export function isInVimMode(ev: EditorView): boolean {
  return getCM(ev)?.state.vim != null;
}

export function isInVimNormalMode(ev: EditorView): boolean {
  const vimState = getCM(ev)?.state.vim;
  if (!vimState) {
    return false;
  }
  // If mode is not defined, check 'insertMode' and 'visualMode' instead
  if (!vimState.mode && !vimState.insertMode && !vimState.visualMode) {
    return true;
  }
  return vimState.mode === "normal";
}

export function selectAllText(ev: EditorView | undefined) {
  if (!ev) {
    return;
  }
  ev.dispatch({
    selection: {
      anchor: 0,
      head: ev.state.doc.length,
    },
  });
}

/**
 * Checks if a transaction contains changes that add or remove line breaks.
 *
 * @param tr The CodeMirror transaction to check
 * @returns True if the transaction adds or removes line breaks, false otherwise
 */
export function hasNewLines(tr: Transaction | ViewUpdate): boolean {
  // If there are no changes in the transaction, return false
  if (!tr.docChanged) {
    return false;
  }

  let hasNewLines = false;
  // Iterate through all changes in the transaction
  // oxlint-disable-next-line marimo/prefer-object-params -- CodeMirror supplies positional change ranges and inserted text.
  tr.changes.iterChanges((fromA, toA, fromB, toB, inserted) => {
    // Check if the inserted text contains line breaks
    if (inserted.toString().includes("\n")) {
      hasNewLines = true;
    }

    // Count the number of line breaks in the deleted range
    const deletedText = tr.startState.doc.sliceString(fromA, toA);
    if (deletedText.includes("\n")) {
      hasNewLines = true;
    }

    // Another approach: check if the change spans multiple lines
    const fromLine = tr.startState.doc.lineAt(fromA).number;
    const toLine = tr.startState.doc.lineAt(toA).number;
    if (fromLine !== toLine) {
      hasNewLines = true;
    }
  });

  return hasNewLines;
}