~/.dotfiles

Personal dotfiles for macOS, managed with GNU Stow.

What's included

File / directory	Description
.alacritty.toml	Alacritty terminal with Dracula colour scheme
.aliases	Handy shell aliases
.bash_profile / .bashrc / .profile	Bash startup files
.brew	Homebrew formulae and casks
.gitconfig	Git settings (diff-so-fancy, GPG signing, …)
.gitmessage	Conventional Commits message template
.gnupg/	GPG configuration
.macos	Sensible macOS defaults
.macos_hardening	Security-focused macOS hardening settings
.ssh/	SSH client configuration
.tmux.conf	tmux with vi-style key bindings
.vimrc	Vim with Vundle plugins (fzf, ALE, airline, …)
bin/	Utility scripts

Prerequisites

• git
• GNU Stow — brew install stow (macOS) or apt install stow (Debian/Ubuntu)

Installation

git clone https://github.com/bdossantos/dotfiles ~/.dotfiles
cd ~/.dotfiles
make install

Uninstallation

cd ~/.dotfiles
make uninstall

macOS setup

Sensible macOS defaults

When setting up a new Mac, you may want to apply sensible defaults and security hardening:

su - admin -c "env PATH=$PATH:/usr/sbin/ bash -x $HOME/.dotfiles/.macos"
su - admin -c "env PATH=$PATH:/usr/sbin/ bash -x $HOME/.dotfiles/.macos_hardening"

Install Homebrew formulae and apps

make run-brew

Bash

Set Bash as default shell

chsh -s "$(brew --prefix)/bin/bash"
exec $SHELL

Choosing between .bashrc, .profile, .bash_profile, etc.

• ~/.bash_profile should be super-simple and just load ~/.profile and ~/.bashrc (in that order)
• ~/.profile has the stuff NOT specifically related to bash, such as environment variables (PATH and friends)
• ~/.bashrc has anything you'd want at an interactive command line. Command prompt, EDITOR variable, bash aliases for my use

A few other notes:

• Anything that should be available to graphical applications OR to sh (or bash invoked as sh) MUST be in ~/.profile
• ~/.bashrc must not output anything
• Anything that should be available only to login shells should go in ~/.profile
• Ensure that ~/.bash_login does not exist.

See also https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html

Testing

pre-commit is used for linting (shellcheck, YAML, trailing whitespace, …). Run the full test suite with:

make test

Licence

WTFPL © Benjamin Dos Santos