walles/moar
1
1
Fork 0
mirror of https://github.com/walles/moar.git synced 2024-11-30 12:42:26 +03:00
Code Issues Projects Releases Wiki Activity

Modify the highlighting API

Browse Source 
This changes the highlighting API to take a string instead of a file
because strings are what Chroma can highlight.

With this change in place, we should invoke the highlighter after
we're done reading the input. This will allow highlighting both files
(as before) and streaming input.

This also moves the responsibility of checking the file against the max
highlight size from the highlighter to the caller.
This commit is contained in:
Johan Walles 2024-01-01 11:18:09 +01:00
parent 64022c8909
commit 2d2844f68c
1 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
m/highlight.go
View File

@ -2,13 +2,10 @@ package m
import (
"bytes"
"os"
"strings"
"github.com/alecthomas/chroma/v2"
"github.com/alecthomas/chroma/v2/lexers"
log "github.com/sirupsen/logrus"
)
// Files larger than this won't be highlighted
@ -18,24 +15,13 @@ const MAX_HIGHLIGHT_SIZE int64 = 1024 * 1024
// Read and highlight a file using Chroma: https://github.com/alecthomas/chroma
//
// If force is true, file will always be highlighted. If force is false, files
// larger than MAX_HIGHLIGHT_SIZE will not be highlighted.
// The format can be a filename, a MIME type (e.g. "text/html"), a file name
// extension or an alias like "zsh". Ref:
// https://pkg.go.dev/github.com/alecthomas/chroma/v2#LexerRegistry.Get
//
// Returns nil with no error if highlighting would be a no-op.
func highlight(filename string, force bool, style chroma.Style, formatter chroma.Formatter) (*string, error) {
// Highlight input file using Chroma:
// https://github.com/alecthomas/chroma
fileInfo, err := os.Stat(filename)
if err != nil {
return nil, err
}
if fileInfo.Size() > MAX_HIGHLIGHT_SIZE && !force {
log.Debugf("Not highlighting %s because it is %d bytes large, which is larger than moar's built-in highlighting limit of %d bytes",
filename, fileInfo.Size(), MAX_HIGHLIGHT_SIZE)
return nil, nil
}
lexer := lexers.Match(filename)
func highlight(text string, format string, style chroma.Style, formatter chroma.Formatter) (*string, error) {
lexer := pickLexer(format)
if lexer == nil {
// No highlighter available for this file type
return nil, nil
@ -55,12 +41,7 @@ func highlight(filename string, force bool, style chroma.Style, formatter chroma
// with and without.
lexer = chroma.Coalesce(lexer)
contents, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
iterator, err := lexer.Tokenise(nil, string(contents))
iterator, err := lexer.Tokenise(nil, text)
if err != nil {
return nil, err
}
@ -81,3 +62,23 @@ func highlight(filename string, force bool, style chroma.Style, formatter chroma
return &trimmed, nil
}
// Pick a lexer for the given filename and format.
//
// The format can be a filename, a MIME type (e.g. "text/html"), a file name
// extension or an alias like "zsh". Ref:
// https://pkg.go.dev/github.com/alecthomas/chroma/v2#LexerRegistry.Get
func pickLexer(format string) chroma.Lexer {
byFileName := lexers.Match(format)
if byFileName != nil {
return byFileName
}
byMimeType := lexers.MatchMimeType(format)
if byMimeType != nil {
return byMimeType
}
// Use Chroma's built-in lexer picker
return lexers.Get(format)
}