Tracking files in a way I like

Dotfile-tracking Function

The function is in the .bash_aliases.

I also put it in a separate file so that it can be appended to an existing .bashrc or .bash_aliases file conveniently with echo >>

Reminder

The function depends on some of my aliases, they should be appended too. If some aliases do not exist on the user's machine, bash will tell them which aliases are problematic when trying to source the updated dot file.

Purpose

• further automation
• very easy to use
• can be used to keep track of changes made on local dot files
• can also be used to update dot files on different machines with a simple git clone and cp file $HOME
• can also be used to cp dotfile $HOME on a fresh install

How It Works

• Script: A shell script (check_aliases.sh) has been created to scan your alias definitions and report any duplicates.
• Run on Save Extension: The "Run on Save" extension in VS Code is configured to automatically execute the script whenever you save your shell configuration files.

ctrl + p in VSCode: ext install emeraldwalk.RunOnSave  

• In settings.json:

{
    "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": "\\.(bashrc|zshrc|bash_aliases|zsh_aliases)$",
                "cmd": "/absolute/path/to/check_aliases.sh"
            }
        ]
    }
}

• Usage: whenever you save any of the following files:

• • ~/.bashrc
• • ~/.zshrc
• • ~/.bash_aliases
• • ~/.zsh_aliases

The check_aliases.sh script will automatically run and check for duplicate aliases. If duplicates are found, they will be reported in the output console (output, select Run on save from the dropdown).

How to test

bats test_check_aliases.bats

Features

• check if file exists
• ask user in which directory they keep their files
• • if the folder does not exist, it is created
• • if the folder exists and the file does not, it is created
• • if both the folder and file exist, the user can choose to overwrite the existing tracked file or to abord the operation
• ask user which file they want to track
• user can go (cd) to directory or stay where they are
• enable autocompletion

Todo:

• add argument to copy / track more than one file
• if .git folder exists in target folder, it is a git repo already
• • if the remote git repo is the right one: ask the user if they want to directly add, commit and push
• • if it is not the right one, ask the user to change the remote url
• • if it is not a git repo, ask the user if they want to git init
• • remote add origin and push upstream
• add tests