Module hilbish.editor

Sidebar

  • Lunacolors
  • Introduction
  • Completions
  • Frequently Asked Questions
  • Getting Started
  • Options
  • Features
  • Runner Mode
  • Notification
  • Signals
  • Signal
  • Command
  • Hilbish
  • Vim Mode
  • Actions
  • Module bait
  • Module terminal
  • API
  • Module fs
  • Module commander
  • Module snail
  • Module hilbish.aliases
  • Module hilbish.abbr
  • Module hilbish
  • Module hilbish.userDir
  • Module hilbish.messages
  • Module hilbish.runner
  • Module hilbish.history
  • Module hilbish.jobs
  • Module hilbish.editor
  • Module hilbish.module
  • Module hilbish.os
  • Module hilbish.completion
  • Module hilbish.timers
  • Module dirs
  • Nature
  • Module doc

Module hilbish.editor

Introduction

The hilbish.editor interface provides functions to directly interact with the line editor in use.

Functions

deleteByAmount(amount) Deletes characters in the line by the given amount.
getLine() -> string Returns the current input line.
getVimRegister(register) -> string Returns the text that is at the register.
insert(text) Inserts text into the Hilbish command line.
getChar() -> string Reads a keystroke from the user. This is in a format of something like Ctrl-L.
setVimRegister(register, text) Sets the vim register at register to hold the passed text.

hilbish.editor.deleteByAmount(amount)

Deletes characters in the line by the given amount.

Parameters

number amount


hilbish.editor.getLine() -> string

Returns the current input line.

Parameters

This function has no parameters.


hilbish.editor.getVimRegister(register) -> string

Returns the text that is at the register.

Parameters

string register


hilbish.editor.insert(text)

Inserts text into the Hilbish command line.

Parameters

string text


hilbish.editor.getChar() -> string

Reads a keystroke from the user. This is in a format of something like Ctrl-L.

Parameters

This function has no parameters.


hilbish.editor.setVimRegister(register, text)

Sets the vim register at register to hold the passed text.

Parameters

string register

string text