Hyde-cli icon indicating copy to clipboard operation
Hyde-cli copied to clipboard

Renaming Funtion names

Open kRHYME7 opened this issue 1 year ago • 7 comments

Hi to anyone that might be using the CLI, I needed your suggestions on naming the funtions.

change restore => deploy

I will start with Hyde restore [args]. Would it be fine if we use the term deploy? The reason for calling it restore is to restore Configs to the local $HOME. This term is meaningful if you fork the repo or owner of the repo. New users don't find the meaning to this and thinks that there configs will be restored back LOL.

Is deploy Fine?

kRHYME7 avatar May 06 '24 17:05 kRHYME7

I think for now, restore would be logical but we can change this later. restores looks meaningful with backup . Also the restore options,

<RESTORE_OPERATIONS> ::= Config       "Only restores dots from default"
                       | Clone        "Restores dots from a clone repository"
                       | BackUp       "Restores dots from previous backup"
                       | Link         "Links a clone directory. Useful if you want to change your CloneDir"

wont make much sense with deploy I guess

rubiin avatar May 06 '24 17:05 rubiin

I'm not bothered with restore though. However, I will leave this topic open for a while. Needed some suggestions on other functions too. GN

kRHYME7 avatar May 06 '24 18:05 kRHYME7

How about something like apply? It clearly indicates that you want to apply configs from whichever source you specify.

saharshbhansali avatar May 13 '24 21:05 saharshbhansali

@saharshbhansali but apply is sounding more specific to something than the config.

Look, this is the list of available functions. IMO, apply is not too specific for restoring the dotfiles. image

Will wait for other's opinion regarding this things. Or will make a poll in DC.

kRHYME7 avatar May 21 '24 12:05 kRHYME7

@kRHYME7 Yeah. That makes sense.

How about just configure, then?

That's the most direct way.

And the description can be updated to apply the configuration from the files in [FILEPATH] or something like that.

And then add flags/subcommands for the other features, like backup and the like.

saharshbhansali avatar May 22 '24 04:05 saharshbhansali

Actually I think deploy is good. As you're taking the dotfiles from a directory and then "deploying" to dotconfig. The meaning of deploy itself looks to suit this pretty good I guess/ That's just my thought. And yeah, apply looks too specific for this

YuvanMichaelVivenzi avatar Oct 13 '24 11:10 YuvanMichaelVivenzi

Restore does feel like restoring original dotfiles lol. I guess you should look at the meaning of the word itself and decide.

YuvanMichaelVivenzi avatar Oct 13 '24 11:10 YuvanMichaelVivenzi