spf13--cobra/cobra/cmd/add.go

// Copyright © 2015 Steve Francia <spf@spf13.com>.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cmd

import (
	"path"
	"fmt"
	"path/filepath"
	"strings"

	"github.com/spf13/cobra"
	"github.com/spf13/viper"
)

func init() {
	RootCmd.AddCommand(addCmd)
}

var pName string

// initialize Command
var addCmd = &cobra.Command{
	Use:     "add [command name]",
	Aliases: []string{"command"},
	Short:   "Add a command to a Cobra Application",
	Long: `Add (cobra add) will create a new command, with a license and
the appropriate structure for a Cobra-based CLI application,
and register it to its parent (default RootCmd).

If you want your command to be public, pass in the command name
with an initial uppercase letter.

Example: cobra add server  -> resulting in a new cmd/server.go
  `,

	Run: func(cmd *cobra.Command, args []string) {
		if len(args) != 1 {
			er("add needs a name for the command")
		}
		guessProjectPath()

		// Iterate over command parts delimited by "/".
		cmdParts := strings.Split(args[0], "/")
		for i := len(cmdParts) - 1; i >= 0; i-- {
			if i > 0 {
				pName = cmdParts[i-1]
			}
			createCmdFile(cmdParts[i], buildPath(cmdParts, i - 1))
		}
	},
}

func init() {
	addCmd.Flags().StringVarP(&pName, "parent", "p", "RootCmd", "name of parent command for this command")
}

func parentName() string {
	if !strings.HasSuffix(strings.ToLower(pName), "cmd") {
		return pName + "Cmd"
	}

	return pName
}

func createCmdFile(cmdName, cmdPath string) {
	lic := getLicense()

	template := `{{ comment .copyright }}
{{ comment .license }}

package {{ .packageName }}

import (
	"fmt"
	{{ if .importpath }}
	"{{ .importpath }}"{{ end }}
	"github.com/spf13/cobra"
)

// {{ .cmdName | title }}Cmd represents the {{ .cmdName }} command
var {{ .cmdName | title }}Cmd = &cobra.Command{
	Use:   "{{ .cmdName }}",
	Short: "A brief description of your command",
	Long: ` + "`" + `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.` + "`" + `,
	Run: func(cmd *cobra.Command, args []string) {
		// TODO: Work your own magic here
		fmt.Println("{{ .cmdName }} called")
	},
}

func init() {
	{{ if eq .parentName "RootCmd" }}{{ .parentName }}.AddCommand({{ .cmdName | title }}Cmd){{ end }}
	{{ $cmdName := .cmdName }}{{ range $child := .children }}
	{{ $cmdName | title }}Cmd.AddCommand({{ $cmdName }}.{{ $child | title }}Cmd){{ end }}

	// Here you will define your flags and configuration settings.

	// Cobra supports Persistent Flags which will work for this command
	// and all subcommands, e.g.:
	// {{ .cmdName | title }}Cmd.PersistentFlags().String("foo", "", "A help for foo")

	// Cobra supports local flags which will only run when this command
	// is called directly, e.g.:
	// {{ .cmdName | title }}Cmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}
`

	data := make(map[string]interface{})

	data["packageName"] = "cmd"

	//
	if cmdPath != "" {
		data["packageName"] = path.Base(cmdPath)
	}

	data["copyright"] = copyrightLine()
	data["license"] = lic.Header
	data["appName"] = projectName()
	data["viper"] = viper.GetBool("useViper")
	data["parentName"] = parentName()
	data["cmdName"] = cmdName

	path := filepath.Join(ProjectPath(), guessCmdDir(), cmdPath)
	filename := cmdName + ".go"

	children := getChildNames(path, cmdName)
	if len(children) > 0 {
		data["importpath"] = filepath.Join(
			guessImportPath(),
			guessCmdDir(),
			cmdPath,
			cmdName,
		)
	}
	data["children"] = children

	// Check if the file exists before trying to create it.
	if doesExist, err := exists(filepath.Join(path, filename)); !doesExist {
		if err = writeTemplateToFile(path, filename, template, data); err != nil {
			er(err)
		}
		fmt.Println(cmdName, "created at", path)
	} else if len(children) > 0 {
		if err = writeTemplateToFile(path, filename, template, data); err != nil {
			er(err)
		}
		fmt.Println(cmdName, "updated at", path)
	} else {
		fmt.Println(cmdName, "already exists at", path)
	}
}