kod

command module
v0.0.0-...-146fef3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2018 License: MIT Imports: 6 Imported by: 0

README

kod (WIP)

GoDoc

kod screenshot

kod aims to be a fast and modern terminal code-editor. It is inspired by both vim & micro. It's built using xi-editor as backend.

Goals:

  • Performance, it should never freeze or be slow
  • Modes for efficient editing, similar to vim
  • Plugins (via xi-core, an example is xi-syntect-plugin which is shown in the picture above)
  • Modular, uses xi-editor as backend

Non-goals:

  • Maintain a huge platform support (like vim), it will be supported by the major platforms and architectures

Installation

kod expects xi-core to be set in your $PATH. For more information how to build xi-core, please have a look at xi-editor's github page.

Once xi-core is available you should be able to install with following

 go get -u -v github.com/linde12/kod

To ensure that kod is available, run which kod. It prints kod path in GO binary. If you see kod not found, you need to add your $GOPATH/bin to PATH

TODO

  • Unmarshal known JSON requests into structs, partially done
  • Implement update method
  • Read viewHeight lines and fill buffer
  • Refactor away unused code(e.g. lineArray, buffer_reader, cursor)
  • Add (very) basic editing functionality
  • Add vertical scrolling
  • Add horizontal scrolling
  • Indentation (local, xi doesn't fully support yet AFAIK)
  • Respect alpha value in ARGB
  • Cleanup view and inputhandler
  • Find(search) in file
  • Support multiple cursors
  • Make editor runnable outside current CWD
  • Display line numbers/gutter (very basic)
  • A lot of other things...

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL