devcontainers-dotfiles

My own dotfiles, meant to be used with devcontainers and, therefore, made with simplicity in mind.

Demo

Features

The install script DELETES the ~/.zshrc, ~/.aliases, ~/bin and ~/.config/starship.toml files and directories from your home directory, and replaces them with symlinks to this repository's dotfiles. It also changes the default shell to zsh.

Currently, it contains:

• .zshrc: sources both .aliases and .aliases.local if present, and runs starship at the end of the file.
• .aliases: aliases for common commands (e.g., alias mkdir="mkdir -pv")
• .config/starship.toml: a Starship config i like to use, with my own modifications.
• plugins: fast-syntax-highlighting, zsh-autocomplete, and zsh-autosuggestions plugins.
• bin folder: a folder with some useful scripts I use in my projects (e.g., bin/mklinks.sh, for linking the container mounts to the project folder).

All of the files are created as symbolic links. plugins are cloned inside ~/.zsh_addons/.

A ~/.aliases.local file can be used to add your own project/system specific aliases.

Installation

Just copy the following lines to your user settings json:

{
    "containers.dotfiles.repository": "https://github.com/matheusfvesco/devcontainers-dotfiles.git",
    "containers.dotfiles.targetPath": "~/dotfiles",
}

or if you use Remote-SSH or Remote-Tunnels:

{
    "remote.containers.dotfiles.repository": "https://github.com/matheusfvesco/devcontainers-dotfiles.git",
    "remote.containers.dotfiles.targetPath": "~/dotfiles",
}

Or through the UI:

Developing

To develop, you can clone the repository inside a Dev Container Volume using VS Code.

To test, you can use the ./test.sh script. It will copy the contents from /workspaces/devcontainer-dotfiles into your home folder and run the install.sh script.