added flag -i -n -c -v

Author: paulvollmer

.gitignore

@@ -13,4 +13,5 @@
 
 /cmd/lit/lit*
 /cmd/lit/main.go
+/cmd/lit/test
 /transform.go

.travis.yml

@@ -12,5 +12,4 @@ script:
   - make build
   - make test
   - make release
-  - cd ../../
-  - go test -v
+  - cd ../../ && make test

Makefile

@@ -0,0 +1,3 @@
+test:
+	@./cmd/lit/lit -n transform.go.md transform.go
+	go test -v

cmd/lit/Makefile

@@ -15,7 +15,6 @@ build: pre
 
 pre:
 	@echo "pre-processing"
-	@./lit-bootstrap ../../transform.go.md ../../transform.go
 	@./lit-bootstrap main.go.md main.go
 
 
@@ -29,15 +28,14 @@ bootstrap:
 	@echo "bootstrap lit"
 	@./lit-bootstrap version
 
-test: build
-	@./lit version
-	@mkdir -p tmp
+test:
+	@./lit -v
+	@mkdir -p test
 	@echo "build test sample"
-	@./lit sample/sample.go.md tmp/main.go
+	@./lit -n sample/sample.go.md test/main.go
 	@echo "run test sample\n---"
-	@go run tmp/main.go
+	@go run test/main.go
 	@echo "---"
-	@rm -rf tmp
 
 release:
 	GOOS=darwin GOARCH=386 go build -ldflags "-X main.version=${VERSION}" -o lit_darwin_386
@@ -50,6 +48,7 @@ release:
 
 clean:
 	@rm -f lit
-	@rm -f lit-bootstrap
+	@rm -f lit_*
+	@rm -rf test
 
 .PHONY: build pre bootstrap test release clean

cmd/lit/main.go

