refactor: Rename projeoct from 'dotty' to 'dotfox'

Author: hyperupcall

.gitignore

@@ -1,3 +1,3 @@
 dist/
-dotty
+dotfox
 nimbledeps/

README.md

@@ -1,4 +1,4 @@
-# Dotty
+# DotFox
 
 🌎 Simple dotfile manager
 

completions/dotty.sh

@@ -1,7 +1,7 @@
 # shellcheck shell=bash
 
 # based on https://tylerthrailkill.com/2019-01-19/writing-bash-completion-script-with-subcommands/
-_dotty() {
+_dotfox() {
 	local i=1 cmd
 
 	# iterate over COMP_WORDS (ending at currently completed word)
@@ -20,22 +20,22 @@ _dotty() {
 		(( i++ ))
 	done
 
-	# check if we're completing 'dotty'
+	# check if we're completing 'dotfox'
 	if [[ "$i" -eq "$COMP_CWORD" ]]; then
 		local cur="${COMP_WORDS[COMP_CWORD]}"
 		# shellcheck disable=SC2207
-		COMPREPLY=($(compgen -W "status reconcile rootStatus rootReconcile --version --help" -- "$cur"))
+		COMPREPLY=($(compgen -W "status deploy rootStatus rootDeploy --version --help" -- "$cur"))
 		return
 	fi
 
-	# if we're not completing 'dotty', then we're completing a subcommand
+	# if we're not completing 'dotfox', then we're completing a subcommand
 	case "$cmd" in
 		status)
 			COMPREPLY=() ;;
-		reconcile)
+		deploy)
 			COMPREPLY=() ;;
 		*)
 			;;
 	esac
 
-} && complete -F _dotty dotty
+} && complete -F _dotfox dotfox

docs/getting-started.md

@@ -2,17 +2,17 @@
 
 TODO (THIS IS OUT OF DATE)
 
-When setting up Dotty, you need two things: a dot directory (`dotDir`) and a destination directory (`destDir`). `dotDir` is a directory that your dotfiles tracked with your VCS of choice, such as `~/.dotfiles`. `destDir` is the location to deploy your dotfiles to, such as `~/`.
+When setting up DotFox, you need two things: a dot directory (`dotDir`) and a destination directory (`destDir`). `dotDir` is a directory that your dotfiles tracked with your VCS of choice, such as `~/.dotfiles`. `destDir` is the location to deploy your dotfiles to, such as `~/`.
 
-Specify these two things in `~/.config/dotty/config.toml` (or with using the config directory of your choice with `XDG_CONFIG_HOME`)
+Specify these two things in `~/.config/dotfox/config.toml` (or with using the config directory of your choice with `XDG_CONFIG_HOME`)
 
 ```toml
 [config]
 dotDir = "~/.dotfiles"
 destDir = "~"
 ```
 
-Now, specify the dotfiles you wish to automatically deploy. These dotfiles will have symlinks created in the `destDir`, pointing to their respective file or directory in `dotDir`. Specify the dotfiles using a shell script located at `~/.config/dotty/deployments/default.sh`
+Now, specify the dotfiles you wish to automatically deploy. These dotfiles will have symlinks created in the `destDir`, pointing to their respective file or directory in `dotDir`. Specify the dotfiles using a shell script located at `~/.config/dotfox/deployments/default.sh`
 
 ```bash
 #!/usr/bin/env bash
@@ -31,7 +31,7 @@ for dotfile in "${dotfiles[@]}"; do
 done
 ```
 
-Dotty will execute this script, and use every line of standad output as a separate dotfile to track. Standard output would look like the following in this case
+DotFox will execute this script, and use every line of standad output as a separate dotfile to track. Standard output would look like the following in this case
 
 ```txt
 /home/edwin/.bashrc
@@ -40,10 +40,10 @@ Dotty will execute this script, and use every line of standad output as a separa
 
 Note that with every line, there is always a prefix of the `destDir` (`/home/edwin` i.e. `~/`)
 
-Now, let's try running Dotty
+Now, let's try running DotFox
 
 ```sh
