fix: change vuex generation to use a default TS client path

changelog.md

@@ -4,6 +4,7 @@
 
 ### Fixes
 
+- Change vuex generation to use a default TS client path.
 - Fix cli action org in templates.
 - Seal the capability keeper in the `app.go` template
 

ignite/chainconfig/config.go

@@ -6,13 +6,20 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/goccy/go-yaml"
 	"github.com/imdario/mergo"
 
 	"github.com/ignite/cli/ignite/pkg/xfilepath"
 )
 
+const (
+	// DefaultTSClientPath defines the default relative path to use when generating the TS client.
+	// The path is relative to the app's directory.
+	DefaultTSClientPath = "ts-client"
+)
+
 var (
 	// ConfigDirPath returns the path of configuration directory of Ignite.
 	ConfigDirPath = xfilepath.JoinFromHome(xfilepath.Path(".ignite"))
@@ -253,7 +260,7 @@ func LocateDefault(root string) (path string, err error) {
 	return "", ErrCouldntLocateConfig
 }
 
-// FaucetHost returns the faucet host to use
+// FaucetHost returns the faucet host to use.
 func FaucetHost(conf Config) string {
 	// We keep supporting Port option for backward compatibility
 	// TODO: drop this option in the future
@@ -265,6 +272,16 @@ func FaucetHost(conf Config) string {
 	return host
 }
 
+// TSClientPath returns the relative path to the Typescript client directory.
+// Path is relative to the app's directory.
+func TSClientPath(conf Config) string {
+	if path := strings.TrimSpace(conf.Client.Typescript.Path); path != "" {
+		return filepath.Clean(path)
+	}
+
+	return DefaultTSClientPath
+}
+
 // CreateConfigDir creates config directory if it is not created yet.
 func CreateConfigDir() error {
 	confPath, err := ConfigDirPath()

ignite/cmd/generate_typescript_client.go

@@ -3,6 +3,7 @@ package ignitecmd
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/ignite/cli/ignite/chainconfig"
 	"github.com/ignite/cli/ignite/pkg/cliui"
 	"github.com/ignite/cli/ignite/services/chain"
 )
@@ -13,7 +14,10 @@ func NewGenerateTSClient() *cobra.Command {
 		Short: "Generate Typescript client for your chain's frontend",
 		RunE:  generateTSClientHandler,
 	}
+
 	c.Flags().AddFlagSet(flagSetProto3rdParty(""))
+	c.Flags().StringP(flagOutput, "o", chainconfig.DefaultTSClientPath, "typescript client output path")
+
 	return c
 }
 
@@ -33,7 +37,13 @@ func generateTSClientHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateTSClient()); err != nil {
+	output, err := cmd.Flags().GetString(flagOutput)
+	if err != nil {
+		return err
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateTSClient(output))
+	if err != nil {
 		return err
 	}
 

ignite/pkg/cosmosgen/generate_vuex.go

@@ -2,6 +2,7 @@ package cosmosgen
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -27,6 +28,9 @@ func (g *generator) updateVueDependencies() error {
 	// Init the path to the "vue" folder inside the app
 	vuePath := filepath.Join(g.appPath, "vue")
 	packagesPath := filepath.Join(vuePath, "package.json")
+	if _, err := os.Stat(packagesPath); errors.Is(err, os.ErrNotExist) {
+		return nil
+	}
 
 	// Read the Vue app package file
 	b, err := os.ReadFile(packagesPath)
@@ -40,23 +44,29 @@ func (g *generator) updateVueDependencies() error {
 		return fmt.Errorf("error parsing %s: %w", packagesPath, err)
 	}
 
-	// Add the link to the ts-client to the VUE app dependencies
 	chainPath, _, err := gomodulepath.Find(g.appPath)
 	if err != nil {
 		return err
 	}
 
+	// Make sure the TS client path is absolute
+	tsClientPath, err := filepath.Abs(g.o.tsClientRootPath)
+	if err != nil {
+		return fmt.Errorf("failed to read the absolute typescript client path: %w", err)
+	}
+
+	// Add the link to the ts-client to the VUE app dependencies
 	appModulePath := gomodulepath.ExtractAppPath(chainPath.RawPath)
 	tsClientNS := strings.ReplaceAll(appModulePath, "/", "-")
 	tsClientName := fmt.Sprintf("%s-client-ts", tsClientNS)
-	tsClientPath, err := filepath.Rel(vuePath, g.o.tsClientRootPath)
+	tsClientRelPath, err := filepath.Rel(vuePath, tsClientPath)
 	if err != nil {
 		return err
 	}
 
 	err = mergo.Merge(&pkg, map[string]interface{}{
 		"dependencies": map[string]interface{}{
-			tsClientName: fmt.Sprintf("file:%s", tsClientPath),
+			tsClientName: fmt.Sprintf("file:%s", tsClientRelPath),
 		},
 	})
 	if err != nil {

ignite/services/chain/generate.go

@@ -6,16 +6,16 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/ignite/cli/ignite/chainconfig"
 	"github.com/ignite/cli/ignite/pkg/cache"
 	"github.com/ignite/cli/ignite/pkg/cosmosanalysis/module"
 	"github.com/ignite/cli/ignite/pkg/cosmosgen"
 )
 
 const (
-	defaultTSClientPath = "ts-client"
-	defaultVuexPath     = "vue/src/store"
-	defaultDartPath     = "flutter/lib"
-	defaultOpenAPIPath  = "docs/static/openapi.yml"
+	defaultVuexPath    = "vue/src/store"
+	defaultDartPath    = "flutter/lib"
+	defaultOpenAPIPath = "docs/static/openapi.yml"
 )
 
 type generateOptions struct {
@@ -24,6 +24,7 @@ type generateOptions struct {
 	isVuexEnabled     bool
 	isDartEnabled     bool
 	isOpenAPIEnabled  bool
+	tsClientPath      string
 }
 
 // GenerateTarget is a target to generate code for from proto files.
@@ -37,9 +38,12 @@ func GenerateGo() GenerateTarget {
 }
 
 // GenerateTSClient enables generating proto based Typescript Client.
-func GenerateTSClient() GenerateTarget {
+// The path assigns the output path to use for the generated Typescript client
+// overriding the configured or default path. Path can be an empty string.
+func GenerateTSClient(path string) GenerateTarget {
 	return func(o *generateOptions) {
 		o.isTSClientEnabled = true
+		o.tsClientPath = path
 	}
 }
 
@@ -75,8 +79,8 @@ func (c *Chain) generateFromConfig(ctx context.Context, cacheStorage cache.Stora
 	var additionalTargets []GenerateTarget
 
 	// parse config for additional target
-	if conf.Client.Typescript.Path != "" {
-		additionalTargets = append(additionalTargets, GenerateTSClient())
+	if p := conf.Client.Typescript.Path; p != "" {
+		additionalTargets = append(additionalTargets, GenerateTSClient(p))
 	}
 
 	if conf.Client.Vuex.Path != "" {
@@ -130,20 +134,20 @@ func (c *Chain) Generate(
 
 	// generate Typescript Client code as well if it is enabled.
 	if targetOptions.isTSClientEnabled {
-		tsClientPath := conf.Client.Typescript.Path
+		tsClientPath := targetOptions.tsClientPath
 		if tsClientPath == "" {
-			tsClientPath = defaultTSClientPath
+			// TODO: Change to allow full paths in case TS client dir is not inside the app's dir?
+			tsClientPath = filepath.Join(c.app.Path, chainconfig.TSClientPath(conf))
 		}
 
-		tsClientRootPath := filepath.Join(c.app.Path, tsClientPath)
-		if err := os.MkdirAll(tsClientRootPath, 0o766); err != nil {
+		if err := os.MkdirAll(tsClientPath, 0o766); err != nil {
 			return err
 		}
 
 		options = append(options,
 			cosmosgen.WithTSClientGeneration(
-				cosmosgen.TypescriptModulePath(tsClientRootPath),
-				tsClientRootPath,
+				cosmosgen.TypescriptModulePath(tsClientPath),
+				tsClientPath,
 			),
 		)
 	}

ignite/services/scaffolder/scaffolder.go

@@ -98,9 +98,9 @@ func protoc(cacheStorage cache.Storage, projectPath, gomodPath string) error {
 		cosmosgen.IncludeDirs(conf.Build.Proto.ThirdPartyPaths),
 	}
 
-	// generate Typescript Client code as well if it is enabled.
-	if conf.Client.Typescript.Path != "" {
-		tsClientRootPath := filepath.Join(projectPath, conf.Client.Typescript.Path)
+	// generate Typescript Client code as well if it is enabled or when the vuex store is being generated
+	if conf.Client.Typescript.Path != "" || conf.Client.Vuex.Path != "" {
+		tsClientRootPath := filepath.Join(projectPath, chainconfig.TSClientPath(conf))
 		if err := os.MkdirAll(tsClientRootPath, 0o766); err != nil {
 			return err
 		}