Add generate templates command

README.md

@@ -36,23 +36,42 @@ Read about supported commands in the [CLI documentation website](https://develop
 Usage:
   flow [command]
 
-Available Commands:
-  accounts     Utilities to manage accounts
-  blocks       Utilities to read blocks
+👋 Welcome Flow developer!
+   If you are starting a new flow project try running 'flow setup <project_name>'. 
+
+🔥 Super Commands
+  dev          Build your Flow project
+  flix         Execute FLIX template with a given id, name, or local filename
+  generate     Generate new boilerplate files
+  setup        Start a new Flow project
+
+📦 Flow Entities
+  accounts     Create and retrieve accounts and deploy contracts
+  blocks       Retrieve blocks
+  collections  Retrieve collections
+  events       Retrieve events
+
+💬 Flow Interactions
+  scripts      Execute Cadence scripts
+  transactions Build, sign, send and retrieve transactions
+
+🔨 Flow Tools
   cadence      Execute Cadence code
-  collections  Utilities to read collections
-  config       Utilities to manage configuration
-  emulator     Starts the Flow emulator server
+  dev-wallet   Run a development wallet
+  emulator     Run Flow network for development
+  flowser      Run Flowser project explorer
   test         Run Cadence tests
-  events       Utilities to read events
-  help         Help about any command
+
+🏄 Flow Project
+  deploy       Deploy all project contracts
   init         Initialize a new configuration
-  keys         Utilities to manage keys
   project      Manage your Cadence project
-  scripts      Utilities to execute scripts
-  status       Display the status of the Flow network
-  transactions Utilities to send transactions
-  version      View version and commit information
+  run          Start emulator and deploy all project contracts
+
+🔒 Flow Security
+  keys         Generate and decode Flow keys
+  signatures   Signature verification and creation
+
 ```
 
 The Flow CLI includes several commands to interact with Flow networks, such as querying account information, or sending transactions. It also includes the [Flow Emulator](https://developers.flow.com/tools/emulator).

cmd/flow/main.go

@@ -69,6 +69,7 @@ func main() {
 	super.SetupCommand.AddToParent(cmd)
 	super.DevCommand.AddToParent(cmd)
 	super.FlixCommand.AddToParent(cmd)
+	cmd.AddCommand(super.GenerateCommand)
 
 	// structured commands
 	cmd.AddCommand(settings.Cmd)

internal/super/generate.go

@@ -0,0 +1,192 @@
+/*
+ * Flow CLI
+ *
+ * Copyright 2019 Dapper Labs, Inc.
+ *
+ * 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 super
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/onflow/flow-cli/flowkit"
+
+	"github.com/onflow/flow-cli/flowkit/output"
+	"github.com/onflow/flow-cli/internal/command"
+
+	"github.com/spf13/cobra"
+)
+
+type generateFlagsDef struct {
+	Directory string `default:"" flag:"dir" info:"Directory to generate files in"`
+}
+
+var generateFlags = generateFlagsDef{}
+
+var GenerateCommand = &cobra.Command{
+	Use:     "generate",
+	Short:   "Generate new boilerplate files",
+	GroupID: "super",
+}
+
+var GenerateContractCommand = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "contract <name>",
+		Short:   "Generate a new contract",
+		Example: "flow generate contract HelloWorld",
+		Args:    cobra.ExactArgs(1),
+	},
+	Flags: &generateFlags,
+	RunS:  generateContract,
+}
+
+var GenerateTransactionCommand = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "transaction <name>",
+		Short:   "Generate a new transaction",
+		Example: "flow generate transaction SomeTransaction",
+		Args:    cobra.ExactArgs(1),
+	},
+	Flags: &generateFlags,
+	RunS:  generateTransaction,
+}
+
+var GenerateScriptCommand = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "script <name>",
+		Short:   "Generate a new script",
+		Example: "flow generate script SomeScript",
+		Args:    cobra.ExactArgs(1),
+	},
+	Flags: &generateFlags,
+	RunS:  generateScript,
+}
+
+func init() {
+	GenerateContractCommand.AddToParent(GenerateCommand)
+	GenerateTransactionCommand.AddToParent(GenerateCommand)
+	GenerateScriptCommand.AddToParent(GenerateCommand)
+}
+
+func generateContract(
+	args []string,
+	_ command.GlobalFlags,
+	logger output.Logger,
+	flow flowkit.Services,
+	state *flowkit.State,
+) (result command.Result, err error) {
+	return generateNew(args, "contract", logger)
+}
+
+func generateTransaction(
+	args []string,
+	_ command.GlobalFlags,
+	logger output.Logger,
+	flow flowkit.Services,
+	state *flowkit.State,
+) (result command.Result, err error) {
+	return generateNew(args, "transaction", logger)
+}
+
+func generateScript(
+	args []string,
+	_ command.GlobalFlags,
+	logger output.Logger,
+	flow flowkit.Services,
+	state *flowkit.State,
+) (result command.Result, err error) {
+	return generateNew(args, "script", logger)
+}
+
+func generateNew(
+	args []string,
+	templateType string,
+	logger output.Logger,
+) (result command.Result, err error) {
+	if len(args) < 1 {
+		return nil, fmt.Errorf("invalid number of arguments")
+	}
+
+	name := args[0]
+	var filename string
+
+	// Don't add .cdc extension if it's already there
+	if strings.HasSuffix(name, ".cdc") {
+		filename = name
+	} else {
+		filename = fmt.Sprintf("%s.cdc", name)
+	}
+
+	var fileToWrite string
+	var basePath string
+
+	if generateFlags.Directory != "" {
+		basePath = generateFlags.Directory
+	} else {
+		switch templateType {
+		case "contract":
+			basePath = "cadence/contracts"
+		case "script":
+			basePath = "cadence/scripts"
+		case "transaction":
+			basePath = "cadence/transactions"
+		default:
+			return nil, fmt.Errorf("invalid template type: %s", templateType)
+		}
+	}
+
+	switch templateType {
+	case "contract":
+		fileToWrite = fmt.Sprintf(`
+pub contract %s {
+    init() {}
+}`, name)
+	case "script":
+		fileToWrite = `pub fun main() {
+    // Script details here
+}`
+	case "transaction":
+		fileToWrite = `transaction() {
+    prepare(account:AuthAccount) {}
+
+    execute {}
+}`
+	default:
+		return nil, fmt.Errorf("invalid template type: %s", templateType)
+	}
+
+	filenameWithBasePath := filepath.Join(basePath, filename)
+
+	if _, err := os.Stat(filenameWithBasePath); err == nil {
+		return nil, fmt.Errorf("file already exists: %s", filenameWithBasePath)
+	}
+
+	// Ensure the directory exists
+	if err := os.MkdirAll(basePath, 0755); err != nil {
+		return nil, fmt.Errorf("error creating directories: %w", err)
+	}
+
+	err = os.WriteFile(filenameWithBasePath, []byte(fileToWrite), 0644)
+	if err != nil {
+		return nil, fmt.Errorf("error writing file: %w", err)
+	}
+
+	logger.Info(fmt.Sprintf("Generated new %s: %s at %s", templateType, name, filenameWithBasePath))
+
+	return nil, err
+}