8000 fix: use snake case for generated filenames by lumtis · Pull Request #1251 · ignite/cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: use snake case for generated filenames #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 17, 2021
Merged

fix: use snake case for generated filenames #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
18e60dc
Snake case
lumtis Jun 16, 2021
8dc9169
Rename files
lumtis Jun 16, 2021
c2ca622
Lint
lumtis Jun 16, 2021
1e1935b
Fix proto import
lumtis Jun 16, 2021
d35fef9
Changelog
lumtis Jun 16, 2021
File filter

Filter by extension

Filter by extension
8000
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
- Added the flag `--no-default-module` to the command `starport app` to prevent scaffolding a default module when creating a new app
- Added support for multiple naming conventions for component names and field names

### Fixes:

- Use snake case for generated files

## `v0.16.1`

### Features:
Expand Down
2 changes: 2 additions & 0 deletions starport/pkg/multiformatname/multiformatname.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ type Name struct {
LowerCamel string
UpperCamel string
Kebab string
Snake string
}

// NewMultiFormatName returns a new multi-format name from a name
Expand All @@ -28,6 +29,7 @@ func NewName(name string) (Name, error) {
LowerCamel: strcase.ToLowerCamel(name),
UpperCamel: strcase.ToCamel(name),
Kebab: strcase.ToKebab(name),
Snake: strcase.ToSnake(name),
}, nil
}

Expand Down
26 changes: 16 additions & 10 deletions starport/pkg/multiformatname/multiformatname_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ import (

func TestNewMultiFormatName(t *testing.T) {
// [valueToTest, lowerCamel, upperCamel, kebabCase]
cases := [][4]string{
{"foo", "foo", "Foo", "foo"},
{"fooBar", "fooBar", "FooBar", "foo-bar"},
{"foo-bar", "fooBar", "FooBar", "foo-bar"},
{"foo_bar", "fooBar", "FooBar", "foo-bar"},
{"foo_barFoobar", "fooBarFoobar", "FooBarFoobar", "foo-bar-foobar"},
{"foo_-_bar", "fooBar", "FooBar", "foo---bar"},
{"foo_-_Bar", "fooBar", "FooBar", "foo---bar"},
{"fooBAR", "fooBAR", "FooBAR", "foo-bar"},
{"fooBar123", "fooBar123", "FooBar123", "foo-bar-123"},
cases := [][5]string{
{"foo", "foo", "Foo", "foo", "foo"},
{"fooBar", "fooBar", "FooBar", "foo-bar", "foo_bar"},
{"foo-bar", "fooBar", "FooBar", "foo-bar", "foo_bar"},
{"foo_bar", "fooBar", "FooBar", "foo-bar", "foo_bar"},
{"foo_barFoobar", "fooBarFoobar", "FooBarFoobar", "foo-bar-foobar", "foo_bar_foobar"},
{"foo_-_bar", "fooBar", "FooBar", "foo---bar", "foo___bar"},
{"foo_-_Bar", "fooBar", "FooBar", "foo---bar", "foo___bar"},
{"fooBAR", "fooBAR", "FooBAR", "foo-bar", "foo_bar"},
{"fooBar123", "fooBar123", "FooBar123", "foo-bar-123", "foo_bar_123"},
}

// test cases
Expand Down Expand Up @@ -48,6 +48,12 @@ func TestNewMultiFormatName(t *testing.T) {
name.Kebab,
fmt.Sprintf("%s should be converted the correct kebab format", testCase[0]),
)
require.Equal(
t,
testCase[4],
name.Snake,
fmt.Sprintf("%s should be converted the correct snake format", testCase[0]),
)
}
}

Expand Down
2 changes: 1 addition & 1 deletion starport/templates/ibc/packet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func NewPacket(replacer placeholder.Replacer, opts *PacketOptions) (*genny.Gener

g.Transformer(plushgen.Transformer(ctx))
g.Transformer(genny.Replace("{{moduleName}}", opts.ModuleName))
g.Transformer(genny.Replace("{{packetName}}", opts.PacketName.LowerCamel))
g.Transformer(genny.Replace("{{packetName}}", opts.PacketName.Snake))
return g, nil
}

Expand Down
3 changes: 1 addition & 2 deletions starport/templates/message/message.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ func Box(box packd.Walker, opts *Options, g *genny.Generator) error {
ctx.Set("title", strings.Title)
g.Transformer(plushgen.Transformer(ctx))
g.Transformer(genny.Replace("{{moduleName}}", opts.ModuleName))
g.Transformer(genny.Replace("{{msgName}}", opts.MsgName.LowerCamel))
g.Transformer(genny.Replace("{{MsgName}}", opts.MsgName.UpperCamel))
g.Transformer(genny.Replace("{{msgName}}", opts.MsgName.Snake))
return nil
}
0 ...eName}}/client/cli/tx{{MsgName}}.go.plush → ...Name}}/client/cli/tx_{{msgName}}.go.plush
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion starport/templates/query/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ func Box(box packd.Walker, opts *Options, g *genny.Generator) error {
ctx.Set("title", strings.Title)
g.Transformer(plushgen.Transformer(ctx))
g.Transformer(genny.Replace("{{moduleName}}", opts.ModuleName))
g.Transformer(genny.Replace("{{queryName}}", opts.QueryName.LowerCamel))
g.Transformer(genny.Replace("{{queryName}}", opts.QueryName.Snake))
return nil
}
2 changes: 1 addition & 1 deletion starport/templates/typed/genesis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import "%[2]v/%[3]v.proto";`
templateProtoImport,
PlaceholderGenesisProtoImport,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), PlaceholderGenesisProtoImport, replacementProtoImport)

Expand Down
6 changes: 3 additions & 3 deletions starport/templates/typed/indexed/stargate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ func protoRPCModify(replacer placeholder.Replacer, opts *typed.Options) genny.Ru
import "%s/%s.proto";`
replacementImport := fmt.Sprintf(templateImport, typed.Placeholder,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), typed.Placeholder, replacementImport)

