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

181 lines
4.9 KiB
Go
Raw Normal View History

2015-10-28 17:43:58 +00:00
// 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 (
"fmt"
2017-04-29 10:02:02 +00:00
"os"
2015-10-28 17:43:58 +00:00
"path/filepath"
2017-05-01 20:52:58 +00:00
"unicode"
2015-10-28 17:43:58 +00:00
"github.com/spf13/cobra"
)
func init() {
addCmd.Flags().StringVarP(&packageName, "package", "t", "", "target package name (e.g. github.com/spf13/hugo)")
2017-05-01 20:52:58 +00:00
addCmd.Flags().StringVarP(&parentName, "parent", "p", "RootCmd", "name of parent command for this command")
2015-10-28 17:43:58 +00:00
}
var packageName, parentName string
2015-10-28 17:43:58 +00:00
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).
2015-10-28 17:43:58 +00:00
If you want your command to be public, pass in the command name
with an initial uppercase letter.
2015-10-28 17:43:58 +00:00
2017-04-29 10:02:02 +00:00
Example: cobra add server -> resulting in a new cmd/server.go`,
2015-10-28 17:43:58 +00:00
Run: func(cmd *cobra.Command, args []string) {
2017-04-29 10:02:02 +00:00
if len(args) < 1 {
2015-10-28 17:43:58 +00:00
er("add needs a name for the command")
}
var project *Project
if packageName != "" {
project = NewProject(packageName)
} else {
wd, err := os.Getwd()
if err != nil {
er(err)
}
project = NewProjectFromPath(wd)
2017-04-29 10:02:02 +00:00
}
2017-05-05 08:06:10 +00:00
2017-05-01 20:52:58 +00:00
cmdName := validateCmdName(args[0])
2017-05-05 08:06:10 +00:00
cmdPath := filepath.Join(project.CmdPath(), cmdName+".go")
createCmdFile(project.License(), cmdPath, cmdName)
fmt.Fprintln(cmd.OutOrStdout(), cmdName, "created at", cmdPath)
2015-10-28 17:43:58 +00:00
},
}
2017-05-01 20:52:58 +00:00
// validateCmdName returns source without any dashes and underscore.
// If there will be dash or underscore, next letter will be uppered.
// It supports only ASCII (1-byte character) strings.
2017-05-05 08:06:10 +00:00
// https://github.com/spf13/cobra/issues/269
2017-05-01 20:52:58 +00:00
func validateCmdName(source string) string {
i := 0
l := len(source)
// The output is initialized on demand, then first dash or underscore
// occurs.
var output string
for i < l {
if source[i] == '-' || source[i] == '_' {
if output == "" {
output = source[:i]
}
// If it's last rune and it's dash or underscore,
// don't add it output and break the loop.
if i == l-1 {
break
}
2017-05-01 20:52:58 +00:00
// If next character is dash or underscore,
// just skip the current character.
if source[i+1] == '-' || source[i+1] == '_' {
i++
continue
}
// If the current character is dash or underscore,
// upper next letter and add to output.
output += string(unicode.ToUpper(rune(source[i+1])))
// We know, what source[i] is dash or underscore and source[i+1] is
// uppered character, so make i = i+2.
i += 2
continue
}
// If the current character isn't dash or underscore,
// just add it.
if output != "" {
output += string(source[i])
}
i++
}
if output == "" {
return source // source is initially valid name.
}
return output
2015-10-28 17:43:58 +00:00
}
2017-05-05 08:06:10 +00:00
func createCmdFile(license License, path, cmdName string) {
2017-04-29 10:02:02 +00:00
template := `{{comment .copyright}}
{{if .license}}//
{{comment .license}}{{end}}
package {{.cmdPackage}}
2015-10-28 17:43:58 +00:00
import (
"fmt"
2015-10-28 17:43:58 +00:00
"github.com/spf13/cobra"
)
2015-11-24 13:46:13 +00:00
// {{.cmdName}}Cmd represents the {{.cmdName}} command
2017-04-29 10:02:02 +00:00
var {{.cmdName}}Cmd = &cobra.Command{
Use: "{{.cmdName}}",
2015-10-28 17:43:58 +00:00
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.` + "`" + `,
2015-10-28 17:43:58 +00:00
Run: func(cmd *cobra.Command, args []string) {
2017-04-29 10:02:02 +00:00
fmt.Println("{{.cmdName}} called")
},
2015-10-28 17:43:58 +00:00
}
func init() {
2017-04-29 10:02:02 +00:00
{{.parentName}}.AddCommand({{.cmdName}}Cmd)
2015-10-28 17:43:58 +00:00
// Here you will define your flags and configuration settings.
2015-10-28 17:43:58 +00:00
// Cobra supports Persistent Flags which will work for this command
// and all subcommands, e.g.:
// {{.cmdName}}Cmd.PersistentFlags().String("foo", "", "A help for foo")
2015-10-28 17:43:58 +00:00
// Cobra supports local flags which will only run when this command
// is called directly, e.g.:
// {{.cmdName}}Cmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
2015-10-28 17:43:58 +00:00
}
`
2017-04-29 10:02:02 +00:00
data := make(map[string]interface{})
2015-10-28 17:43:58 +00:00
data["copyright"] = copyrightLine()
2017-05-05 08:06:10 +00:00
data["license"] = license.Header
data["cmdPackage"] = filepath.Base(filepath.Dir(path)) // last dir of path
2017-04-29 10:02:02 +00:00
data["parentName"] = parentName
2015-10-28 17:43:58 +00:00
data["cmdName"] = cmdName
2017-04-29 10:02:02 +00:00
cmdScript, err := executeTemplate(template, data)
if err != nil {
er(err)
}
2017-05-05 08:06:10 +00:00
err = writeStringToFile(path, cmdScript)
2015-10-28 17:43:58 +00:00
if err != nil {
er(err)
}
}