2019-11-04 23:17:36 +00:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
2019-11-22 03:44:54 +00:00
|
|
|
"errors"
|
2019-11-04 23:17:36 +00:00
|
|
|
"fmt"
|
2019-11-22 02:52:21 +00:00
|
|
|
"io"
|
2019-11-09 22:12:54 +00:00
|
|
|
"io/ioutil"
|
2019-11-22 13:06:12 +00:00
|
|
|
"net/http"
|
|
|
|
"net/url"
|
2019-11-09 20:07:01 +00:00
|
|
|
"os"
|
2019-11-25 23:08:06 +00:00
|
|
|
"path/filepath"
|
2019-11-04 23:17:36 +00:00
|
|
|
|
2019-11-25 03:25:58 +00:00
|
|
|
"github.com/mattn/go-isatty"
|
2019-11-22 03:44:54 +00:00
|
|
|
"github.com/spf13/cobra"
|
|
|
|
|
2019-12-19 00:01:26 +00:00
|
|
|
"github.com/charmbracelet/glamour"
|
|
|
|
"github.com/charmbracelet/glamour/ansi"
|
2019-11-04 23:17:36 +00:00
|
|
|
)
|
|
|
|
|
2019-11-22 03:44:54 +00:00
|
|
|
var (
|
2019-12-09 12:50:17 +00:00
|
|
|
Version = ""
|
|
|
|
CommitSHA = ""
|
|
|
|
|
2019-11-24 04:06:01 +00:00
|
|
|
readmeNames = []string{"README.md", "README"}
|
2019-12-09 12:50:17 +00:00
|
|
|
style string
|
|
|
|
width uint
|
2019-11-24 04:06:01 +00:00
|
|
|
|
2019-11-22 03:44:54 +00:00
|
|
|
rootCmd = &cobra.Command{
|
|
|
|
Use: "gold SOURCE",
|
|
|
|
Short: "Render markdown on the CLI, with pizzazz!",
|
|
|
|
SilenceErrors: false,
|
|
|
|
SilenceUsage: false,
|
2019-11-24 01:40:29 +00:00
|
|
|
RunE: execute,
|
2019-11-22 03:44:54 +00:00
|
|
|
}
|
|
|
|
)
|
|
|
|
|
2019-11-25 23:08:06 +00:00
|
|
|
type Source struct {
|
|
|
|
reader io.ReadCloser
|
|
|
|
URL string
|
|
|
|
}
|
|
|
|
|
|
|
|
func readerFromArg(s string) (*Source, error) {
|
2019-11-22 02:28:26 +00:00
|
|
|
if s == "-" {
|
2019-11-25 23:08:06 +00:00
|
|
|
return &Source{reader: os.Stdin}, nil
|
2019-11-22 02:28:26 +00:00
|
|
|
}
|
|
|
|
|
2019-12-10 16:18:59 +00:00
|
|
|
// a GitHub or GitLab URL (even without the protocol):
|
2019-11-25 03:55:09 +00:00
|
|
|
if u, ok := isGitHubURL(s); ok {
|
2019-11-25 23:08:06 +00:00
|
|
|
src, err := findGitHubREADME(u)
|
2019-11-25 03:55:09 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2019-11-25 23:08:06 +00:00
|
|
|
return src, nil
|
2019-11-25 03:55:09 +00:00
|
|
|
}
|
2019-11-25 05:55:50 +00:00
|
|
|
if u, ok := isGitLabURL(s); ok {
|
2019-11-25 23:08:06 +00:00
|
|
|
src, err := findGitLabREADME(u)
|
2019-11-25 05:55:50 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2019-11-25 23:08:06 +00:00
|
|
|
return src, nil
|
2019-11-25 05:55:50 +00:00
|
|
|
}
|
2019-11-25 03:55:09 +00:00
|
|
|
|
2019-12-10 16:18:59 +00:00
|
|
|
// HTTP(S) URLs:
|
2019-11-22 13:06:12 +00:00
|
|
|
if u, err := url.ParseRequestURI(s); err == nil {
|
2019-11-25 23:34:15 +00:00
|
|
|
if u.Scheme != "" {
|
|
|
|
if u.Scheme != "http" && u.Scheme != "https" {
|
|
|
|
return nil, fmt.Errorf("%s is not a supported protocol", u.Scheme)
|
|
|
|
}
|
2019-11-22 13:06:12 +00:00
|
|
|
|
2019-11-25 23:34:15 +00:00
|
|
|
resp, err := http.Get(u.String())
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
|
|
return nil, fmt.Errorf("HTTP status %d", resp.StatusCode)
|
|
|
|
}
|
|
|
|
return &Source{resp.Body, u.String()}, nil
|
2019-11-22 13:06:12 +00:00
|
|
|
}
|
2019-11-22 02:28:26 +00:00
|
|
|
}
|
|
|
|
|
2019-12-10 16:18:59 +00:00
|
|
|
// a valid file or directory:
|
2019-12-07 07:31:15 +00:00
|
|
|
st, err := os.Stat(s)
|
|
|
|
if len(s) == 0 || (err == nil && st.IsDir()) {
|
2019-11-24 04:06:01 +00:00
|
|
|
for _, v := range readmeNames {
|
2019-12-10 14:55:49 +00:00
|
|
|
n := filepath.Join(s, v)
|
|
|
|
r, err := os.Open(n)
|
2019-11-24 04:06:01 +00:00
|
|
|
if err == nil {
|
2019-12-10 14:55:49 +00:00
|
|
|
u, _ := filepath.Abs(n)
|
2019-11-25 23:34:15 +00:00
|
|
|
return &Source{r, u}, nil
|
2019-11-24 04:06:01 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil, errors.New("missing markdown source")
|
|
|
|
}
|
|
|
|
|
2019-11-25 23:08:06 +00:00
|
|
|
r, err := os.Open(s)
|
2019-11-25 23:34:15 +00:00
|
|
|
u, _ := filepath.Abs(s)
|
|
|
|
return &Source{r, u}, err
|
2019-11-22 02:28:26 +00:00
|
|
|
}
|
|
|
|
|
2019-11-24 01:40:29 +00:00
|
|
|
func execute(cmd *cobra.Command, args []string) error {
|
2019-11-24 04:06:01 +00:00
|
|
|
var arg string
|
|
|
|
if len(args) > 0 {
|
|
|
|
arg = args[0]
|
2019-11-09 22:12:54 +00:00
|
|
|
}
|
2019-12-10 16:18:59 +00:00
|
|
|
|
|
|
|
// create an io.Reader from the markdown source in cli-args
|
2019-11-25 23:08:06 +00:00
|
|
|
src, err := readerFromArg(arg)
|
2019-11-22 02:28:26 +00:00
|
|
|
if err != nil {
|
2019-11-22 03:44:54 +00:00
|
|
|
return err
|
2019-11-09 22:12:54 +00:00
|
|
|
}
|
2019-11-25 23:08:06 +00:00
|
|
|
defer src.reader.Close()
|
2019-12-06 17:10:51 +00:00
|
|
|
b, err := ioutil.ReadAll(src.reader)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-11-25 03:25:58 +00:00
|
|
|
|
2019-12-10 16:18:59 +00:00
|
|
|
// We want to use a special no-TTY style, when stdout is not a terminal
|
|
|
|
// and there was no specific style passed by arg
|
2019-12-06 18:22:34 +00:00
|
|
|
if !isatty.IsTerminal(os.Stdout.Fd()) &&
|
|
|
|
!cmd.Flags().Changed("style") {
|
|
|
|
style = "notty"
|
|
|
|
}
|
2019-11-25 03:25:58 +00:00
|
|
|
|
2019-11-25 23:08:06 +00:00
|
|
|
u, err := url.ParseRequestURI(src.URL)
|
|
|
|
if err == nil {
|
|
|
|
u.Path = filepath.Dir(u.Path)
|
|
|
|
}
|
|
|
|
|
2019-12-19 00:01:26 +00:00
|
|
|
r, err := glamour.NewTermRenderer(style, ansi.Options{
|
2019-12-07 18:49:24 +00:00
|
|
|
BaseURL: u.String() + "/",
|
|
|
|
WordWrap: int(width),
|
|
|
|
})
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-12-13 21:36:55 +00:00
|
|
|
|
|
|
|
out, err := r.RenderBytes(b)
|
2019-11-28 01:20:58 +00:00
|
|
|
fmt.Printf("%s", string(out))
|
2019-12-13 21:36:55 +00:00
|
|
|
return err
|
2019-11-22 03:44:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func main() {
|
|
|
|
if err := rootCmd.Execute(); err != nil {
|
|
|
|
os.Exit(-1)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func init() {
|
2019-12-09 13:01:47 +00:00
|
|
|
if len(CommitSHA) >= 7 {
|
2019-12-09 12:50:17 +00:00
|
|
|
vt := rootCmd.VersionTemplate()
|
2019-12-09 13:01:47 +00:00
|
|
|
rootCmd.SetVersionTemplate(vt[:len(vt)-1] + " (" + CommitSHA[0:7] + ")\n")
|
2019-12-09 12:50:17 +00:00
|
|
|
}
|
|
|
|
if Version == "" {
|
|
|
|
Version = "unknown (built from source)"
|
|
|
|
}
|
|
|
|
rootCmd.Version = Version
|
|
|
|
|
2019-11-26 20:03:46 +00:00
|
|
|
rootCmd.Flags().StringVarP(&style, "style", "s", "dark", "style name or JSON path")
|
2019-11-25 05:42:34 +00:00
|
|
|
rootCmd.Flags().UintVarP(&width, "width", "w", 100, "word-wrap at width")
|
2019-11-04 23:17:36 +00:00
|
|
|
}
|