Use dotfile for cilicon.yml config
torarnv opened this issue · comments
Placing a cilicon.yml in the home directory is unconventional for macOS. A more common approach is .cilicon.yml. Or use NSUserDefaults, which reads from ~/Library/Preferences
Thanks for raising the issue. In our first prototype the yml file was acutally a (hidden) dotfile. I found that having it in an easily accessible location (the users' home) and not hidden made provisioning (copying the file via screen sharing in many cases) and maintenance a lot easier. I believe that convenience wins over conventionalism here, but am open for any other arguments.
I understand it's less discoverable, but I'd argue people who are able to configure a CI like this are able (and used to) editing dotfiles in their home directory :) The app is otherwise well integrated with macOS, which is great, so since the norm on macOS is not to dump random directories or files into the home directory I'd prefer it be moved back. Perhaps there could be a "Preferences" menu entry in the UI that opens the file for discoverability? Alternatively, look it up as both a dotfile or a plain file, so it can be renamed for those who want to keep their homes clean? :)
I concur with having a hidden file. At least giving it a fallback option to either one or the other is a good solution.
How about making the path customizable? The app could prompt the user for a path if the config file is not found in the default location. This could be added to the fallback view where currently the default config can be created.
I would prefer not to add unnecessary complexity (UI etc.) for this. Let's have Cilicon look for either cilicon.yml or .cilicon.yml if it can't find the former.
Sound like a very simple and also flexible fix. Thanks!