Expand Down Expand Up @@ -190,7 +190,7 @@ import "%[2]v/%[3]v.proto";`
templateProtoImport,
typed.PlaceholderGenesisProtoImport,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), typed.PlaceholderGenesisProtoImport, replacementProtoImport)

Expand Down Expand Up @@ -316,7 +316,7 @@ func protoTxModify(replacer placeholder.Replacer, opts *typed.Options) genny.Run
import "%s/%s.proto";`
replacementImport := fmt.Sprintf(templateImport, typed.PlaceholderProtoTxImport,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), typed.PlaceholderProtoTxImport, replacementImport)

Expand Down
0 ...e}}/client/cli/query{{TypeName}}.go.plush → ...}}/client/cli/query_{{typeName}}.go.plush
View file
Open in desktop
File renamed without changes.
0 ...client/cli/query{{TypeName}_test.go.plush → ...ient/cli/query_{{typeName}}_test.go.plush
View file
Open in desktop
File renamed without changes.
0 ...Name}}/client/cli/tx{{TypeName}}.go.plush → ...ame}}/client/cli/tx_{{typeName}}.go.plush
View file
Open in desktop
File renamed without changes.
0 ...}/client/cli/tx{{TypeName}}_test.go.plush → .../client/cli/tx_{{typeName}}_test.go.plush
View file
10000 Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions starport/templates/typed/stargate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ func (t *typedStargate) protoTxModify(replacer placeholder.Replacer, opts *Optio
import "%s/%s.proto";`
replacementImport := fmt.Sprintf(templateImport, PlaceholderProtoTxImport,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), PlaceholderProtoTxImport, replacementImport)

Expand Down Expand Up @@ -162,7 +162,7 @@ func (t *typedStargate) protoQueryModify(replacer placeholder.Replacer, opts *Op
import "%s/%s.proto";`
replacementImport := fmt.Sprintf(templateImport, Placeholder,
opts.ModuleName,
opts.TypeName.LowerCamel,
opts.TypeName.Snake,
)
content := replacer.Replace(f.String(), Placeholder, replacementImport)

Expand Down
0 ...e}}/client/cli/query{{TypeName}}.go.plush → ...}}/client/cli/query_{{typeName}}.go.plush
View file
Open in desktop
File renamed without changes.
0 ...lient/cli/query{{TypeName}}_test.go.plush → ...ient/cli/query_{{typeName}}_test.go.plush
View file
Open in desktop
File renamed without changes.
0 ...Name}}/client/cli/tx{{TypeName}}.go.plush → ...ame}}/client/cli/tx_{{typeName}}.go.plush
View file
Open in desktop
File renamed without changes.
0 ...}/client/cli/tx{{TypeName}}_test.go.plush → .../client/cli/tx_{{typeName}}_test.go.plush
View file
Open in desktop
File renamed without changes.
3 changes: 1 addition & 2 deletions starport/templates/typed/typed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ func Box(box packd.Walker, opts *Options, g *genny.Generator) error {

g.Transformer(plushgen.Transformer(ctx))
g.Transformer(genny.Replace("{{moduleName}}", opts.ModuleName))
g.Transformer(genny.Replace("{{typeName}}", opts.TypeName.LowerCamel))
g.Transformer(genny.Replace("{{TypeName}}", opts.TypeName.UpperCamel))
g.Transformer(genny.Replace("{{typeName}}", opts.TypeName.Snake))
return nil
}
0