feat: scaffold a new app without a default module (#1214)

Author: lumtis

changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features:
+
+- Added the flag `--no-default-module` to the command `starport app` to prevent scaffolding a default module when creating a new app
+
 ## `v0.16.1`
 
 ### Features:

integration/cmd_app_test.go

@@ -3,6 +3,7 @@
 package integration_test
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 	"testing"
@@ -11,19 +12,52 @@ import (
 	"github.com/tendermint/starport/starport/pkg/cmdrunner/step"
 )
 
-func TestGenerateAnAppAndVerify(t *testing.T) {
+func TestGenerateAnApp(t *testing.T) {
 	var (
 		env  = newEnv(t)
 		path = env.Scaffold("blog")
 	)
 
-	_, statErr := os.Stat(filepath.Join(path, "config.yml"))
-	require.False(t, os.IsNotExist(statErr), "config.yml cannot be found")
+	_, statErr := os.Stat(filepath.Join(path, "x", "blog"))
+	require.False(t, os.IsNotExist(statErr), "the default module should be scaffolded")
 
 	env.EnsureAppIsSteady(path)
 }
 
-func TestGenerateAnAppWithWasmAndVerify(t *testing.T) {
+func TestGenerateAnAppWithNoDefaultModule(t *testing.T) {
+	var (
+		env  = newEnv(t)
+		appName = "blog"
+	)
+
+	root := env.TmpDir()
+	env.Exec("scaffold an app",
+		step.NewSteps(step.New(
+			step.Exec(
+				"starport",
+				"app",
+				fmt.Sprintf("github.com/test/%s", appName),
+				"--no-default-module",
+			),
+			step.Workdir(root),
+		)),
+	)
+
+	// Cleanup the home directory of the app
+	env.t.Cleanup(func() {
+		os.RemoveAll(filepath.Join(env.Home(), fmt.Sprintf(".%s", appName)))
+	})
+
+	path := filepath.Join(root, appName)
+
+	_, statErr := os.Stat(filepath.Join(path, "x", "blog"))
+	require.True(t, os.IsNotExist(statErr), "the default module should not be scaffolded")
+
+	env.EnsureAppIsSteady(path)
+}
+
+
+func TestGenerateAnAppWithWasm(t *testing.T) {
 	var (
 		env  = newEnv(t)
 		path = env.Scaffold("blog")
@@ -47,7 +81,7 @@ func TestGenerateAnAppWithWasmAndVerify(t *testing.T) {
 	env.EnsureAppIsSteady(path)
 }
 
-func TestGenerateAStargateAppWithEmptyModuleAndVerify(t *testing.T) {
+func TestGenerateAStargateAppWithEmptyModule(t *testing.T) {
 	var (
 		env  = newEnv(t)
 		path = env.Scaffold("blog")

integration/env_test.go

@@ -199,6 +199,9 @@ func (e env) Serve(msg, path, home, configPath string, options ...execOption) (o
 // EnsureAppIsSteady ensures that app living at the path can compile and its tests
 // are passing.
 func (e env) EnsureAppIsSteady(appPath string) {
+	_, statErr := os.Stat(filepath.Join(appPath, "config.yml"))
+	require.False(e.t, os.IsNotExist(statErr), "config.yml cannot be found")
+
 	e.Exec("make sure app is steady",
 		step.NewSteps(step.New(
 			step.Exec(gocmd.Name(), "test", "./..."),

starport/cmd/app.go

@@ -9,6 +9,11 @@ import (
 	"github.com/tendermint/starport/starport/services/scaffolder"
 )
 
+const (
+	flagAddressPrefix   = "address-prefix"
+	flagNoDefaultModule = "no-default-module"
+)
+
 // NewApp creates new command named `app` to create Cosmos scaffolds customized
 // by the user given options.
 func NewApp() *cobra.Command {
@@ -19,7 +24,8 @@ func NewApp() *cobra.Command {
 		Args:  cobra.ExactArgs(1),
 		RunE:  appHandler,
 	}
-	c.Flags().String("address-prefix", "cosmos", "Address prefix")
+	c.Flags().String(flagAddressPrefix, "cosmos", "Address prefix")
+	c.Flags().Bool(flagNoDefaultModule, false, "Prevent scaffolding a default module in the app")
 	return c
 }
 
@@ -28,8 +34,9 @@ func appHandler(cmd *cobra.Command, args []string) error {
 	defer s.Stop()
 
 	var (
-		name             = args[0]
-		addressPrefix, _ = cmd.Flags().GetString("address-prefix")
+		name               = args[0]
+		addressPrefix, _   = cmd.Flags().GetString(flagAddressPrefix)
+		noDefaultModule, _ = cmd.Flags().GetBool(flagNoDefaultModule)
 	)
 
 	sc, err := scaffolder.New("",
@@ -39,7 +46,7 @@ func appHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	appdir, err := sc.Init(placeholder.New(), name)
+	appdir, err := sc.Init(placeholder.New(), name, noDefaultModule)
 	if err != nil {
 		return err
 	}

starport/services/scaffolder/init.go

@@ -28,7 +28,7 @@ var (
 
 // Init initializes a new app with name and given options.
 // path is the relative path to the scaffoled app.
-func (s *Scaffolder) Init(tracer *placeholder.Tracer, name string) (path string, err error) {
+func (s *Scaffolder) Init(tracer *placeholder.Tracer, name string, noDefaultModule bool) (path string, err error) {
 	pathInfo, err := gomodulepath.Parse(name)
 	if err != nil {
 		return "", err
@@ -40,7 +40,7 @@ func (s *Scaffolder) Init(tracer *placeholder.Tracer, name string) (path string,
 	absRoot := filepath.Join(pwd, pathInfo.Root)
 
 	// create the project
-	if err := s.generate(tracer, pathInfo, absRoot); err != nil {
+	if err := s.generate(tracer, pathInfo, absRoot, noDefaultModule); err != nil {
 		return "", err
 	}
 
@@ -56,7 +56,12 @@ func (s *Scaffolder) Init(tracer *placeholder.Tracer, name string) (path string,
 }
 
 //nolint:interfacer
-func (s *Scaffolder) generate(tracer *placeholder.Tracer, pathInfo gomodulepath.Path, absRoot string) error {
+func (s *Scaffolder) generate(
+	tracer *placeholder.Tracer,
+	pathInfo gomodulepath.Path,
+	absRoot string,
+	noDefaultModule bool,
+) error {
 	g, err := app.New(&app.Options{
 		// generate application template
 		ModulePath:       pathInfo.RawPath,
@@ -79,23 +84,26 @@ func (s *Scaffolder) generate(tracer *placeholder.Tracer, pathInfo gomodulepath.
 	}
 
 	// generate module template
-	opts := &modulecreate.CreateOptions{
-		ModuleName: pathInfo.Package, // App name
-		ModulePath: pathInfo.RawPath,
-		AppName:    pathInfo.Package,
-		OwnerName:  owner(pathInfo.RawPath),
-		IsIBC:      false,
-	}
-	g, err = modulecreate.NewStargate(opts)
-	if err != nil {
-		return err
-	}
-	if err := run(genny.WetRunner(context.Background()), g); err != nil {
-		return err
-	}
-	g = modulecreate.NewStargateAppModify(tracer, opts)
-	if err := run(genny.WetRunner(context.Background()), g); err != nil {
-		return err
+	if !noDefaultModule {
+		opts := &modulecreate.CreateOptions{
+			ModuleName: pathInfo.Package, // App name
+			ModulePath: pathInfo.RawPath,
+			AppName:    pathInfo.Package,
+			OwnerName:  owner(pathInfo.RawPath),
+			IsIBC:      false,
+		}
+		g, err = modulecreate.NewStargate(opts)
+		if err != nil {
+			return err
+		}
+		if err := run(genny.WetRunner(context.Background()), g); err != nil {
+			return err
+		}
+		g = modulecreate.NewStargateAppModify(tracer, opts)
+		if err := run(genny.WetRunner(context.Background()), g); err != nil {
+			return err
+		}
+
 	}
 
 	// generate the vue app.