1
1
mirror of https://github.com/walles/moar.git synced 2024-11-26 13:46:16 +03:00
Moar is a pager. It's designed to just do the right thing without any configuration.
Go to file
Steven Penny f76fd6ddd3 Simplify StyleDefault definition
StyleDefault is all zero values, so we can simplify the definition. If that
changes in the future (not likely) we can go back to the old definition method.

Fixes #57
2021-05-11 08:14:15 -05:00
m Split a large function into smaller ones 2021-05-08 17:21:08 +02:00
releases Move historical releases into their own directory 2020-12-30 18:43:25 +01:00
sample-files Improve large file reading performance by 10% 2021-05-03 20:33:25 +02:00
twin Simplify StyleDefault definition 2021-05-11 08:14:15 -05:00
.gitignore Windows: Color output, character input 2021-04-17 22:29:45 +02:00
.travis.yml Try with Go 1.16 instead 2021-04-22 19:17:58 +02:00
.whitesource Reboot in Go 2019-06-08 22:12:52 +02:00
build.sh Add gomft -s flag 2021-04-19 15:20:33 +02:00
go.mod Try with Go 1.16 instead 2021-04-22 19:17:58 +02:00
go.sum Experiment with go mod tidy and go install 2021-04-22 19:13:12 +02:00
install.sh Add two comments 2019-07-08 08:58:53 +02:00
LICENSE Reboot in Go 2019-06-08 22:12:52 +02:00
moar.go Less compatibility improvement 2021-04-20 09:18:02 +02:00
moar.sh Make moar.sh runnable from any directory 2020-11-07 13:57:50 +01:00
README.md Don't highlight files larger than 1MB 2021-04-24 16:14:30 +02:00
release.sh Require version number on v1.2.3 form 2021-04-20 20:31:23 +02:00
screenshot.png Update screenshot to match code 2020-09-05 20:40:33 +02:00
test.sh Move some test-only code into *_test.go files 2021-05-08 10:32:04 +02:00

Moar is a pager. It's designed to just do the right thing without any configuration:

Moar displaying its own source code

The intention is that Moar should work as a drop-in replacement for Less. If you find that Moar doesn't work that way, please report it!

Doing the right thing includes:

  • Syntax highlight source code by default using Chroma
  • Search is incremental / find-as-you-type just like in Chrome or Emacs
  • Search becomes case sensitive if you add any UPPER CASE characters to your search terms, just like in Emacs
  • Regexp search if your search string is a valid regexp
  • Supports displaying ANSI color coded texts (like the output from git diff | riff for example)
  • Supports UTF-8 input and output
  • The position in the file is always shown

For compatibility reasons, moar uses the formats declared in these environment variables when viewing man pages:

  • LESS_TERMCAP_md: Bold
  • LESS_TERMCAP_us: Underline

Moar is used as the default pager by:

Installing

  1. Download moar for your platform from https://github.com/walles/moar/releases/latest
  2. chmod a+x moar-*-*-*
  3. sudo mv moar-*-*-* /usr/local/bin/moar

And now you can just invoke moar from the prompt!

If a binary for your platform is not available, please file a ticket or contact johan.walles@gmail.com.

Debian / Ubuntu

A Request for Packaging is open, please help!

Setting Moar as Your Default Pager

Set it as your default pager by adding...

export PAGER=/usr/local/bin/moar

... to your .bashrc.

Issues

Issues are tracked here, or you can send questions to johan.walles@gmail.com.

Embedding

Here's one way to embed moar in your app:

package main

import (
	"bytes"
	"fmt"

	"github.com/walles/moar/m"
)

func main() {
	buf := new(bytes.Buffer)
	for range [99]struct{}{} {
		fmt.Fprintln(buf, "Moar")
	}

	err := m.NewPager(m.NewReaderFromStream("Moar", buf)).Page()
	if err != nil {
		// Handle paging problems
		panic(err)
	}
}

m.Reader can also be initialized using NewReaderFromText() or NewReaderFromFilename().

Developing

You need the go tools.

Run tests:

./test.sh

Run microbenchmarks:

go test -run='^$' -bench=. . ./...

Build + run:

./moar.sh ...

Install (into /usr/local/bin) from source:

./install.sh

Making a new Release

Make sure that screenshot.png matches moar's current UI. If it doesn't, scale a window to 81x16 characters and make a new one.

Execute release.sh and follow instructions.

TODO

  • Searching for something above us should wrap the search.

  • Enable exiting using ^c (without restoring the screen).

  • Start at a certain line if run as "moar.rb file.txt:42"

  • Redefine 'g' without any prefix to prompt for which line to go to. This definition makes more sense to me than having to prefix 'g' to jump.

  • Handle search hits to the right of the right screen edge. Searching forwards should move first right, then to the left edge and down. Searching backwards should move first left, then up and to the right edge (if needed for showing search hits).

  • Support viewing multiple files by pushing them in reverse order on the view stack.

  • Incremental search using ^s and ^r like in Emacs

  • Retain the search string when pressing / to search a second time.

Done

  • Add '>' markers at the end of lines being cut because they are too long

  • Doing moar on an arbitrary binary (like /bin/ls) should put all line-continuation markers at the rightmost column. This really means our truncation code must work even with things like tabs and various control characters.

  • Make sure search hits are highlighted even when we have to scroll right to see them

  • Change out-of-file visualization to writing --- after the end of the file and leaving the rest of the screen blank.

  • Exit search on pressing up / down / pageup / pagedown keys and scroll. I attempted to do that spontaneously, so it's probably a good idea.

  • Remedy all FIXMEs in this README file

  • Release the go version as the new moar, replacing the previous Ruby implementation

  • Add licensing information (same as for the Ruby branch)

  • Make sure "git grep" output gets highlighted properly.

  • Handle all kinds of line endings.

  • Make sure version information is printed if there are warnings.

  • Add spinners while file is still loading

  • Make tail -f /dev/null exit properly, fix https://github.com/walles/moar/issues/7.

  • Showing unicode search hits should highlight the correct chars