jh3y/kody

.files and environment configuration manager created with node

kody's Issues

Add common tasks to examples folder

Issue summary

Decrease the barrier for entry to use by having a folder of common example tasks;

• Installing homebrew
• Installing global node modules
• etc.

After reading the README back, it doesn't feel instantly easy to pick up and use, maybe show an example task within the README showing how easy it is to create a task for kody to pick up.

Also, link to personal set ups. For example; github.com/jh3y/kody_env has my personal tasks for doing various things like running shell scripts etc.

There is potential to raise awareness of kody and make it a go to solution for maintaining dotfiles. It has been picked up and shown on different blogging platforms but I still feel the barrier to entry may be holding it back.

Expected behavior

User should feel at ease to give kody a spin and not think about passing it up because it's too much overhead to get started.

Actual behavior

It's not super intuitive or doesn't come across as something that can be just picked up quick without major knowledge.

Steps to reproduce

Read the README as if you've never heard of kody or .files.

Resolution

Improve the README so that kody is easier to pick up and get going. Add examples into the repo so potential users can see how easy it is to get started with kody.

If no tasks selected or available, strange logs

Issue summary

For example, if I don't select a task and then press enter, kody will log that it ran a "generic task"

Expected behavior

Just tell me that no tasks were ran

Actual behavior

Get strange logs 😢

Steps to reproduce

Run kody and select no tasks

Don't prepend dotfiles with "."

Issue summary

When a user sets up their kody_env they should prepend their dotfiles files with .. Else it's counterintuitive to know that kody will prepend the . for you.

Expected behavior

Don't prepend .. Just symlink to $HOME.

Add atom package manager installs task

From kody.json allow user to define the atom packages to install so that it works out of the box like it did on their other machine.

Will simply have to check that which apm is not null.

@jh3y

Unhandled Promise rejection Error

Issue summary

Noticed when firing one of the tasks on my own kody_envfor installing apm packages.

More info on this error here. From what I can tell, the task is still successfully carried out but we just get the error noise in addition at the end.

I think the solution is to make processTask within processTasks potentially return a promise so that a rejection error can be handled.

Expected behavior

Runs with no errors or noise.

Actual behavior

We get noise 😢

Steps to reproduce

Personally, I ran the install apm package installer task from https://github.com/jh3y/kody_env.

@jh3y

write backup options into symlinking task.

Possibly, give the option of having a backup option for current config files in place before symlinking.

@jh3y

Task ordering not respected

Issue summary

Task ordering not respected by order key in .kodyrc.

Expected behavior

Tasks should be displayed by kody in order.

Actual behavior

Tasks just get displayed in file order.

Steps to reproduce

Just run kody with multiple tasks and pass the order key to define an order different to what you get by default.

Better error handling for invalid JSON

Issue summary

If I have invalid JSON, kody tells me it can't find any tasks but doesn't inform me that my .kodyrc file is invalid 🤦

Expected behavior

More descriptive error handling where I'm told that the JSON is invalid

Actual behavior

Fails telling me there's an issue with .kodyrc which makes me question whether my node version is compatible etc.

Steps to reproduce

Create an invalid JSON file with say a missing comma as the .kodyrc file

If .files directory in place, kody will throw error

Issue summary

If you set up a new machine using kody. Unless the .files task is set first(?) an error will be thrown about not being able to unlink the current existing directory.

Expected behavior

No errors are thrown and the symlink for the directory is set

Actual behavior

Error thrown because an existing directory is in place.

Current work-around

Manually rm -rf the directory within the $HOME directory before running the Dotfiles task.

Steps to reproduce

Try setting up a fresh machine using kody.