Skip to content
A set of vim, zsh, git, and tmux configuration files.
Shell VimL Ruby
Find file
Latest commit 9793e83 Apr 15, 2016 @tute tute Git ignore .byebug_history
After using byebug on any Ruby file, the sessions history is written to
this file. It shouldn't be part of our repositories, so we ignore it.

See also: thoughtbot/suspenders#710
Failed to load latest commit information.
bin Overwrite internal field separator when replacing. Apr 15, 2016
git_template Bring more shell syntax into shellcheck compliance Oct 30, 2015
hooks Bring more shell syntax into shellcheck compliance Oct 30, 2015
vim Avoid expanding tabs to spaces for Golang files Apr 8, 2016
zsh Remove Unused `move_to_front_of_path` Function Nov 16, 2015
.gitignore Ignore new things in vim/bundle/ Apr 24, 2013
LICENSE Update copyright dates Feb 22, 2016
README.md Use vim-test instead of vim-rspec Mar 11, 2016
agignore Exclude `node_modules` and `bower_components` May 8, 2015
aliases Run `db:test:prepare` task on `migrate` alias Nov 29, 2015
ctags Add support for ctags in Elixir Jan 30, 2016
gemrc Disable Rubygem documentation to make Bundler fast Nov 23, 2013
gitconfig Add `git pf` alias Oct 16, 2015
gitignore Git ignore .byebug_history Apr 15, 2016
gitmessage Remove trailing whitespace in gitmessage Apr 18, 2014
gvimrc Vim configuration Jan 13, 2011
hushlogin Turn off banner at login Jun 24, 2013
psqlrc \unset QUIET is case sensitive Aug 14, 2014
rcrc Updating readme to use thoughtbot/formulae Oct 22, 2014
rspec Remove RSpec -- profile option Apr 9, 2014
tmux.conf Use C-s as tmux prefix May 22, 2015
vimrc Use vim-test instead of vim-rspec Mar 11, 2016
vimrc.bundles Add rhubarb.vim for fugitive Github support Apr 8, 2016
zshenv Only colorize warning messages if stderr is a tty Oct 23, 2015
zshrc Split zsh configuration into smaller files Nov 6, 2015

README.md

thoughtbot dotfiles

prompt

Requirements

Set zsh as your login shell:

chsh -s $(which zsh)

Install

Clone onto your laptop:

git clone git://github.com/thoughtbot/dotfiles.git

(Or, fork and keep your fork updated).

Install rcm:

brew tap thoughtbot/formulae
brew install rcm

Install the dotfiles:

env RCRC=$HOME/dotfiles/rcrc rcup