-$ dotty status
+$ dotfox status
 [ERR_NULL_NULL] /home/edwin/.bashrc
                 -> (not fixable)
                 -> Is there a file or directory at /home/edwin/.dotfiles/.bashrc?
@@ -63,7 +63,7 @@ echo 'clear' > ~/.dotfiles/.bash_logout
 Now, let's try running again
 
 ```sh
-$ dotty status
+$ dotfox status
 [ERR_NULL_FILE] /home/edwin/.bashrc
                 -> (fixable)
 [ERR_NULL_FILE] /home/edwin/.bash_logout
@@ -73,12 +73,12 @@ Done.
 
 As you can see, the `ERR_NULL_NULL` status codes changed to `ERR_NULL_FILE`. The last `NULL` changed to a file because we placed the correct files in the `dotDir` (destination directory)
 
-Now that the dotfiles are automatically fixable, let's run `dotty reconcile`
+Now that the dotfiles are automatically fixable, let's run `dotfox deploy`
 
 ```sh
-$ dotty reconcile
+$ dotfox deploy
 Done.
-$ dotty status
+$ dotfox status
 [OK]            /home/edwin/.bashrc
 [OK]            /home/edwin/.bash_logout
 Done.

docs/installation.md

@@ -3,10 +3,10 @@
 ## From Source
 
 ```sh
-git clone https://github.com/eankeen/dotty
-cd ./dotty
+git clone https://github.com/eankeen/dotfox
+cd ./dotfox
 nimble build
-./dotty --help
+./dotfox --help
 ```
 
-## From Distribution
+## From Distribution

docs/reference.md

@@ -18,11 +18,11 @@ The symlink correctly points to the target file or directory
 
 #### `OK/`
 
-The symlink correctly points to the target file or directory, with the caveat that the target name has an extraneous suffix slash. On `dotty reconcile`, this will automatically be normalized
+The symlink correctly points to the target file or directory, with the caveat that the target name has an extraneous suffix slash. On `dotfox deploy`, this will automatically be normalized
 
 #### `ERR`
 
-A conflict exists. Dotty will attempt to automatically fix the problem. However, if dotty is unable to, you will need to fix it yourself
+A conflict exists. DotFox will attempt to automatically fix the problem. However, if dotfox is unable to, you will need to fix it yourself
 
 ### `destDirCode`
 
@@ -34,15 +34,15 @@ The particular dotfile has a corresponding symlink in the destination directory
 
 #### `FILE`
 
-The particular dotfile has a corresponding file in the destination directory. Dotty will try to automatically replace this with a symlink pointing to said target dotfile on reconcile
+The particular dotfile has a corresponding file in the destination directory. DotFox will try to automatically replace this with a symlink pointing to said target dotfile on deploy
 
 #### `DIR`
 
-The particular dotfile has a corresponding directory in the destination directory. Dotty will try to automatically replace this with a symlink pointing to said target dotfile on reconcile
+The particular dotfile has a corresponding directory in the destination directory. DotFox will try to automatically replace this with a symlink pointing to said target dotfile on deploy
 
 #### `NULL`
 
-The particular dotfile has no corresponding file or directory in the destination directory. Dotty will try to automatically replace this with a symlink pointing to said target dotfile on reconcile
+The particular dotfile has no corresponding file or directory in the destination directory. DotFox will try to automatically replace this with a symlink pointing to said target dotfile on deploy
 
 ### `dotDirCode`
 

docs/troubleshooting.md

@@ -0,0 +1,5 @@
+# Troubleshooting
+
+### 1. Deploy doesn't seem to do anything
+
+It is possible that your Bash script tells dotfox to do multiple things to the same file / underlying symlink

dotty.nimble

@@ -5,7 +5,7 @@ author        = "Edwin Kofler"
 description   = "Dotfile Manager"
 license       = "Apache-2.0"
 srcDir        = "src"
-bin           = @["dotty"]
+bin           = @["dotfox"]
 
 # Dependencies
 

