Skip to content
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.

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

Renaming Funtion names #50

Open
kRHYME7 opened this issue May 6, 2024 · 7 comments
Open

Renaming Funtion names #50

kRHYME7 opened this issue May 6, 2024 · 7 comments
Labels
help wanted Extra attention is needed

Comments

@kRHYME7
Copy link
Collaborator

kRHYME7 commented May 6, 2024

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 kRHYME7 added the help wanted Extra attention is needed label May 6, 2024
@rubiin
Copy link
Contributor

rubiin commented May 6, 2024

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

@kRHYME7
Copy link
Collaborator Author

kRHYME7 commented May 6, 2024

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

@saharshbhansali
Copy link

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

@kRHYME7
Copy link
Collaborator Author

kRHYME7 commented May 21, 2024

@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.

@saharshbhansali
Copy link

saharshbhansali commented May 22, 2024

@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.

@YuvanMichaelVivenzi
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants