eliasnorrby / dotfiles

:computer: Dotfiles for development on MacOS and Manjaro

.DOTFILES

Declarative dotfiles for development on MacOS and Manjaro.

Bootstrap

To provision a new workstation from scratch, use the setup.sh (or setup-linux.sh) script.

Run

bash <(curl -sL https://raw.githubusercontent.com/eliasnorrby/dotfiles/develop/setup.sh)

Prepare to input your password a couple of times.

This setup script will:

• Install homebrew

• Install python3 and openssl (using brew)

• Download a snapshot version of this repo

• Install ansible (using brew)

• Install ansible role dependencies

• Run the downloaded playbook (_provision/playbook.yml), wherein:

  • This repo is cloned to ~/.dotfiles
  • Symlinks are created
  • xcode command line tools are installed (or verified to have been installed)
  • Dependencies are downloaded (using homebrew, pip, ruby and npm)

• Run the post-install script, wherein:

  • zsh plugins are installed
  • vim plugins are installed
  • coc-nvim extensions are installed
  • vscode plugins are installed
  • doom-emacs packages are installed

🕐 Estimated duration: ~45 minutes

Dependencies:

• geerlingguy/homebrew
• geerlingguy/git
• kewlfft/aur

Directory structure

Configuration is divided into topics (inspired by hlissner).

Example topics:

• shell/zsh
• shell/tmux
• editor/vim

Topics are grouped by category (editor, shell, etc). Each topic must contain a topic.config.yml, and can optionally include a topic.tasks.yml, an aliases.zsh, an env.zsh, as well as any other files relevant to its configuration.

Ansible tasks defined in topic.tasks.yml will be run during provisioning.

Environment variables defined in env.zsh will be sourced during shell startup if the topic is enabled. The same is true for aliases defined in aliases.zsh.

.dotfiles
└── group
    ├── topic
    │   ├── aliases.zsh
    │   ├── env.zsh
    │   ├── topic.config.yml
    │   └── topic.tasks.yml
    └── another-topic

Minimal example of a topic directory layout

Extended directory layout example

.dotfiles
├── editor
│   ├── editorconfig
│   │   └── topic.config.yml
│   ├── emacs
│   │   ├── aliases.zsh
│   │   ├── topic.config.yml
│   │   ├── doom
│   │   │   ├── config.el
│   │   │   ├── init.el
│   │   │   └── packages.el
│   │   └── env.zsh
│   └── vim
│       ├── aliases.zsh
│       ├── env.zsh
│       ├── gvimrc.vim
│       └── topic.config.yml
└── shell
   ├── alacritty
   │   ├── alacritty.yml
   │   ├── aliases.zsh
   │   └── topic.config.yml
   ├── git
   │   ├── aliases.zsh
   │   └── topic.config.yml
   ├── tmux
   │   ├── aliases.zsh
   │   ├── env.zsh
   │   ├── scripts
   │   │   └── uptime-tmux-status.sh
   │   ├── tmux-cheatsheet.md
   │   ├── tmux.conf
   │   ├── tmux.remote.conf
   │   ├── tmux.theme.conf
   │   └── topic.config.yml
   └── zsh
       ├── aliases.zsh
       ├── completion.zsh
       ├── config.zsh
       ├── fzf.zsh
       ├── keybinds.zsh
       ├── macos.zsh
       ├── plugins.zsh
       ├── prompt.zsh
       ├── remote.zsh
       ├── utilities.zsh
       ├── topic.config.yml
       └── topic.tasks.yml

Each topic declares its configuration (brew dependencies, symlinks, etc) in a topic.config.yml within its coresponding directory.

vim_config:
  path: editor/vim
  links:
    - .vimrc
  brew_formulas:
    - vim

Topic configuration example

Possible fields in topic.config.yml:

• path (required)
• links
• become
• brew_formulas
• brew_casks
• brew_taps
• pacman_packages
• aur_packages
• osx_defaults
• npm_packages
• pip_packages
• gem_packages
• mas_apps

‼️ TODO: Describe topic config api in detail.

Each topic configuration is mapped to root.config.yml:

topics:
  editor:
    - name: vim
      state: present
      config: "{{ vim_config }}"
    - name: emacs
      state: present
      config: "{{ emacs_config }}"
    - name: editorconfig
      state: disabled
      config: "{{ editorconfig_config }}"
  keyboard:
    - name: hammerspoon
      state: present
      config: "{{ hammerspoon_config }}"
    - name: karabiner
      state: present
      config: "{{ karabiner_config }}"
  shell:
    - name: tmux
      state: present
      config: "{{ tmux_config }}"
    - name: zsh
      state: present
      config: "{{ zsh_config }}"
  lang:
    - name: java
      state: present
      config: "{{ java_config }}"
    - name: go
      state: absent
      config: "{{ go_config }}"

Root dotfile configuration example

In root.config.yml, topics can be enabled/disabled/removed by setting their state to one of present, disabled or absent. Upon running,

• present topics will have their symlinks created (if they don't exist already) and their dependencies installed
• disabled topics will have their symlinks removed (if they exist), but their dependencies left alone (if they are installed)
• absent topics will have their symlinks removed (if they exist) and their dependencies uninstalled (if they are installed)

CLI

🔧 eliasnorrby/dotfiles-cli

The CLI provides a simpler way to edit, view and apply configurations.

Leftovers

After running the provisioning script, there are a few things that need to be configured manually.

General

• Set the computer name
  • (MacOS) Preferences → Sharing
  • (Linux) sudo scutil --set HostName <name-you-want>
• Generate ssh keys

  ssh-keygen -t ed25519 -C "[email protected]"
  gh auth login

  • Docs: Generate, Add

MacOS

• Start all apps and prepare to grant lots of privileges
  • Start with Karabiner and Hammerspoon to enable app shortcuts
• Set main Alfred hotkey to ⌥ + SPACE
• Set desktop background (assets available in Dropbox)
• Add additional desktops
• Enable shortcuts for desktop navigation (Preferences → Keyboard → Shortcuts → Mission Control)
• Remap layout switching shortcuts (Preferences → Keyboard → Shortcuts → Input Sources)
• Add Amethyst padding (2 px window margin, 5 px screen padding)
• Start Amethyst on Login (menubar configuration)
• Configure Bartender to hide the appropriate icons, supply license
• Import iStatMenus settings from assets/istatmenus, supply license
• Some apps may require Rosetta to run
  • /usr/sbin/softwareupdate --install-rosetta --agree-to-license
• Add Workman-P layout (?)

Optional

• Download the Dank Mono font

Troubleshooting

zsh: compinit complains about insecure directories

It's probably mentioning /usr/local/share/zsh. Resolve it by running e.g:

sudo chown -R eliasnorrby:admin /usr/local/share/zsh
sudo chmod -R 755 /usr/local/share/zsh