https://github.com/svenfuchs/led-go

A line editor in Go. Inspired by linenoise, but written with extensibility and separation of concerns in mind.
https://github.com/svenfuchs/led-go

Last synced: 12 days ago
JSON representation

A line editor in Go. Inspired by linenoise, but written with extensibility and separation of concerns in mind.

• Host: GitHub
• URL: https://github.com/svenfuchs/led-go
• Owner: svenfuchs
• License: mit
• Created: 2018-05-12T20:41:46.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-24T20:52:56.000Z (over 6 years ago)
• Last Synced: 2024-10-26T22:40:59.692Z (2 months ago)
• Language: Go
• Homepage:
• Size: 32.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Led

[![Build Status](https://travis-ci.com/svenfuchs/led-go.svg?branch=master)](https://travis-ci.com/svenfuchs/led-go)

[![Go Report Card](https://goreportcard.com/badge/github.com/svenfuchs/led-go?cache-bust=1)](https://goreportcard.com/report/github.com/svenfuchs/led-go)

[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/svenfuchs/led-go)

A line editor in Go. Inspired by [linenoise](https://github.com/antirez/linenoise),

but written with extensibility and separation of concerns in mind.

The motivation behind this library is to provide line editor functionality that

can be controlled, extended, and modified by clients with regards to how to

handle key events. In this regard the name of the library also is a pun on

letting go (of control).

## Usage

```go

import (

	"github.com/svenfuchs/led"

)

func main() {

	e := NewEd("$ ").Run()

	e.Handle(led.Chars, func(e *led.Ed, k led.Key) { ... })

	e.Run()

}

```

See [example/led.go](/blob/master/example/led.go) for a usage example that makes

use of custom key handlers, suggestions, completion, and history, and reimplements

(most of?) the functionality in linenoise.

Also see https://github.com/svenfuchs/travis-go for an example that takes over

more control.

## Todo

* Handle multiple lines if line length exceeds terminal width

* History search with ctrl-r