Merge pull request #21 from Ilyes512/feature/fix-goreportcard-reports

Feature/fix goreportcard reports
Ilyes512 · Nov 10, 2018 · fd7ae9f · fd7ae9f
2 parents 7490e48 + 6708319
commit fd7ae9f
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 46 deletions.
diff --git a/boilr.go b/boilr.go
@@ -1,22 +1,21 @@
 package main
 
 import (
-  "fmt"
-  "github.com/Ilyes512/boilr/pkg/boilr"
-  "github.com/Ilyes512/boilr/pkg/cmd"
-  "github.com/Ilyes512/boilr/pkg/util/exit"
-  "github.com/Ilyes512/boilr/pkg/util/osutil"
+	"fmt"
+	"github.com/Ilyes512/boilr/pkg/boilr"
+	"github.com/Ilyes512/boilr/pkg/cmd"
+	"github.com/Ilyes512/boilr/pkg/util/exit"
+	"github.com/Ilyes512/boilr/pkg/util/osutil"
 )
 
 func main() {
-  if exists, err := osutil.DirExists(boilr.Configuration.TemplateDirPath); ! exists {
-    if err := osutil.CreateDirs(boilr.Configuration.TemplateDirPath); err != nil {
-      exit.Error(fmt.Errorf("tried to initialise your template directory, but it has failed: %s", err))
-    }
-  } else if err != nil {
-    exit.Error(fmt.Errorf("failed to init: %s", err))
-  }
+	if exists, err := osutil.DirExists(boilr.Configuration.TemplateDirPath); !exists {
+		if err := osutil.CreateDirs(boilr.Configuration.TemplateDirPath); err != nil {
+			exit.Error(fmt.Errorf("tried to initialise your template directory, but it has failed: %s", err))
+		}
+	} else if err != nil {
+		exit.Error(fmt.Errorf("failed to init: %s", err))
+	}
 
-  cmd.Run()
+	cmd.Run()
 }
-
diff --git a/pkg/boilr/configuration.go b/pkg/boilr/configuration.go
@@ -57,6 +57,7 @@ func TemplatePath(name string) (string, error) {
 	return filepath.Join(Configuration.TemplateDirPath, name), nil
 }
 
+// IsTemplateDirInitialized returns true when the template dir is already initialized.
 func IsTemplateDirInitialized() (bool, error) {
 	return osutil.DirExists(Configuration.TemplateDirPath)
 }

