Switch to functional options

This commit is contained in:
Tom Payne
2019-12-28 02:55:20 +01:00
committed by Christian Muehlhaeuser
parent 7349948f7f
commit 339b3e9df8
4 changed files with 130 additions and 78 deletions
+117 -64
View File
@@ -3,9 +3,8 @@ package glamour
import (
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"github.com/rakyll/statik/fs"
@@ -19,12 +18,26 @@ import (
_ "github.com/charmbracelet/glamour/statik" // pre-generated styles
)
var statikFS http.FileSystem
// A TermRendererOption sets an option on a TermRenderer.
type TermRendererOption func(*TermRenderer) error
// TermRenderer can be used to render markdown content, posing a depth of
// customization and styles to fit your needs.
type TermRenderer struct {
md goldmark.Markdown
buf bytes.Buffer
renderBuf bytes.Buffer
md goldmark.Markdown
ansiOptions ansi.Options
buf bytes.Buffer
renderBuf bytes.Buffer
}
func init() {
var err error
statikFS, err = fs.New()
if err != nil {
panic(err)
}
}
// Render initializes a new TermRenderer and renders a markdown with a specific
@@ -37,55 +50,116 @@ func Render(in string, stylePath string) (string, error) {
// RenderBytes initializes a new TermRenderer and renders a markdown with a
// specific style.
func RenderBytes(in []byte, stylePath string) ([]byte, error) {
r, err := NewTermRenderer(stylePath, ansi.Options{
WordWrap: 80,
})
r, err := NewTermRenderer(
WithStylePath(stylePath),
)
if err != nil {
return nil, err
}
return r.RenderBytes(in)
}
// NewTermRenderer returns a new TermRenderer with style and options set.
func NewTermRenderer(stylePath string, options ansi.Options) (*TermRenderer, error) {
if stylePath == "" {
return NewTermRendererFromBytes([]byte("{}"), options)
}
b, err := loadStyle(stylePath)
if err != nil {
return nil, err
}
return NewTermRendererFromBytes(b, options)
}
// NewTermRendererFromBytes returns a new TermRenderer with style and options
// set.
func NewTermRendererFromBytes(b []byte, options ansi.Options) (*TermRenderer, error) {
err := json.Unmarshal(b, &options.Styles)
if err != nil {
// FIXME: wrap error once we depend on Go 1.13
return nil, fmt.Errorf("parsing style: %v", err)
}
md := goldmark.New(
goldmark.WithExtensions(
extension.GFM,
extension.DefinitionList,
// NewTermRenderer returns a new TermRenderer the given options.
func NewTermRenderer(options ...TermRendererOption) (*TermRenderer, error) {
tr := &TermRenderer{
md: goldmark.New(
goldmark.WithExtensions(
extension.GFM,
extension.DefinitionList,
),
goldmark.WithParserOptions(
parser.WithAutoHeadingID(),
),
),
goldmark.WithParserOptions(
parser.WithAutoHeadingID(),
ansiOptions: ansi.Options{
WordWrap: 80,
},
}
for _, o := range options {
if err := o(tr); err != nil {
return nil, err
}
}
ar := ansi.NewRenderer(tr.ansiOptions)
tr.md.SetRenderer(
renderer.NewRenderer(
renderer.WithNodeRenderers(
util.Prioritized(ar, 1000),
),
),
)
return tr, nil
}
ar := ansi.NewRenderer(options)
md.SetRenderer(
renderer.NewRenderer(
renderer.WithNodeRenderers(util.Prioritized(ar, 1000))))
// WithBaseURL sets a TermRenderer's base URL.
func WithBaseURL(baseURL string) TermRendererOption {
return func(tr *TermRenderer) error {
tr.ansiOptions.BaseURL = baseURL
return nil
}
}
return &TermRenderer{
md: md,
}, nil
// WithStandardStyle sets a TermRenderer's styles with a standard (builtin)
// style.
func WithStandardStyle(style string) TermRendererOption {
return func(tr *TermRenderer) error {
jsonBytes, err := fs.ReadFile(statikFS, "/"+style+".json")
if err != nil {
return err
}
return json.Unmarshal(jsonBytes, &tr.ansiOptions.Styles)
}
}
// WithStylePath sets a TermRenderer's style from stylePath. stylePath is first
// interpreted as a filename. If no such file exists, it is re-interpreted as a
// standard style.
func WithStylePath(stylePath string) TermRendererOption {
return func(tr *TermRenderer) error {
jsonBytes, err := ioutil.ReadFile(stylePath)
if os.IsNotExist(err) {
jsonBytes, err = fs.ReadFile(statikFS, "/"+stylePath+".json")
}
if err != nil {
return err
}
return json.Unmarshal(jsonBytes, &tr.ansiOptions.Styles)
}
}
// WithStyles sets a TermRenderer's styles.
func WithStyles(styles ansi.StyleConfig) TermRendererOption {
return func(tr *TermRenderer) error {
tr.ansiOptions.Styles = styles
return nil
}
}
// WithStylesFromJSONBytes sets a TermRenderer's styles by parsing styles from
// jsonBytes.
func WithStylesFromJSONBytes(jsonBytes []byte) TermRendererOption {
return func(tr *TermRenderer) error {
return json.Unmarshal(jsonBytes, &tr.ansiOptions.Styles)
}
}
// WithStylesFromJSONFile sets a TermRenderer's styles from a JSON file.
func WithStylesFromJSONFile(filename string) TermRendererOption {
return func(tr *TermRenderer) error {
jsonBytes, err := ioutil.ReadFile(filename)
if err != nil {
return err
}
return json.Unmarshal(jsonBytes, &tr.ansiOptions.Styles)
}
}
// WithWordWrap sets a TermRenderer's word wrap.
func WithWordWrap(wordWrap int) TermRendererOption {
return func(tr *TermRenderer) error {
tr.ansiOptions.WordWrap = wordWrap
return nil
}
}
func (tr *TermRenderer) Read(b []byte) (int, error) {
@@ -120,24 +194,3 @@ func (tr *TermRenderer) RenderBytes(in []byte) ([]byte, error) {
err := tr.md.Convert(in, &buf)
return buf.Bytes(), err
}
func loadStyle(f string) ([]byte, error) {
var r io.ReadCloser
r, err := os.Open(f)
if err != nil {
statikFS, err := fs.New()
if err != nil {
return nil, err
}
r, err = statikFS.Open("/" + f + ".json")
if err != nil {
// FIXME: wrap error once we depend on Go 1.13
return nil, fmt.Errorf("loading style %s: %v", f, err)
}
}
defer r.Close()
return ioutil.ReadAll(r)
}