feat: add module keeper alias (#3683)

* feat: add module keeper alias * changelog * feedback Co-authored-by: Jerónimo Albi <[email protected]> --------- Co-authored-by: Jerónimo Albi <[email protected]> Co-authored-by: Danilo Pantani <[email protected]>
ignite · Oct 12, 2023 · 3c3b53d · 3c3b53d
1 parent 6c95328
commit 3c3b53d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/changelog.md b/changelog.md
@@ -11,15 +11,16 @@
 
 ### Changes
 
-- [#3581](https://github.com/ignite/cli/pull/3581) Bump cometbft and cometbft-db in the template
 - [#3559](https://github.com/ignite/cli/pull/3559) Bump network plugin version to `v0.1.1`
+- [#3581](https://github.com/ignite/cli/pull/3581) Bump cometbft and cometbft-db in the template
 - [#3522](https://github.com/ignite/cli/pull/3522) Remove indentation from `chain serve` output
 - [#3601](https://github.com/ignite/cli/pull/3601) Update ts-relayer version to `0.10.0`
 - [#3658](https://github.com/ignite/cli/pull/3658) Rename Marshaler to Codec in EncodingConfig
 - [#3653](https://github.com/ignite/cli/pull/3653) Add "app" extension to plugin binaries
 - [#3656](https://github.com/ignite/cli/pull/3656) Disable Go toolchain download
 - [#3662](https://github.com/ignite/cli/pull/3662) Refactor CLI "plugin" command to "app"
 - [#3669](https://github.com/ignite/cli/pull/3669) Rename `plugins` config file to `igniteapps`
+- [#3683](https://github.com/ignite/cli/pull/3683) Resolve `--dep auth` as `--dep account` in `scaffold module`
 
 ### Fixes
 
@@ -618,7 +619,7 @@ Our new name is **Ignite CLI**!
   automatically take care of building proto files without a need of script in the app's source code.
 - Integrated third-party proto-files used by Cosmos SDK modules into Ignite CLI
 - Added ability to customize binary name with `build.binary` in `config.yml`
-- Added ability to change path to home directory with ` .home` in `config.yml`
+- Added ability to change path to home directory with `.home` in `config.yml`
 - Added ability to add accounts by `address` with in `config.yml`
 - Added faucet functionality available on port 4500 and configurable with `faucet` in `config.yml`
 - Added `starport faucet [address] [coins]` command

diff --git a/ignite/cmd/scaffold_module.go b/ignite/cmd/scaffold_module.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"regexp"
+	"strings"
 
 	"github.com/spf13/cobra"
 
@@ -15,6 +16,11 @@ import (
 	modulecreate "github.com/ignite/cli/ignite/templates/module/create"
 )
 
+// moduleNameKeeperAlias is a map of well known module names that have a different keeper name than the usual <module-name>Keeper.
+var moduleNameKeeperAlias = map[string]string{
+	"auth": "account",
+}
+
 const (
 	flagDep                 = "dep"
 	flagIBC                 = "ibc"
@@ -170,6 +176,10 @@ func scaffoldModuleHandler(cmd *cobra.Command, args []string) error {
 				return fmt.Errorf("invalid module dependency name format '%s'", name)
 			}
 
+			if alias, ok := moduleNameKeeperAlias[strings.ToLower(name)]; ok {
+				name = alias
+			}
+
 			deps = append(deps, modulecreate.NewDependency(name))
 		}