diff --git a/pkg/cmd/bash_completion.go b/pkg/cmd/bash_completion.go
@@ -5,10 +5,10 @@ import (
 	"os"
 	"path/filepath"
 
-	cli "github.com/spf13/cobra"
 	"github.com/Ilyes512/boilr/pkg/boilr"
 	"github.com/Ilyes512/boilr/pkg/util/exit"
 	"github.com/Ilyes512/boilr/pkg/util/osutil"
+	cli "github.com/spf13/cobra"
 )
 
 func configureBashCompletion() error {

diff --git a/pkg/cmd/delete.go b/pkg/cmd/delete.go
@@ -18,7 +18,7 @@ var Delete = &cli.Command{
 	Use:   "delete <template-tag>",
 	Short: "Delete a project template from the template registry",
 	Run: func(c *cli.Command, args []string) {
-		MustValidateVarArgs(args, validate.Argument{"template-path", validate.AlphanumericExt})
+		MustValidateVarArgs(args, validate.Argument{Name: "template-path", Validate: validate.AlphanumericExt})
 
 		MustValidateTemplateDir()
 

diff --git a/pkg/cmd/download.go b/pkg/cmd/download.go
@@ -22,8 +22,8 @@ var Download = &cli.Command{
 	// FIXME Half-Updates leave messy templates
 	Run: func(cmd *cli.Command, args []string) {
 		MustValidateArgs(args, []validate.Argument{
-			{"template-repo", validate.UnixPath},
-			{"template-tag", validate.AlphanumericExt},
+			{Name: "template-repo", Validate: validate.UnixPath},
+			{Name: "template-tag", Validate: validate.AlphanumericExt},
 		})
 
 		MustValidateTemplateDir()

diff --git a/pkg/cmd/flags.go b/pkg/cmd/flags.go
@@ -8,6 +8,8 @@ func GetBoolFlag(c *cli.Command, name string) bool {
 	return c.PersistentFlags().Lookup(name).Value.String() == "true"
 }
 
+// GetStringFlag retrieves the named string command-line
+// flag given the command that contains it.
 func GetStringFlag(c *cli.Command, name string) string {
 	return c.PersistentFlags().Lookup(name).Value.String()
 }
diff --git a/pkg/cmd/init.go b/pkg/cmd/init.go
@@ -3,10 +3,10 @@ package cmd
 import (
 	"fmt"
 
-	cli "github.com/spf13/cobra"
 	"github.com/Ilyes512/boilr/pkg/boilr"
 	"github.com/Ilyes512/boilr/pkg/util/exit"
 	"github.com/Ilyes512/boilr/pkg/util/osutil"
+	cli "github.com/spf13/cobra"
 )
 
 // Init contains the cli-command for initializing the local template

diff --git a/pkg/cmd/metadata.go b/pkg/cmd/metadata.go
@@ -20,10 +20,7 @@ func serializeMetadata(tag string, repo string, targetDir string) error {
 
 	enc := json.NewEncoder(f)
 
-	t := template.Metadata{tag, repo, template.NewTime()}
-	if err := enc.Encode(&t); err != nil {
-		return err
-	}
+	t := template.Metadata{Tag: tag, Repository: repo, Created: template.NewTime()}
 
-	return nil
+	return enc.Encode(&t)
 }
diff --git a/pkg/cmd/rename.go b/pkg/cmd/rename.go
@@ -11,23 +11,15 @@ import (
 	"github.com/Ilyes512/boilr/pkg/util/validate"
 )
 
-func renameTemplate(oldPath, newPath string) error {
-	if err := os.Rename(oldPath, newPath); err != nil {
-		return err
-	}
-
-	return nil
-}
-
 // Rename contains the cli-command for renaming templates in the template registry.
 var Rename = &cli.Command{
 	Hidden: true,
 	Use:    "rename <old-template-tag> <new-template-tag>",
 	Short:  "Rename a project template",
 	Run: func(c *cli.Command, args []string) {
 		MustValidateArgs(args, []validate.Argument{
-			{"old-template-tag", validate.UnixPath},
-			{"new-template-tag", validate.UnixPath},
+			{Name: "old-template-tag", Validate: validate.UnixPath},
+			{Name: "new-template-tag", Validate: validate.UnixPath},
 		})
 
 		MustValidateTemplateDir()
@@ -50,7 +42,7 @@ var Rename = &cli.Command{
 			exit.Fatal(fmt.Errorf("rename: %s", err))
 		}
 
-		if err := renameTemplate(tmplPath, newTmplPath); err != nil {
+		if err := os.Rename(tmplPath, newTmplPath); err != nil {
 			exit.Error(fmt.Errorf("rename: %s", err))
 		}
 

diff --git a/pkg/cmd/save.go b/pkg/cmd/save.go
@@ -20,8 +20,8 @@ var Save = &cli.Command{
 	Short: "Save a local project template to template registry",
 	Run: func(c *cli.Command, args []string) {
 		MustValidateArgs(args, []validate.Argument{
-			{"template-path", validate.UnixPath},
-			{"template-tag", validate.AlphanumericExt},
+			{Name: "template-path", Validate: validate.UnixPath},
+			{Name: "template-tag", Validate: validate.AlphanumericExt},
 		})
 
 		MustValidateTemplateDir()

diff --git a/pkg/cmd/use.go b/pkg/cmd/use.go
@@ -27,15 +27,15 @@ func TemplateInRegistry(name string) (bool, error) {
 	return ok, nil
 }
 
-// TODO add --use-cache flag to execute a template from previous answers to prompts
 // Use contains the cli-command for using templates located in the local template registry.
+// TODO add --use-cache flag to execute a template from previous answers to prompts
 var Use = &cli.Command{
 	Use:   "use <template-tag> <target-dir>",
 	Short: "Execute a project template in the given directory",
 	Run: func(cmd *cli.Command, args []string) {
 		MustValidateArgs(args, []validate.Argument{
-			{"template-tag", validate.UnixPath},
-			{"target-dir", validate.UnixPath},
+			{Name: "template-tag", Validate: validate.UnixPath},
+			{Name: "target-dir", Validate: validate.UnixPath},
 		})
 
 		MustValidateTemplateDir()

diff --git a/pkg/cmd/validate.go b/pkg/cmd/validate.go
@@ -3,9 +3,9 @@ package cmd
 import (
 	"errors"
 
-	cli "github.com/spf13/cobra"
 	"github.com/Ilyes512/boilr/pkg/util/exit"
 	"github.com/Ilyes512/boilr/pkg/util/validate"
+	cli "github.com/spf13/cobra"
 )
 
 var (
@@ -19,7 +19,7 @@ var Validate = &cli.Command{
 	Short: "Validate a local project template",
 	Run: func(_ *cli.Command, args []string) {
 		MustValidateArgs(args, []validate.Argument{
-			{"template-path", validate.UnixPath},
+			{Name: "template-path", Validate: validate.UnixPath},
 		})
 
 		templatePath := args[0]

diff --git a/pkg/prompt/prompt.go b/pkg/prompt/prompt.go
@@ -12,16 +12,13 @@ import (
 
 type templateFunc func() interface{}
 
+// Interface for prompts.
 type Interface interface {
 	// PromptMessage returns a proper prompt message for the given field with the given default value.
 	PromptMessage(string) string
 	EvaluateChoice(string) (interface{}, error)
 }
 
-type Chain struct {
-	Prompts []Interface
-}
-
 type strPrompt string
 
 func (p strPrompt) PromptMessage(name string) string {
@@ -86,6 +83,7 @@ func (p multipleChoicePrompt) EvaluateChoice(c string) (interface{}, error) {
 	return p[0], nil
 }
 
+// Func creates template functions for prompts.
 // TODO add deep pretty printer
 // TODO handle TOML
 func Func(defval interface{}) Interface {

diff --git a/pkg/util/tlog/log.go b/pkg/util/tlog/log.go
@@ -36,6 +36,7 @@ var (
 // Level is a 16-bit set holding the enabled log levels.
 type Level uint16
 
+// All available error levels.
 const (
 	LevelDebug   = 1 << 5
 	LevelFatal   = 1 << 4