src/do.nim

@@ -27,8 +27,8 @@ proc doAbstract(
   runNullNull: proc(dotfile: string, srcFile: string)
 ) =
   for i, files in dotfiles:
-    let srcFile = files[0]
-    let destFile = files[1]
+    let srcFile = rts(files[0])
+    let destFile = rts(files[1])
 
     try:
       createDir(parentDir(destFile))
@@ -73,7 +73,9 @@ proc doAbstract(
 
 proc doStatus*(dotDir: string, homeDir: string, options: Options, dotfiles: seq[array[2, string]]) =
   proc runSymlinkSymlink(file: string, srcFile: string, options: Options): void =
-    # This is possible if dotty does it's thing correctly, but
+    # TODO: check if the symlink points to a valid target
+
+    # This is possible if dotfox does it's thing correctly, but
     # the user replaces the file/directory in dotDir with a symlink
     # to something else. It is an error, even if the symlink resolves
     # properly, and it should not be possible in normal circumstances
@@ -90,8 +92,7 @@ proc doStatus*(dotDir: string, homeDir: string, options: Options, dotfiles: seq[
           printStatus("OK", file)
     else:
       printStatus("ERR_SYM_FILE", file)
-      # Possibly fixable, see reasoning in runSymlinkDir()
-      printHint("(possibly fixable)")
+      printHint("(fixable)")
 
   proc runSymlinkDir(file: string, srcFile: string, options: Options): void =
     if symlinkResolvedProperly(file, srcFile):
@@ -103,6 +104,7 @@ proc doStatus*(dotDir: string, homeDir: string, options: Options, dotfiles: seq[
           printStatus("OK", file)
     else:
       printStatus("ERR_SYM_DIR", file)
+      printHint("(fixable)")
 
   proc runSymlinkNull(file: string, srcFile: string): void =
     printStatus("ERR_SYM_NULL", file)
@@ -177,7 +179,7 @@ proc doStatus*(dotDir: string, homeDir: string, options: Options, dotfiles: seq[
     runNullNull
   )
 
-proc doReconcile*(dotDir: string, homeDir: string, options: Options,
+proc doDeploy*(dotDir: string, homeDir: string, options: Options,
     dotfiles: seq[array[2, string]]) =
   proc runSymlinkSymlink(file: string, srcFile: string, options: Options): void =
     discard # not fixable
@@ -190,6 +192,9 @@ proc doReconcile*(dotDir: string, homeDir: string, options: Options,
         let temp = expandSymlink(file)
         removeFile(file)
         createSymlink(rts(temp), file)
+    else:
+      removeFile(file)
+      createSymlink(srcFile, file)
 
   proc runSymlinkDir(file: string, srcFile: string, options: Options) =
     if symlinkResolvedProperly(file, srcFile):
@@ -198,6 +203,9 @@ proc doReconcile*(dotDir: string, homeDir: string, options: Options,
         let temp = expandSymlink(file)
         removeFile(file)
         createSymlink(rts(temp), file)
+    else:
+      removeFile(file)
+      createSymlink(srcFile, file)
 
   proc runSymlinkNull(file: string, srcFile: string) =
     discard # not fixable

src/dotty.nim

@@ -36,7 +36,7 @@ for kind, key, val in p.getopt():
 
 
 if options.configDir == "":
-  options.configDir = joinPath(getConfigDir(), "dotty")
+  options.configDir = joinPath(getConfigDir(), "dotfox")
 
 if not isAbsolute(options.configDir):
   die fmt"Directory '{options.configDir}' is not an absolute path"
@@ -66,8 +66,8 @@ if options.action == "":
 case options.action:
 of "status":
   doStatus(dotDir, homeDir, options, getDotfileList(options))
-of "reconcile":
-  doReconcile(dotDir, homeDir, options, getDotfileList(options))
+of "deploy":
+  doDeploy(dotDir, homeDir, options, getDotfileList(options))
 of "debug":
   doDebug(dotDir, homeDir, options, getDotfileList(options))
 else: