feat: Improve app scaffolding

changelog.md

@@ -5,6 +5,7 @@
 ### Features
 
 - [#3830](https://github.com/ignite/cli/pull/3830) Remove gRPC info from Ignite Apps errors
+- [#3839](https://github.com/ignite/cli/pull/3839) New structure for app scaffolding
 
 ### Changes
 

ignite/services/plugin/plugin_test.go

@@ -363,7 +363,7 @@ func TestPluginLoad(t *testing.T) {
 			manifest, err := p.Interface.Manifest(ctx)
 			require.NoError(err)
 			assert.Equal(p.name, manifest.Name)
-			assert.NoError(p.Interface.Execute(ctx, &ExecutedCommand{}, clientAPI))
+			assert.NoError(p.Interface.Execute(ctx, &ExecutedCommand{OsArgs: []string{"ignite", p.name}}, clientAPI))
 			assert.NoError(p.Interface.ExecuteHookPre(ctx, &ExecutedHook{}, clientAPI))
 			assert.NoError(p.Interface.ExecuteHookPost(ctx, &ExecutedHook{}, clientAPI))
 			assert.NoError(p.Interface.ExecuteHookCleanUp(ctx, &ExecutedHook{}, clientAPI))

ignite/services/plugin/scaffold.go

@@ -6,11 +6,15 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"strings"
 
 	"github.com/gobuffalo/genny/v2"
 	"github.com/gobuffalo/plush/v4"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
 
 	"github.com/ignite/cli/v28/ignite/pkg/errors"
+	"github.com/ignite/cli/v28/ignite/pkg/gocmd"
 	"github.com/ignite/cli/v28/ignite/pkg/xgenny"
 )
 
@@ -21,6 +25,7 @@ var fsPluginSource embed.FS
 func Scaffold(ctx context.Context, dir, moduleName string, sharedHost bool) (string, error) {
 	var (
 		name     = filepath.Base(moduleName)
+		title    = toTitle(name)
 		finalDir = path.Join(dir, name)
 		g        = genny.New()
 		template = xgenny.NewEmbedWalker(
@@ -42,6 +47,7 @@ func Scaffold(ctx context.Context, dir, moduleName string, sharedHost bool) (str
 	pctx := plush.NewContextWithContext(ctx)
 	pctx.Set("ModuleName", moduleName)
 	pctx.Set("Name", name)
+	pctx.Set("Title", title)
 	pctx.Set("SharedHost", sharedHost)
 
 	g.Transformer(xgenny.Transformer(pctx))
@@ -55,5 +61,16 @@ func Scaffold(ctx context.Context, dir, moduleName string, sharedHost bool) (str
 		return "", errors.WithStack(err)
 	}
 
+	if err := gocmd.ModTidy(ctx, finalDir); err != nil {
+		return "", errors.WithStack(err)
+	}
+	if err := gocmd.Fmt(ctx, finalDir); err != nil {
+		return "", errors.WithStack(err)
+	}
+
 	return finalDir, nil
 }
+
+func toTitle(s string) string {
+	return strings.ReplaceAll(strings.ReplaceAll(cases.Title(language.English).String(s), "_", ""), "-", "")
+}

ignite/services/plugin/template/.gitignore.plush

@@ -1 +1,19 @@
-<%= Name %>
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.app
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work

ignite/services/plugin/template/app.ignite.yml.plush

@@ -0,0 +1,3 @@
+<%= Name %>:
+  description: <%= Name %> is an awesome Ignite application!
+  path: ./

ignite/services/plugin/template/cmd/cmd.go.plush

@@ -0,0 +1,23 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// New<%= Title %> creates a new <%= Name %> command.
+func New<%= Title %>() *cobra.Command {
+	c := &cobra.Command{
+		Use:           "<%= Name %>",
+		Short:         "Say hello to the world of ignite!",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			fmt.Println("Hello, world!")
+			return nil
+		},
+	}
+
+	return c
+}

ignite/services/plugin/template/go.mod.plush

@@ -5,4 +5,6 @@ go 1.21
 require (
 	github.com/hashicorp/go-plugin v1.5.0
 	github.com/ignite/cli/v28 v28.0.0
+	github.com/spf13/cobra v1.7.0
+	github.com/stretchr/testify v1.8.4
 )

ignite/services/plugin/template/integration/integration_test.go.plush

@@ -0,0 +1,71 @@
+package integration_test
+
+import (
+	"bytes"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	pluginsconfig "github.com/ignite/cli/v28/ignite/config/plugins"
+	"github.com/ignite/cli/v28/ignite/pkg/cmdrunner/step"
+	"github.com/ignite/cli/v28/ignite/services/plugin"
+	envtest "github.com/ignite/cli/v28/integration"
+)
+
+func Test<%= Title %>(t *testing.T) {
+	var (
+		require = require.New(t)
+		assert  = assert.New(t)
+		env     = envtest.New(t)
+		app     = env.Scaffold("github.com/test/test")
+
+		assertPlugins = func(expectedLocalPlugins, expectedGlobalPlugins []pluginsconfig.Plugin) {
+			localCfg, err := pluginsconfig.ParseDir(app.SourcePath())
+			require.NoError(err)
+			assert.ElementsMatch(expectedLocalPlugins, localCfg.Apps, "unexpected local apps")
+
+			globalCfgPath, err := plugin.PluginsPath()
+			require.NoError(err)
+			globalCfg, err := pluginsconfig.ParseDir(globalCfgPath)
+			require.NoError(err)
+			assert.ElementsMatch(expectedGlobalPlugins, globalCfg.Apps, "unexpected global apps")
+		}
+	)
+
+	dir, err := os.Getwd()
+	require.NoError(err)
+	pluginPath := filepath.Join(filepath.Dir(filepath.Dir(dir)), "<%= Name %>")
+
+	env.Must(env.Exec("add <%= Name %> plugin",
+		step.NewSteps(step.New(
+			step.Exec(envtest.IgniteApp, "app", "install", "-g", pluginPath),
+			step.Workdir(app.SourcePath()),
+		)),
+	))
+
+	// one local plugin expected
+	assertPlugins(
+		nil,
+		[]pluginsconfig.Plugin{
+			{
+				Path: pluginPath,
+			},
+		},
+	)
+
+	buf := &bytes.Buffer{}
+	env.Must(env.Exec("run <%= Name %>",
+		step.NewSteps(step.New(
+			step.Exec(
+				envtest.IgniteApp,
+				"<%= Name %>",
+			),
+			step.Workdir(app.SourcePath()),
+			step.Stdout(buf),
+		)),
+	))
+	assert.Equal("Hello, world!\n", buf.String())
+}

ignite/services/plugin/template/main.go.plush

@@ -2,117 +2,45 @@ package main
 
 import (
 	"context"
-	"fmt"
-	"path/filepath"
+	"os"
 
 	hplugin "github.com/hashicorp/go-plugin"
 
-	"github.com/ignite/cli/v28/ignite/services/chain"
 	"github.com/ignite/cli/v28/ignite/services/plugin"
+	"<%= ModuleName %>/cmd"
 )
 
 type app struct{}
 
-func (app) Manifest(ctx context.Context) (*plugin.Manifest, error) {
-	return &plugin.Manifest{
-		Name: "<%= Name %>",
-		// TODO: Add commands here
-		Commands: []*plugin.Command{
-			// Example of a command
-			{
-				Use:   "<%= Name %>",
-				Short: "Explain what the command is doing...",
-				Long:  "Long description goes here...",
-				Flags: []*plugin.Flag{
-					{Name: "my-flag", Type: plugin.FlagTypeString, Usage: "my flag description"},
-				},
-				PlaceCommandUnder: "ignite",
-				// Examples of adding subcommands:
-				// Commands: []*plugin.Command{
-				// 	{Use: "add"},
-				// 	{Use: "list"},
-				// 	{Use: "delete"},
-				// },
-			},
-		},
-		// TODO: Add hooks here
-		Hooks: []*plugin.Hook{},
-		SharedHost: <%= SharedHost %>,
-	}, nil
-}
-
-func (app) Execute(ctx context.Context, cmd *plugin.ExecutedCommand, api plugin.ClientAPI) error {
-	// TODO: write command execution here
-	fmt.Printf("Hello I'm the example-plugin plugin\n")
-	fmt.Printf("My executed command: %q\n", cmd.Path)
-	fmt.Printf("My args: %v\n", cmd.Args)
-
-	flags, err := cmd.NewFlags()
-	if err != nil {
-		return err
+func (app) Manifest(_ context.Context) (*plugin.Manifest, error) {
+	m := &plugin.Manifest{
+		Name: "<%= Name %>",<%= if (SharedHost) { %>
+		SharedHost: true,<% } %>
 	}
-
-	myFlag, _ := flags.GetString("my-flag")
-	fmt.Printf("My flags: my-flag=%q\n", myFlag)
-	fmt.Printf("My config parameters: %v\n", cmd.With)
-
-	// This is how the plugin can access the chain:
-	// c, err := getChain(cmd)
-	// if err != nil {
-	// 	return err
-	// }
-
-	// According to the number of declared commands, you may need a switch:
-	/*
-		switch cmd.Use {
-		case "add":
-			fmt.Println("Adding stuff...")
-		case "list":
-			fmt.Println("Listing stuff...")
-		case "delete":
-			fmt.Println("Deleting stuff...")
-		}
-	*/
-
-	// ClientAPI call example
-	fmt.Println(api.GetChainInfo(ctx))
-
-	return nil
+	m.ImportCobraCommand(cmd.New<%= Title %>(), "ignite")
+	return m, nil
 }
 
-func (app) ExecuteHookPre(ctx context.Context, h *plugin.ExecutedHook, api plugin.ClientAPI) error {
-	fmt.Printf("Executing hook pre %q\n", h.Hook.GetName())
-	return nil
+func (app) Execute(_ context.Context, c *plugin.ExecutedCommand, _ plugin.ClientAPI) error {
+	// Instead of a switch on c.Use, we run the root command like if
+	// we were in a command line context. This implies to set os.Args
+	// correctly.
+	// Remove the first arg "ignite" from OSArgs because our <%= Name %>
+	// command root is "<%= Name %>" not "ignite".
+	os.Args = c.OsArgs[1:]
+	return cmd.New<%= Title %>().Execute()
 }
 
-func (app) ExecuteHookPost(ctx context.Context, h *plugin.ExecutedHook, api plugin.ClientAPI) error {
-	fmt.Printf("Executing hook post %q\n", h.Hook.GetName())
+func (app) ExecuteHookPre(_ context.Context, _ *plugin.ExecutedHook, _ plugin.ClientAPI) error {
 	return nil
 }
 
-func (app) ExecuteHookCleanUp(ctx context.Context, h *plugin.ExecutedHook, api plugin.ClientAPI) error {
-	fmt.Printf("Executing hook cleanup %q\n", h.Hook.GetName())
+func (app) ExecuteHookPost(_ context.Context, _ *plugin.ExecutedHook, _ plugin.ClientAPI) error {
 	return nil
 }
 
-func getChain(cmd *plugin.ExecutedCommand, chainOption ...chain.Option) (*chain.Chain, error) {
-	flags, err := cmd.NewFlags()
-	if err != nil {
-		return nil, err
-	}
-
-	var (
-		home, _ = flags.GetString("home")
-		path, _ = flags.GetString("path")
-	)
-	if home != "" {
-		chainOption = append(chainOption, chain.HomePath(home))
-	}
-	absPath, err := filepath.Abs(path)
-	if err != nil {
-		return nil, err
-	}
-	return chain.New(absPath, chainOption...)
+func (app) ExecuteHookCleanUp(_ context.Context, _ *plugin.ExecutedHook, _ plugin.ClientAPI) error {
+	return nil
 }
 
 func main() {