vis README

The project's README from github.com/martanne/vis. As one markdown file: README.md.

Vis - Combining Modal Editing with Structural Regular Expressions

Development discussion builds.sr.ht status Coverity Scan Build Status codecov Documentation Status #vis-editor on libera

Vis aims to be a modern, legacy-free, simple yet efficient editor, combining the strengths of both vi(m) and sam.

It extends vi's modal editing with built-in support for multiple cursors/selections and combines it with sam's structural regular expression based command language.

A universal editor, it has decent Unicode support and should cope with arbitrary files, including large, binary or single-line ones.

Efficient syntax highlighting is provided using Parsing Expression Grammars, which can be conveniently expressed using Lua in the form of LPeg.

The editor core is written in a reasonable amount of clean (your mileage may vary), modern and legacy-free C code, enabling it to run in resource-constrained environments. The implementation should be easy to hack on and encourages experimentation. There is also a Lua API for in-process extensions.

Vis strives to be simple and focuses on its core task: efficient text management. Clipboard and digraph handling as well as a fuzzy file open dialog are all provided by independent utilities. There exist plans to use a client/server architecture, delegating window management to your windowing system or favorite terminal multiplexer.

The intention is not to be bug-for-bug compatible with vi(m). Instead, we aim to provide more powerful editing features based on an elegant design and clean implementation.

vis demo

Build instructions

In order to build vis you will need a C99 compiler, a POSIX.1-2008 compatible environment as well as:

Assuming these dependencies are met, execute:

$ ./configure && make && sudo make install

By default the configure script will try to auto detect support for Lua using pkg-config(1). See configure --help for a list of supported options. You can also manually tweak the generated config.mk file.

Or simply use one of the distribution provided packages.

Documentation

End user documentation can be found in the vis(1) manual page and the Wiki. Read the FAQ for common questions. Learn about some differences compared to sam(1) and vim(1), respectively.

C API as well as Lua API documentation is also available.

Non Goals

Some features which will not be implemented:

How to help?

There are plenty of ways to contribute, below are a few ideas:

Checkout the Developer Overview to get started and do not hesitate to ask question in the #vis-editor IRC channel on libera (join via your browser).

vis (martanne/vis)

text-editor
Searching Database…

5.1K ·GitHub
What is this?Vis is a modern, vi(m)-like modal text editor that combines vi's editing style with sam's structural regular expression command language, adding native multiple cursors/selections and Unicode support.
Is this a terminal editor like vim, or something else?It is a terminal-based (curses) modal text editor, similar in spirit to vim and sam, not a GUI application.
How do I build and install it?Make sure the build dependencies are met, then run `./configure && make && sudo make install`, or use a distribution-provided package.
What do I need installed to build it?You need a C99 compiler and a POSIX.1-2008 environment; curses is recommended, and Lua 5.2+/LPeg 0.12+ are optional for syntax highlighting, with TRE optional for more memory-efficient regex search.
What features will it deliberately never have?The project explicitly rules out tabs/multiple windows, a file browser, archive/network/encryption/compression support, GUIs, VimL, right-to-left text, ex mode, vimgrep, an internal spell checker, and compile-time feature flags.
Who is this editor for?It's aimed at vi(m)/sam users who want a lightweight, hackable, legacy-free editor core written in clean C, suited for resource-constrained environments.
What is a structural regular expression and why does it matter here?It is sam's command language concept, borrowed from Plan 9, for selecting and acting on text via regex-based structure rather than line-based ex commands; Vis uses it instead of vim's ex mode.
How does syntax highlighting work?Syntax highlighting is implemented using Parsing Expression Grammars, which are written in Lua via the LPeg library, rather than being hardcoded in C.
Can I extend Vis with plugins or scripts?Yes, there is a Lua API for in-process extensions, allowing plugin development and customization without modifying the C core.
Does Vis handle clipboard and fuzzy file opening itself?No, clipboard handling, digraph support, and the fuzzy file open dialog are all delegated to independent external utilities rather than built into the editor.
What are similar projects?kakoune, bat, neovim, micro, edit, oni, radare2, vim-pathogen
Creator
martanne
Size
6.7 MB
Stars
5.1K
Age
11y
Commits · 90 Days