Merge pull request #406 from sakshamb2113/HotCommands

Add CLI Feature: Hot commands

Author: devbugging

cmd/flow/main.go

@@ -49,6 +49,8 @@ func main() {
 
 	// quick commands
 	quick.InitCommand.AddToParent(cmd)
+	quick.DeployCommand.AddToParent(cmd)
+	quick.RunCommand.AddToParent(cmd)
 	status.Command.AddToParent(cmd)
 
 	// structured commands
@@ -67,7 +69,8 @@ func main() {
 	cmd.AddCommand(signatures.Cmd)
 
 	command.InitFlags(cmd)
-
+	// Set usage template to custom template
+	cmd.SetUsageTemplate("Usage:{{if .Runnable}}\n{{.UseLine}}{{end}}{{if .HasAvailableSubCommands}}\n{{.CommandPath}} [command]{{end}}{{if gt (len .Aliases) 0}}\n\nAliases:\n{{.NameAndAliases}}{{end}}{{if .HasExample}}\n\nExamples:\n{{.Example}}{{end}}{{if .HasAvailableSubCommands}}\n\n{{if (eq .Name \"flow\")}}Hot Commands:\n{{range .Commands}}{{if (and (.IsAvailableCommand)  (index .Annotations \"HotCommand\") )}}\n{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}\n\n{{end}}Available Commands:\n{{range .Commands}}{{if (and (or .IsAvailableCommand (eq .Name \"help\")) (not (index .Annotations \"HotCommand\")))}}\n{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}\n\nFlags:\n{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}\n\nGlobal Flags:\n{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}\n\nAdditional help topics:\n{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}{{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableSubCommands}}\nUse \"{{.CommandPath}} [command] --help\" for more information about a command.{{end}}\n")
 	if err := cmd.Execute(); err != nil {
 		util.Exit(1, err.Error())
 	}

internal/quick/deploy.go

@@ -0,0 +1,40 @@
+/*
+* Flow CLI
+*
+* Copyright 2019-2021 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 quick
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/onflow/flow-cli/internal/command"
+	"github.com/onflow/flow-cli/internal/project"
+)
+
+// add deploy command
+var DeployCommand = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "deploy",
+		Short:   "Deploy all project contracts",
+		Example: "flow deploy",
+		Annotations: map[string]string{
+			"HotCommand": "true",
+		},
+	},
+	Flags: project.DeployCommand.Flags,
+	RunS:  project.DeployCommand.RunS,
+}

internal/quick/init.go

@@ -32,6 +32,9 @@ var InitCommand = &command.Command{
 		Use:     "init",
 		Short:   "Initialize a new configuration",
 		Example: "flow project init",
+		Annotations: map[string]string{
+			"HotCommand": "true",
+		},
 	},
 	Flags: &config.InitFlag,
 	Run:   config.Initialise, // TODO(sideninja) workaround - init needed to be copied in order to work else there is flag duplicate error

internal/quick/run.go

@@ -0,0 +1,101 @@
+/*
+* Flow CLI
+*
+* Copyright 2019-2021 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 quick
+
+import (
+	"github.com/onflow/flow-cli/internal/command"
+	"github.com/onflow/flow-cli/internal/emulator"
+	"github.com/onflow/flow-cli/internal/project"
+	"github.com/onflow/flow-cli/pkg/flowkit"
+	"github.com/onflow/flow-cli/pkg/flowkit/services"
+	"github.com/spf13/cobra"
+	"sync"
+)
+
+type flagsRun struct {
+}
+
+var runFlags = flagsRun{}
+func DeployHelper(args []string, globalFlags command.GlobalFlags, services *services.Services, wg *sync.WaitGroup) {
+
+	for true {
+		//check if the server has started
+		_, err := services.Status.Ping(globalFlags.Network)
+		if err == nil {
+			// if the emulator is running run the deploy command
+			project.DeployCommand.Cmd.Run(project.DeployCommand.Cmd, args)
+			break
+		}
+	}
+
+	wg.Done()
+
+}
+
+func EmulatorHelper(args []string, globalFlags command.GlobalFlags, services *services.Services, wg *sync.WaitGroup) {
+	// run the emulator
+	emulator.Cmd.Run(emulator.Cmd, args)
+	wg.Done()
+}
+
+// This command will act as an alias for running the emulator and deploying the contracts
+var RunCommand = &command.Command{
+	Cmd: &cobra.Command{
+		Use:     "run",
+		Short:   "Start emulator and deploy all project contracts",
+		Example: "flow run",
+		Annotations: map[string]string{
+			"HotCommand": "true",
+		},
+	},
+	Flags: &runFlags,
+	Run: func(
+		args []string,
+		_ flowkit.ReaderWriter,
+		globalFlags command.GlobalFlags,
+		services *services.Services,
+	) (command.Result, error) {
+		var waitGroup sync.WaitGroup
+		// set number of goroutines
+		waitGroup.Add(2)
+		go EmulatorHelper(args, globalFlags, services, &waitGroup)
+		go DeployHelper(args, globalFlags, services, &waitGroup)
+		// wait until completion of the goroutines
+		waitGroup.Wait()
+
+		emulator.Cmd.Run(emulator.Cmd, args)
+		return &RunResult{}, nil
+	},
+}
+
+type RunResult struct {
+}
+
+func (r *RunResult) JSON() interface{} {
+	result := make(map[string]string)
+	return result
+}
+
+func (r *RunResult) String() string {
+	return ""
+}
+
+func (r *RunResult) Oneliner() string {
+	return ""
+}