cmd

Documentation

Overview

Copyright © 2022 Drew Cain -- @groksrc

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.

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Copyright © 2022 Drew Cain -- @groksrc

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Copyright © 2022 Drew Cain -- @groksrc

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.

Copyright © 2022 Drew Cain -- @groksrc

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.

Copyright © 2022 Drew Cain -- @groksrc

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.

Index

• Variables
• func Execute()
• type DxConfig
• type OutCommand
• type OutCommandData
• type OutConfig

Variables

var Body string

var Compile bool

var Parent string

var Templates = map[string]string{

	"main.go": `/*
*/
package main

import "{{ .Cli }}/cmd"

func main() {
	cmd.Execute()
}
`,

	"cmd/root.go": `/*
*/
package cmd

import (
	"os"

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

var cfgFile string

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
	Use:   "{{ .Cli }}",
	Short: "Short Description of your CLI",
	Long: ` + "`" + `A longer description that spans multiple lines and likely contains
examples and usage of using your application. 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.` + "`" + `,
	// Uncomment the following line if your bare application
	// has an action associated with it:
	// Run: func(cmd *cobra.Command, args []string) { },
}

// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
	err := rootCmd.Execute()
	if err != nil {
		os.Exit(1)
	}
}

func init() {
	cobra.OnInitialize(initConfig)
}

// initConfig reads in config file and ENV variables if set.
func initConfig() {

	// Find home directory.
	home, err := os.UserHomeDir()
	cobra.CheckErr(err)

	// Search config in home directory with name ".{{ .Cli }}" (without extension).
	viper.AddConfigPath(home)
	viper.SetConfigType("yaml")
	viper.SetConfigName(".{{ .Cli }}")

	viper.AutomaticEnv() // read in environment variables that match

	viper.ReadInConfig()
}
`,

	"command": `
	package cmd

	import (
		"os"
		"os/exec"

		"github.com/spf13/cobra"
	)

	// {{ .CommandVar }}Cmd represents the {{ .CommandName }} command
	var {{ .CommandVar }}Cmd = &cobra.Command{
		Use:   "{{ .CommandName }}",
		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) {
			command := exec.Command("bash", "-c", ` + "`" + `{{ .Body }}` + "`" + `)
			command.Stdout = os.Stdout
			command.Run()
		},
	}

	func init() {
		{{ .Parent }}Cmd.AddCommand({{ .CommandVar }}Cmd)
	}
`,
}

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type DxConfig

type DxConfig struct{ Cli, Company, Description, OutDir string }

type OutCommand

type OutCommand struct {
	Name string `yaml:"name"`
	Body string `yaml:"body"`
	Full string `yaml:"full"`
}

type OutCommandData

type OutCommandData struct {
	CommandName,
	CommandVar,
	Parent,
	Body string
}

type OutConfig

type OutConfig struct {
	Cli      string              `yaml:"cli"`
	Company  string              `yaml:"company"`
	Commands []map[string]string `yaml:"commands"`
}