enable js code generation for build & server

out dir can be configured via `build.proto.js.out`.

Author: ilgooz

starport/chainconf/config.go

@@ -36,8 +36,14 @@ var (
 					"third_party/proto",
 					"proto_vendor",
 				},
+				JS: ProtoJS{
+					Out: "vue/generated",
+				},
 			},
 		},
+		Frontend: Frontend{
+			Path: "vue",
+		},
 		Faucet: Faucet{
 			Port: 4500,
 		},
@@ -51,6 +57,7 @@ type Config struct {
 	Validator Validator              `yaml:"validator"`
 	Faucet    Faucet                 `yaml:"faucet"`
 	Build     Build                  `yaml:"build"`
+	Frontend  Frontend               `yaml:"frontend"`
 	Init      Init                   `yaml:"init"`
 	Genesis   map[string]interface{} `yaml:"genesis"`
 	Servers   Servers                `yaml:"servers"`
@@ -97,6 +104,21 @@ type Proto struct {
 	// ThirdPartyPath is the relative path of where the third party proto files are
 	// located that used by the app.
 	ThirdPartyPaths []string `yaml:"third_party_paths"`
+
+	// JS holds JavaScript code generation configs.
+	JS ProtoJS `yaml:"js"`
+}
+
+// ProtoJS holds JavaScript code generation configs.
+type ProtoJS struct {
+	// Out sets the destination path for generated JS code.
+	Out string
+}
+
+// Frontend holds front-end options.
+type Frontend struct {
+	// Path is the relative source code path of app's frontend.
+	Path string
 }
 
 // Faucet configuration.

starport/pkg/cosmosprotoc/cosmosprotoc.go

@@ -0,0 +1,168 @@
+package cosmosprotoc
+
+import (
+	"context"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+
+	"github.com/otiai10/copy"
+	"github.com/pkg/errors"
+	"github.com/tendermint/starport/starport/pkg/cmdrunner"
+	"github.com/tendermint/starport/starport/pkg/cmdrunner/step"
+	"github.com/tendermint/starport/starport/pkg/gomodule"
+	"github.com/tendermint/starport/starport/pkg/protobufjs"
+	"github.com/tendermint/starport/starport/pkg/protoc"
+	"github.com/tendermint/starport/starport/pkg/protopath"
+	"golang.org/x/mod/modfile"
+)
+
+var (
+	protocOuts = []string{
+		"--gocosmos_out=plugins=interfacetype+grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:.",
+		"--grpc-gateway_out=logtostderr=true:.",
+	}
+
+	sdkImport          = "github.com/cosmos/cosmos-sdk"
+	sdkProto           = "proto"
+	sdkProtoThirdParty = "third_party/proto"
+
+	jsGeneratedProtoPath = "proto"
+)
+
+type generateOptions struct {
+	goEnabled bool
+	gomodPath string
+	jsEnabled bool
+	jsOutPath string
+}
+
+// Target adds a new code generation target to Generate.
+type Target func(*generateOptions)
+
+// WithJSGeneration adds JS code generation.
+func WithJSGeneration(outPath string) Target {
+	return func(o *generateOptions) {
+		o.jsEnabled = true
+		o.jsOutPath = outPath
+	}
+}
+
+// WithGoGeneration adds Go code generation.
+func WithGoGeneration(gomodPath string) Target {
+	return func(o *generateOptions) {
+		o.goEnabled = true
+		o.gomodPath = gomodPath
+	}
+}
+
+// generator generates code for sdk and sdk apps.
+type generator struct {
+	ctx          context.Context
+	projectPath  string
+	protoPath    string
+	includePaths []string
+	o            *generateOptions
+	modfile      *modfile.File
+}
+
+// Generate generates code from proto app's proto files.
+// make sure that all paths are absolute.
+func Generate(
+	ctx context.Context,
+	projectPath,
+	protoPath string,
+	includePaths []string,
+	target Target,
+	otherTargets ...Target,
+) error {
+	g := &generator{
+		ctx:          ctx,
+		projectPath:  projectPath,
+		protoPath:    protoPath,
+		includePaths: includePaths,
+		o:            &generateOptions{},
+	}
+
+	for _, target := range append(otherTargets, target) {
+		target(g.o)
+	}
+
+	if err := g.setup(); err != nil {
+		return err
+	}
+
+	if g.o.jsEnabled {
+		if err := g.generateJS(); err != nil {
+			return err
+		}
+	}
+
+	if g.o.goEnabled {
+		if err := g.generateGo(); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (g *generator) setup() (err error) {
+	// Cosmos SDK hosts proto files of own x/ modules and some third party ones needed by itself and
+	// blockchain apps. Generate should be aware of these and make them available to the blockchain
+	// app that wants to generate code for its own proto.
+	//
+	// blockchain apps may use different versions of the SDK. following code first makes sure that
+	// app's dependencies are download by 'go mod' and cached under the local filesystem.
+	// and then, it determines which version of the SDK is used by the app and what is the absolute path
+	// of its source code.
+	if err := cmdrunner.
+		New(cmdrunner.DefaultWorkdir(g.projectPath)).
+		Run(g.ctx, step.New(step.Exec("go", "mod", "download"))); err != nil {
+		return err
+	}
+
+	// parse the go.mod of the app.
+	g.modfile, err = gomodule.ParseAt(g.projectPath)
+
+	return
+}
+
+func (g *generator) generateGo() error {
+	includePaths, err := g.resolveInclude(protopath.NewModule(sdkImport, sdkProto, sdkProtoThirdParty))
+	if err != nil {
+		return err
+	}
+
+	// created a temporary dir to locate generated code under which later only some of them will be moved to the
+	// app's source code. this also prevents having leftover files in the app's source code or its parent dir -when
+	// command executed directly there- in case of an interrupt.
+	tmp, err := ioutil.TempDir("", "")
+	if err != nil {
+		return err
+	}
+	defer os.RemoveAll(tmp)
+
+	if err := protoc.Generate(g.ctx, tmp, g.protoPath, append(g.includePaths, includePaths...), protocOuts); err != nil {
+		return err
+	}
+
+	// move generated code for the app under the relative locations in its source code.
+	generatedPath := filepath.Join(tmp, g.o.gomodPath)
+	err = copy.Copy(generatedPath, g.projectPath)
+	return errors.Wrap(err, "cannot copy path")
+}
+
+func (g *generator) generateJS() error {
+	includePaths, err := g.resolveInclude(protopath.NewModule(sdkImport, sdkProto))
+	if err != nil {
+		return err
+	}
+
+	outPath := filepath.Join(g.o.jsOutPath, jsGeneratedProtoPath)
+	return protobufjs.Generate(g.ctx, outPath, "types", g.protoPath, append(g.includePaths, includePaths...))
+}
+
+func (g *generator) resolveInclude(modules ...protopath.Module) (paths []string, err error) {
+	return protopath.ResolveDependencyPaths(g.modfile.Require, modules...)
+}

starport/pkg/cosmosprotoc/generate.go

@@ -0,0 +1,50 @@
+package cosmosprotoc
+
+import (
+	"bytes"
+	"context"
+
+	"github.com/pkg/errors"
+	"github.com/tendermint/starport/starport/pkg/cmdrunner"
+	"github.com/tendermint/starport/starport/pkg/cmdrunner/step"
+	"github.com/tendermint/starport/starport/pkg/xexec"
+)
+
+// ErrProtocNotInstalled is returned when protoc isn't installed on the system.
+var ErrProtocNotInstalled = errors.New("protoc is not installed")
+
+// InstallDependencies installs protoc dependencies needed by Cosmos ecosystem.
+func InstallDependencies(ctx context.Context, appPath string) error {
+	if !xexec.IsCommandAvailable("protoc") {
+		return ErrProtocNotInstalled
+	}
+
+	errb := &bytes.Buffer{}
+	err := cmdrunner.
+		New(
+			cmdrunner.DefaultStderr(errb),
+			cmdrunner.DefaultWorkdir(appPath),
+		).
+		Run(ctx,
+			// installs the gocosmos plugin with the version specified under the
+			// go.mod of the app.
+			step.New(
+				step.Exec(
+					"go",
+					"get",
+					"github.com/regen-network/cosmos-proto/protoc-gen-gocosmos@v0.3.1",
+				),
+			),
+			// install grpc-gateway.
+			step.New(
+				step.Exec(
+					"go",
+					"get",
+					"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway@v1.16.0",
+					"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger@v1.16.0",
+					"github.com/golang/protobuf/protoc-gen-go@v1.4.3",
+				),
+			),
+		)
+	return errors.Wrap(err, errb.String())
+}