Configuring Mac for Development

My preferred configuration on MacBook for development.

Development environment configuration
Work tools
System preferences
Terminal preferences

Development environment configuration

Configure or install the following if you have not yet done so. Skip steps otherwise. Alternatively, you may run the setup.sh script to do most of the following automatically.

Install latest Xcode from AppStore (it may take a while) OR
- xcode-select --install
- git --version (verify the installation and accept License terms and conditions)
Install Homebrew to manage packages (see http://brew.sh for details)
- /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Install Java JDK latest version
- brew cask install java
Install customized vim if any (e.g., install other distribution on OS X)
- OS X ships vim with -clipboard (run vim --version to check), however, +clipboard is required for copying to/pasting from system clipboard in vim. And YouCompleteMe does not work well with the default vim
- brew install vim
Install git command and SSH key (e.g., bitbucket, gitlab, github)
- Integrate vim-gitgutter plugin that tells the changes of a file (included in vim configuration)
- Configure the vim installed by brew as the editor git config --global core.editor /usr/local/bin/vim
Install util tools: wget, tree
- brew install wget
- brew install tree # list directory structure
Install OpenVPN client (Tunnelblick) and configure VPN (excluded from the setup.sh)
- Download from OpenVPN website (visit https://openvpn.net) OR
- brew install openvpn
Install Scala JDK, SBT (latest version)
- brew install scala
- brew install sbt
Install Docker (latest version)
- Download from Docker official website (visit https://www.docker.com) OR
- brew cask install docker
Install C-family formatter and checker (clang llvm)
- brew install clang-format
- Copy directory style to /usr/local/opt/style
- Create soft link: ln -s /usr/local/opt/style/bin/cppstyle /usr/local/bin/cppstyle
- Create soft link: ln -s /usr/local/opt/style/bin/google-cpp-style /usr/local/bin/google-cpp-style
Install LLVM, Cmake
- brew install llvm
- brew install cmake # required to compile YouCompleteMe plugin
Install Java formatter and checker (checkstyle, Google Java Format)
- brew install checkstyle
- brew install google-java-format
- Copy directory to checkstyle.d to /usr/local/etc/checkstyle.d
- Copy wrapper script scripts/java-checkstyle to /usr/local/bin/java-checkstyle
Install Scala formatter and checker (scalastyle, scalariform, or scalafmt)
- brew install scalastyle
- brew install scalariform
- brew install --HEAD olafurpg/scalafmt/scalafmt
Install ctags and configure it with vim to index codebase, optional (excluded from the setup.sh)
- Refer to https://andrew.stwrt.ca/posts/vim-ctags/
Install quicklook-json plugin for JSON preview (optional, excluded from the setup.sh), see https://github.com/sindresorhus/quick-look-plugins
- brew cask install quicklook-json
Install font Inconsolata (refer to fonts)
Configure ~/.bash_profile (refer to bash/bash_profile)
Configure vim (See README.md directory vim for details)

Install `clang` Analyzer

See here for details.

curl -LsS --retry 3 http://clang-analyzer.llvm.org/downloads/checker-279.tar.bz2 | tar zxvf -
mv checker-279 /usr/local/opt/
echo 'export PATH=$PATH:/usr/local/opt/checker-279/bin' >> ~/.bash_profile

Install and configure `gdb`

brew install gdb
echo "set startup-with-shell off" >> ~/.gdbinit

Code sign gdb by following this guide:

Create a certificate in the System Keychain (e.g., name it as gdb-cert)
Trust the certificate for code signing
Sign and entitle the gdb binary

cat << EOF > gdb-entitlement.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>com.apple.security.cs.debugger</key>
    <true/>
</dict>
</plist>
</pre>
EOF
codesign --entitlements gdb-entitlement.xml -fs gdb-cert $(which gdb)

Refresh the system's certificates and code-signing data

sudo killall taskgated

Install and configure `bazel`

sudo xcodebuild -license accept
# Check the latest stable version at https://github.com/bazelbuild/bazel/releases
export BAZEL_VERSION=2.1.0
curl -LO https://github.com/bazelbuild/bazel/releases/download/${BAZEL_VERSION}/bazel-${BAZEL_VERSION}-installer-darwin-x86_64.sh
chmod +x *.sh bazel-${BAZEL_VERSION}-installer-darwin-x86_64.sh && ./bazel-${BAZEL_VERSION}-installer-darwin-x86_64.sh

Add the following to ~/.bash_profile to bash completion:

source /usr/local/lib/bazel/bin/bazel-complete.bash

Work tools

Configure work email
Install communication tools (e.g., Slack, Skype for Business, WhatsApp)
Install notes (e.g., OneNote, Evernote)
Install MacTex (optional) for Tex projects (e.g., paper writing)
- See http://www.tug.org/mactex/ for download and installation guide
- See http://www.tug.org/mactex/sierra.html to tips to fix issues may exist in EI Capitan and later
Install Google Chrome browser (Chrome is my favourite browser!)
- brew cask install google-chrome

System preferences

If this is a new computer, there are a couple tweaks I like to make to the System Preferences. Feel free to follow these, or to ignore them, depending on your personal preferences.

In Apple Icon > System Preferences:

Trackpad > Tap to click
Keyboard > Key Repeat > Fast (all the way to the right)
Keyboard > Delay Until Repeat > Short (all the way to the right)
Accessibility > Mouse & Trackpad > Trackpad options > Enable dragging: three finger drag

Terminal preferences

Open Terminal > Preferences

Make Pro as default
Text > Font (Inconsolata, 14 pt)
Window > Columns: 130, Rows: 36
Color (RGB): 37/37/37

Gotchas

Change default trigger key for Vim SnipMate plugin

Default trigger key is in INSERT mode, however if TAB has been mapped something else, we need to reset the default trigger key by appending let g:snips_trigger_key = '<F2>' to ~/.vimrc (In this example, we map to function key F2). However, since snips_trigger_key has been deprecated, after making this change, every time you open vim, you will see annoying message like g:snips_trigger_key is deprecated. See :h snipMate-mappings. To avoid this, please comment the following line at ~/.vim/bundle/vim-snipmate/after/plugin/snipMate.vim

echom 'g:snips_trigger_key is deprecated. See :h snipMate-mappings'

Solve `LLDB Multiple versions of Python Incompatible Error`

Error message:

Traceback (most recent call last):
  File "<input>", line 1, in <module>
  File "/usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib/python2.7/copy.py", line 52, in <module>
    import weakref
  File "/usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7/lib/python2.7/weakref.py", line 14, in <module>
    from _weakref import (
ImportError: cannot import name _remove_dead_weakref

Workaround:

echo 'alias lldb="PATH=/usr/local/opt/llvm/bin:/usr/bin:/bin:/usr/sbin:/sbin /usr/bin/lldb"' >> ~/.bash_profile

stevenchen3/config-my-mac