@@ -8,6 +8,7 @@ at first we check if the first arg is `version`. if it ism then print the versio
 
 	import (
 		"fmt"
+		"flag"
 		"io/ioutil"
 		"os"
 
@@ -16,35 +17,51 @@ at first we check if the first arg is `version`. if it ism then print the versio
 
 	var version = "dev"
 
+	func usage()  {
+		fmt.Printf("\n")
+		fmt.Printf("  +--------+\n")
+		fmt.Printf("  | ---    |\n")
+		fmt.Printf("  | ---    |  lit v%s - literate preprocessor\n", version)
+		fmt.Printf("  |   ---  |  --- ------ - ---------------------\n")
+		fmt.Printf("  |   ---  |\n")
+		fmt.Printf("  | ---    |\n")
+		fmt.Printf("  +--------+\n")
+		fmt.Printf("\n")
+		fmt.Printf("  USAGE: lit [flags] <in> <out>\n\n")
+		fmt.Printf("  FLAGS:\n")
+		flag.PrintDefaults()
+		fmt.Printf("\n  EXAMPLE:\n")
+		fmt.Printf("  $ lit foo.go.md foo.go\n\n")
+		os.Exit(0)
+	}
+
 	func main() {
-		totalArgs := len(os.Args)
-		if totalArgs == 1 {
-			fmt.Printf("\n")
-			fmt.Printf("  +--------+\n")
-			fmt.Printf("  | ---    |\n")
-			fmt.Printf("  | ---    |  lit v%s - literate preprocessor\n", version)
-			fmt.Printf("  |   ---  |  --- ------ - ---------------------\n")
-			fmt.Printf("  |   ---  |\n")
-			fmt.Printf("  | ---    |\n")
-			fmt.Printf("  +--------+\n")
-			fmt.Printf("\n")
-			fmt.Printf("  lit <in> <out>\n")
-			fmt.Printf("  lit foo.go.lit foo.go\n")
-			os.Exit(1)
-		}
+		flagCommentStyle := flag.String("c", "//", "the comment style")
+		flagGeneratedInfo := flag.Bool("i", true, "add an information that the code was generated at the top of the file")
+		flagNoDocs := flag.Bool("n", false, "cut the docs from the final result")
+		flagVersion := flag.Bool("v", false, "print the version and exit")
 
-	var err error
-	var inputData []byte
+		flag.Usage = usage
+		flag.Parse()
 
-	if totalArgs >= 1 {
-		if os.Args[1] == "version" {
-			fmt.Println("lit v"+version)
+		flagArgs := flag.Args()
+		totalArgs := flag.NArg()
+
+		if *flagVersion {
+			fmt.Println("v"+version)
 			os.Exit(0)
 		}
+		if totalArgs == 0 {
+			usage()
+		}
+
+	var err error
+	var inputData []byte
 
 read the given filepath and store the data to a variable
 
-		inputData, err = ioutil.ReadFile(os.Args[1])
+	if totalArgs >= 1 {
+		inputData, err = ioutil.ReadFile(flagArgs[0])
 		if err != nil {
 			fmt.Println(err)
 			os.Exit(1)
@@ -53,24 +70,23 @@ read the given filepath and store the data to a variable
 
 now we can transform the input data
 
-	transformed := lit.Transform(inputData, []byte("// "))
-
+	transformed := lit.Transform(inputData, []byte(*flagCommentStyle+" "), *flagNoDocs)
 
 last step is to write the file back to the given filepath
 
-	if totalArgs == 3 {
-		outPath := os.Args[2]
-		outPre := []byte("// GENERATED BY LIT v"+version+"\n// DO NOT EDIT BY HAND\n\n")
-		err := ioutil.WriteFile(outPath, append(outPre, transformed...), 0777)
+	if totalArgs == 2 {
+		outPath := flagArgs[1]
+		var outInfo []byte
+		if *flagGeneratedInfo {
+			outInfo = []byte("// GENERATED BY LIT v"+version+"; DO NOT EDIT\n\n")
+		}
+		err := ioutil.WriteFile(outPath, append(outInfo, transformed...), 0777)
 		if err != nil {
 			fmt.Println(err)
 			os.Exit(1)
 		}
-		// TODO: verbose mode
-		// fmt.Println("successful written file to", outPath)
 	} else {
 		fmt.Println(string(transformed))
 	}
 
-
 	}

cmd/lit/main.go.md

@@ -8,19 +8,23 @@
 
 The core of the lit tool is the `Transform` function. At this function we process the given source and comment out all non code lines by the given `commentStyle`.
 
-	func Transform(code []byte, commentStyle []byte) []byte {
+	func Transform(code []byte, commentStyle []byte, noDocs bool) []byte {
 		tokens := Scanner(code)
-		transformed := make([][]byte, len(tokens))
+		transformed := make([][]byte, 0)
 		for i := 0; i < len(tokens); i++ {
 			switch tokens[i].Type {
 			case TYPE_DOC, TYPE_CODESIGN:
-				if len(tokens[i].Value) > 0 {
-					transformed[i] = append(commentStyle, tokens[i].Value...)
+				if len(tokens[i].Value) == 0 {
+					transformed = append(transformed, []byte(""))
+				} else {
+					if !noDocs {
+						transformed = append(transformed, append(commentStyle, tokens[i].Value...))
+					}
 				}
 				break
 
 			case TYPE_CODE:
-				transformed[i] = tokens[i].Value
+				transformed = append(transformed, tokens[i].Value)
 				break
 			}
 		}

transform.go.md

@@ -18,7 +18,7 @@ this is a test string
       fmt.Println("Hello literate programming")
     }
 `)
-	result := Transform(code, []byte("// "))
+	result := Transform(code, []byte("// "), false)
 	expected := []byte(`// # test code
 
 // this is a test string
@@ -44,7 +44,7 @@ this is a test string
 
 	echo hello
 `)
-	result := Transform(code, []byte("# "))
+	result := Transform(code, []byte("# "), false)
 	expected := []byte(`# # test code
 # this is a test string
 
@@ -65,7 +65,7 @@ this is a test string
 echo "hello"
 ` + "```" + `
 `)
-	result := Transform(code, []byte("# "))
+	result := Transform(code, []byte("# "), false)
 	expected := []byte(`# # test code
 # this is a test string