Merge pull request kcl-lang#318 from officialasishkumar/kpm-add-rename

added rename flag in kpm add
zong-zhe · May 17, 2024 · dfb0080 · dfb0080
2 parents 83ebb23 + 5e4e2bd
commit dfb0080
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/pkg/client/client.go b/pkg/client/client.go
@@ -623,13 +623,17 @@ func (c *KpmClient) AddDepWithOpts(kclPkg *pkg.KclPkg, opt *opt.AddOptions) (*pk
 		fmt.Sprintf("adding dependency '%s'", d.Name),
 		c.logWriter,
 	)
+
 	// 2. download the dependency to the local path.
 	err = c.AddDepToPkg(kclPkg, d)
 	if err != nil {
 		return nil, err
 	}
 
 	// 3. update the kcl.mod and kcl.mod.lock.
+	if opt.NewPkgName != "" {
+		d.ChangePkgName(opt.NewPkgName)
+	}
 	err = kclPkg.UpdateModAndLockFile()
 	if err != nil {
 		return nil, err

diff --git a/pkg/cmd/cmd_add.go b/pkg/cmd/cmd_add.go
@@ -42,6 +42,10 @@ func NewAddCmd(kpmcli *client.KpmClient) *cli.Command {
 				Name:  FLAG_NO_SUM_CHECK,
 				Usage: "do not check the checksum of the package and update kcl.mod.lock",
 			},
+			&cli.StringFlag{
+				Name: "rename", 
+				Usage: "rename the package name in kcl.mod.lock",
+			},
 		},
 
 		Action: func(c *cli.Context) error {
@@ -131,6 +135,7 @@ func onlyOnceOption(c *cli.Context, name string) (string, *reporter.KpmEvent) {
 // parseAddOptions will parse the user cli inputs.
 func parseAddOptions(c *cli.Context, kpmcli *client.KpmClient, localPath string) (*opt.AddOptions, error) {
 	noSumCheck := c.Bool(FLAG_NO_SUM_CHECK)
+	newPkgName := c.String("rename")
 	// parse from 'kpm add -git https://xxx/xxx.git -tag v0.0.1'.
 	if c.NArg() == 0 {
 		gitOpts, err := parseGitRegistryOptions(c)
@@ -142,6 +147,7 @@ func parseAddOptions(c *cli.Context, kpmcli *client.KpmClient, localPath string)
 		}
 		return &opt.AddOptions{
 			LocalPath:    localPath,
+			NewPkgName:   newPkgName,
 			RegistryOpts: *gitOpts,
 			NoSumCheck:   noSumCheck,
 		}, nil
@@ -155,12 +161,14 @@ func parseAddOptions(c *cli.Context, kpmcli *client.KpmClient, localPath string)
 			}
 			return &opt.AddOptions{
 				LocalPath:    localPath,
+				NewPkgName:   newPkgName,
 				RegistryOpts: *ociReg,
 				NoSumCheck:   noSumCheck,
 			}, nil
 		} else {
 			return &opt.AddOptions{
 				LocalPath:    localPath,
+				NewPkgName:   newPkgName,
 				RegistryOpts: *localPkg,
 				NoSumCheck:   noSumCheck,
 			}, nil

diff --git a/pkg/opt/opt.go b/pkg/opt/opt.go
@@ -166,6 +166,7 @@ func (opts *InitOptions) Validate() error {
 
 type AddOptions struct {
 	LocalPath    string
+	NewPkgName   string
 	RegistryOpts RegistryOptions
 	NoSumCheck   bool
 }

diff --git a/pkg/package/modfile.go b/pkg/package/modfile.go
@@ -266,6 +266,10 @@ func (dep *Dependency) GetDownloadPath() string {
 	return ""
 }
 
+func (dep *Dependency) ChangePkgName(NewPkgName string) {
+	dep.Name = NewPkgName
+}
+
 func GenSource(sourceType string, uri string, tagName string) (Source, error) {
 	source := Source{}
 	if sourceType == GIT {