feat(markdown): added proof-of-concept md command

Author: b5

.gitignore

@@ -0,0 +1,2 @@
+coverage.txt
+outline

cmd/fmt.go

@@ -0,0 +1,43 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/b5/outline/lib"
+	"github.com/spf13/cobra"
+)
+
+// FmtCmd prints present configuration info
+var FmtCmd = &cobra.Command{
+	Use:   "fmt",
+	Short: "format input",
+	Long:  ``,
+	Run: func(cmd *cobra.Command, args []string) {
+		for _, fp := range args {
+			f, err := os.Open(fp)
+			if err != nil {
+				fmt.Println(err.Error())
+				os.Exit(1)
+			}
+
+			doc, err := lib.Parse(f)
+			if err != nil {
+				fmt.Println(err.Error())
+				os.Exit(1)
+			}
+
+			data, err := doc.MarshalIndent(0, "  ")
+			if err != nil {
+				fmt.Println(err.Error())
+				os.Exit(1)
+			}
+
+			fmt.Print(string(data))
+		}
+	},
+}
+
+func init() {
+	// FmtCmd.Flags().StringP("export", "e", "config.json", "path to configuration json file")
+}

cmd/markdown.go

@@ -0,0 +1,61 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"text/template"
+
+	"github.com/b5/outline/lib"
+	"github.com/spf13/cobra"
+)
+
+const mdTmpl = `{{ range . }}
+# Package {{ .Name }}
+
+{{ .Description }}
+
+{{ if gt (len .Functions) 0}}
+## Functions
+{{ range .Functions }}
+### {{ .Signature }}
+{{ .Description }}
+{{ end }}
+{{ end }}
+
+
+{{ end }}`
+
+// MarkdownCmd converts an outline to a markdown document
+var MarkdownCmd = &cobra.Command{
+	Use:     "markdown",
+	Aliases: []string{"md"},
+	Short:   "Convert docs to markdown syntax",
+	Long:    ``,
+	Run: func(cmd *cobra.Command, args []string) {
+		t := template.Must(template.New("markdown").Parse(mdTmpl))
+		var docs []*lib.Doc
+		for _, fp := range args {
+			f, err := os.Open(fp)
+			if err != nil {
+				fmt.Println(err.Error())
+				os.Exit(1)
+			}
+
+			doc, err := lib.Parse(f)
+			if err != nil {
+				fmt.Println(err.Error())
+				os.Exit(1)
+			}
+			docs = append(docs, doc)
+		}
+
+		if err := t.Execute(os.Stdout, docs); err != nil {
+			fmt.Println(err.Error())
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	// MarkdownCmd.Flags().StringP("export", "e", "config.json", "path to configuration json file")
+}

cmd/root.go

@@ -0,0 +1,40 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/qri-io/walk/lib"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+// logger
+var log = logrus.New()
+
+// RootCmd is the walk command
+var RootCmd = &cobra.Command{
+	Short: "outline is a tool for outlining software packages",
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		if debug, err := cmd.Flags().GetBool("debug"); err == nil && debug {
+			lib.SetLogLevel("debug")
+		}
+	},
+}
+
+// Execute adds all child commands to the root command sets flags appropriately.
+// This is called by main.main(). It only needs to happen once to the rootCmd.
+func Execute() {
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Println(err.Error())
+		os.Exit(1)
+	}
+}
+
+func init() {
+	RootCmd.PersistentFlags().Bool("debug", false, "show debug output")
+	RootCmd.AddCommand(
+		FmtCmd,
+		MarkdownCmd,
+	)
+}

cmd/template.go

@@ -0,0 +1 @@
+package cmd

outline.go lib/outline.gooutline.go renamed to lib/outline.go

@@ -1,5 +1,5 @@
 // Package outline generates starlark documentation from go code
-package outline
+package lib
 
 import (
 	"bytes"

parser.go lib/parser.goparser.go renamed to lib/parser.go

@@ -1,4 +1,4 @@
-package outline
+package lib
 
 import (
 	"fmt"
@@ -61,8 +61,6 @@ func (p *parser) scan() (tok Token) {
 			return
 		}
 	}
-	// fmt.Printf("returning token outside loop: %s %#v\n", tok.Type, tok.Text)
-	return
 }
 
 func (p *parser) unscan() {
@@ -154,7 +152,7 @@ func (p *parser) readType(baseIndent int) (t *Type, err error) {
 
 	for {
 		tok = p.scan()
-		if p.indent < baseIndent {
+		if p.indent <= baseIndent {
 			p.unscan()
 			return
 		}
@@ -170,9 +168,15 @@ func (p *parser) readType(baseIndent int) (t *Type, err error) {
 			if err != nil {
 				return
 			}
-		case TextTok:
-			p.unscan()
-			t.Description, err = p.readText(baseIndent + 1)
+		default:
+			err = fmt.Errorf("unexpexted token: %s: %s %d %d", tok.Type, tok.Text, p.indent, baseIndent)
+			return
+
+			// TODO (b5): handle field descriptions
+			// case TextTok:
+			// fmt.Println("text?")
+			// p.unscan()
+			// t.Description, err = p.readText(baseIndent + 1)
 		}
 	}
 }

outline_test.go lib/parser_test.gooutline_test.go renamed to lib/parser_test.go

@@ -1,4 +1,4 @@
-package outline
+package lib
 
 import (
 	"bytes"
@@ -59,7 +59,12 @@ outline: time
         duration - time = duration
         duration + time = time
         duration == duration = boolean
-        duration < duration = booleans`
+        duration < duration = booleans
+    time
+      fields:
+      operators:
+        time == time = boolean
+        time < time = boolean`
 
 var time = &Doc{
 	Name: "time",
@@ -88,6 +93,13 @@ var time = &Doc{
 				{Opr: "duration < duration = booleans"},
 			},
 		},
+		{Name: "time",
+			Fields: []*Field{},
+			Operators: []*Operator{
+				{Opr: "time == time = boolean"},
+				{Opr: "time < time = boolean"},
+			},
+		},
 	},
 }
 

scanner.go lib/scanner.goscanner.go renamed to lib/scanner.go

@@ -1,4 +1,4 @@
-package outline
+package lib
 
 import (
 	"bufio"

token.go lib/token.gotoken.go renamed to lib/token.go

@@ -1,4 +1,4 @@
-package outline
+package lib
 
 type Position struct {
 	Line, Col, Offset int