The highest tagged major version is v29.

cosmosgen

package

v0.25.0 Latest Latest Go to latest Published: Oct 20, 2022 License: Apache-2.0 Imports: 36 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ignite/cli

Links

Open Source Insights

Documentation ¶

Index ¶

func DepTools() []string
func Generate(ctx context.Context, cacheStorage cache.Storage, appPath, protoDir string, ...) error
func InstallDepTools(ctx context.Context, appPath string) error
type ModulePathFunc
- func TypescriptModulePath(rootPath string) ModulePathFunc
type ModulesInPath
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DepTools ¶ added in v0.25.0

func DepTools() []string

func Generate ¶

func Generate(ctx context.Context, cacheStorage cache.Storage, appPath, protoDir string, options ...Option) error

Generate generates code from protoDir of an SDK app residing at appPath with given options. protoDir must be relative to the projectPath.

func InstallDepTools ¶ added in v0.25.0

func InstallDepTools(ctx context.Context, appPath string) error

InstallDepTools installs protoc dependencies needed by Cosmos ecosystem.

Types ¶

type ModulePathFunc ¶

type ModulePathFunc func(module.Module) string

ModulePathFunc defines a function type that returns a path based on a Cosmos SDK module.

func TypescriptModulePath ¶ added in v0.24.0

func TypescriptModulePath(rootPath string) ModulePathFunc

TypescriptModulePath generates module paths for Cosmos SDK modules. The root path is used as prefix for the generated paths.

type ModulesInPath ¶

type ModulesInPath struct {
	Path    string
	Modules []module.Module
}

type Option ¶

type Option func(*generateOptions)

Option configures code generation.

func IncludeDirs ¶

func IncludeDirs(dirs []string) Option

IncludeDirs configures the third party proto dirs that used by app's proto. relative to the projectPath.

func WithDartGeneration ¶

func WithDartGeneration(includeThirdPartyModules bool, out ModulePathFunc, rootPath string) Option

func WithGoGeneration ¶

func WithGoGeneration(gomodPath string) Option

WithGoGeneration adds Go code generation.

func WithOpenAPIGeneration ¶

func WithOpenAPIGeneration(out string) Option

WithOpenAPIGeneration adds OpenAPI spec generation.

func WithTSClientGeneration ¶ added in v0.24.0

func WithTSClientGeneration(out ModulePathFunc, tsClientRootPath string) Option

WithTSClientGeneration adds Typescript Client code generation. The tsClientRootPath is used to determine the root path of generated Typescript classes.

func WithVuexGeneration ¶

func WithVuexGeneration(includeThirdPartyModules bool, out ModulePathFunc, vuexRootPath string) Option

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL