view.ts

import * as vscode from "vscode";

import type { Argument } from ".";
import { Context, Selections } from "../api";

/**
 * Moving the editor view.
 *
 * #### Predefined keybindings
 *
 * | Title                   | Keybinding                                   | Command                                              |
 * | ----------------------- | -------------------------------------------- | ---------------------------------------------------- |
 * | Show view menu          | `z` (helix: normal), `z` (helix: select)     | `[".openMenu", { menu: "view", ...               }]` |
 * | Show view menu (locked) | `s-z` (helix: normal), `s-z` (helix: select) | `[".openMenu", { menu: "view", locked: true, ... }]` |
 */
declare module "./view";

/**
 * Reveals a position based on the main cursor.
 */
export function line(
  _: Context,
  at: Argument<"top" | "center" | "bottom"> = "center",
) {
  return vscode.commands.executeCommand(
    "revealLine",
    { at, lineNumber: Selections.activeLine(_.mainSelection) },
  );
}