After the initial installation, you can run rcup without the one-time variable RCRC being set (rcup will symlink the repo's rcrc to ~/.rcrc for future runs of rcup). See example.

This command will create symlinks for config files in your home directory. Setting the RCRC environment variable tells rcup to use standard configuration options:

  • Exclude the README.md and LICENSE files, which are part of the dotfiles repository but do not need to be symlinked in.
  • Give precedence to personal overrides which by default are placed in ~/dotfiles-local

You can safely run rcup multiple times to update:

rcup

You should run rcup after pulling a new version of the repository to symlink any new files in the repository.

Make your own customizations

Put your customizations in dotfiles appended with .local:

  • ~/.aliases.local
  • ~/.git_template.local/*
  • ~/.gitconfig.local
  • ~/.gvimrc.local
  • ~/.psqlrc.local (we supply a blank .psqlrc.local to prevent psql from throwing an error, but you should overwrite the file with your own copy)
  • ~/.tmux.conf.local
  • ~/.vimrc.local
  • ~/.vimrc.bundles.local
  • ~/.zshrc.local
  • ~/.zsh/configs/*

For example, your ~/.aliases.local might look like this:

# Productivity
alias todo='$EDITOR ~/.todo'

Your ~/.gitconfig.local might look like this:

[alias]
  l = log --pretty=colored
[pretty]
  colored = format:%Cred%h%Creset %s %Cgreen(%cr) %C(bold blue)%an%Creset
[user]
  name = Dan Croak
  email = dan@thoughtbot.com

Your ~/.vimrc.local might look like this:

" Color scheme
colorscheme github
highlight NonText guibg=#060606
highlight Folded  guibg=#0A0A0A guifg=#9090D0

To extend your git hooks, create executable scripts in ~/.git_template.local/hooks/* files.

Your ~/.zshrc.local might look like this:

# load pyenv if available
if which pyenv &>/dev/null ; then
  eval "$(pyenv init -)"
fi

Your ~/.vimrc.bundles.local might look like this:

Plug 'Lokaltog/vim-powerline'
Plug 'stephenmckinney/vim-solarized-powerline'

zsh Configurations

Additional zsh configuration can go under the ~/.zsh/configs directory. This has two special subdirectories: pre for files that must be loaded first, and post for files that must be loaded last.

For example, ~/.zsh/configs/pre/virtualenv makes use of various shell features which may be affected by your settings, so load it first:

# Load the virtualenv wrapper
. /usr/local/bin/virtualenvwrapper.sh

Setting a key binding can happen in ~/.zsh/configs/keys:

# Grep anywhere with ^G
bindkey -s '^G' ' | grep '

Some changes, like chpwd, must happen in ~/.zsh/configs/post/chpwd:

# Show the entries in a directory whenever you cd in
function chpwd {
  ls
}

This directory is handy for combining dotfiles from multiple teams; one team can add the virtualenv file, another keys, and a third chpwd.

The ~/.zshrc.local is loaded after ~/.zsh/configs.

vim Configurations

Similarly to the zsh configuration directory as described above, vim automatically loads all files in the ~/.vim/plugin directory. This does not have the same pre or post subdirectory support that our zshrc has.

This is an example ~/.vim/plugin/c.vim. It is loaded every time vim starts, regardless of the file name:

# Indent C programs according to BSD style(9)
set cinoptions=:0,t0,+4,(4
autocmd BufNewFile,BufRead *.[ch] setlocal sw=0 ts=8 noet

What's in it?

vim configuration:

  • Ctrl-P for fuzzy file/buffer/tag finding.
  • Rails.vim for enhanced navigation of Rails file structure via gf and :A (alternate), :Rextract partials, :Rinvert migrations, etc.
  • Run many kinds of tests from vim
  • Set <leader> to a single space.
  • Switch between the last two files with space-space.
  • Syntax highlighting for CoffeeScript, Textile, Cucumber, Haml, Markdown, and HTML.
  • Use Ag instead of Grep when available.
  • Map <leader>ct to re-index Exuberant Ctags.
  • Use vim-mkdir for automatically creating non-existing directories before writing the buffer.
  • Use vim-plug to manage plugins.

tmux configuration:

  • Improve color resolution.
  • Remove administrative debris (session name, hostname, time) in status bar.
  • Set prefix to Ctrl+s
  • Soften status bar color from harsh green to light gray.

git configuration:

  • Adds a create-branch alias to create feature branches.
  • Adds a delete-branch alias to delete feature branches.
  • Adds a merge-branch alias to merge feature branches into master.
  • Adds an up alias to fetch and rebase origin/master into the feature branch. Use git up -i for interactive rebases.
  • Adds post-{checkout,commit,merge} hooks to re-index your ctags.
  • Adds pre-commit and prepare-commit-msg stubs that delegate to your local config.

Ruby configuration:

  • Add trusted binstubs to the PATH.
  • Load rbenv into the shell, adding shims onto our PATH.

Shell aliases and scripts:

  • b for bundle.
  • g with no arguments is git status and with arguments acts like git.
  • git-churn to show churn for the files changed in the branch.
  • migrate for rake db:migrate && rake db:rollback && rake db:migrate.
  • mcd to make a directory and change into it.
  • replace foo bar **/*.rb to find and replace within a given list of files.
  • tat to attach to tmux session named the same as the current directory.
  • v for $VISUAL.

Thanks

Thank you, contributors! Also, thank you to Corey Haines, Gary Bernhardt, and others for sharing your dotfiles and other shell scripts from which we derived inspiration for items in this project.

License

dotfiles is copyright © 2009-2016 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About thoughtbot

thoughtbot

dotfiles is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects. We are available for hire.

Something went wrong with that request. Please try again.