Marc's dotfiles

Note: I chose to leave every possible file in a subfolder to keep my home dir as clean as possible and keep my own custom files separate from the other files.

Table of content

• Marc's dotfiles
  • Prerequirements
    • iTerm profile configuration
  • Installation
  • Keyboard shortcuts
  • Aliases
  • Install Laravel Valet and tools like Memcached, Mailhog, Xdebug and more
  • EditorConfig
  • Add custom commands without creating a new fork
  • Using two Git identities to seperate work and personal accounts
  • Prefix commit message with a ticket number automatically
  • Terminal completion
  • Environment variables
    • nginx
  • MySQL database import and export
  • Help
    • Git Completion not working
  • Contact
  • Credits
  • To do

Prerequirements

• Z shell (Installation instructions)
• iTerm2
• Oh My Zsh (Installation instructions)
• Powerlevel9k for Oh-My-ZSH (Installation instructions)

iTerm profile configuration

• I use the Book font type of the DejaVu Sans Mono for Powerline font at size 15.
  You can set the font in the preferences under the Profiles > Text.
  You can download the font here.
• I use the Solarized theme color scheme.
  You can set the color scheme in the preferences under the Profiles > Colors.
  At the time of writing this is part of iTerm. Otherwise you can download the scheme for iTerm here.

Installation

Run git clone git@github.com:MGHollander/zsh-dotfiles.git dotfiles in the root of your user directory.

Replace content of ~/.zshrc or just add the code on the bottom:

# Load custom dotfiles
source ~/dotfiles/.zshrc;

Add to ~/.gitconfig

# Load custom git config
[include]
    path = ~/dotfiles/.gitconfig

NOTE: Some git config files might be overwritten by Git GUI tools. For example: My ~/dotfiles/.gitignore wasn't loading. When I checked my ~/.gitconfig the excludesfile variable was overwritten by Sourcetree. Therefore I had to configure my own global .gitignore in the Sourcetree settings.

Copy .config-example, rename the copied file to .config and change the variables inside the file.

Keyboard shortcuts

My favorite keyboard shortcuts

Aliases

All available aliases

Install Laravel Valet and tools like Memcached, Mailhog, Xdebug and more

Read all about it!

EditorConfig

If you want to use the .editorconfig then you have to move it to the root of the user directory.

Add custom commands without creating a new fork

If .extra exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository.

You can also add a directory named extra in which you can add files that you do not want in your repository. These files will not be sourced along with other files. If they need to be sources, then you should use the .extra file to source them.

Using two Git identities to seperate work and personal accounts

Às of Git 2.13.0 there is a possibility to include confitional config. This is usefull when you use your machine for both work and private.

An example of how I use it.

My ~/.gitconfig:

[user]
    name = Marc Hollander
    email = my@personal.mail

[includeIf "gitdir:~/dev/work/"]
    path = ~/.gitconfig-work

My ~/.gitconfig-work:

[user]
    name = Marc Hollander (Work)
    email = my@work.mail

By default my commits will be in name of my personal account. When I commit something from a repository inside the ~/dev/work/ directory, then it will be in name of my work account.

Prefix commit message with a ticket number automatically

Based on https://medium.com/better-programming/how-to-automatically-add-the-ticket-number-in-git-commit-message-bda5426ded05

Examples of ticket numbers that are extracted:

myproj-123-some-feature → MYPROJ-123
feature/myproj-456-some-other-feature → MYPROJ-456
bugifx/myproj-789 →  MYPROJ-789
123_some_feature →  #123
123-another-feature →  #123

Copy prepare-commit-msg to the default Git hook template folder. On my machine this folder is placed add /usr/local/git/share/git-core/templates. These templates will be copied to every new repository that you create or clone on your machine.

NOTE: You have to copy the file to existing repositories manually. You can copy the file to all existing repositories by running echo /path/to/projects/*/.git/hooks/ | xargs -n 1 cp ~/dotfiles/prepare-commit-msg, but you should be aware that it will overwrite existing files.

NOTE: Make sure the file is executable after you have copied it to a repository manually. Run chmod +x /path/to/repo/.git/hooks/pre-commit-msg for the correct permissions. You can also use a wildcard here if you have copied the file to multiple existing repositories using the above command. This should look something like this: chmod +x /path/to/projects/*/.git/hooks/prepare-commit-msg.

Source: https://medium.com/better-programming/how-to-automatically-add-the-ticket-number-in-git-commit-message-bda5426ded05

Terminal completion

You can add paths to the CDPATH variable in .path for shortcuts when you use the cd command.

Environment variables

The .exports file contains an environment variable to use to check if you are on a certain environment. The variable is named APP_ENV.

You should also set the environment variable to your development environments.

nginx

See the Laravel Valet docs for nginx environment variables.

MySQL database import and export

There are scripts with aliases available to import and export MySQL databases. Run dbi --help and dbe --help for instructions to use these scripts. The default MySQL config is set in .config.

Help

Git Completion not working

Run chmod -X ~/.git-completion.bash and restart your terminal. (source)

Contact

Please create an issue if you have any questions or suggestions.

Credits

• Mathias’s dotfiles

To do

• Clean up and add a list with all functionalities included in the dotfiles. Describe things that happen in files that do not have aliases or functions, but do have useful functionalities (.bash_prompt, .exports, etc.).
• Check if the original dotfiles contain an installer and (re)add this to my version. Also add new stuff such as bash-completion (via Homebrew) and drush. Maybe run brew services list to see what is installed via Homebrew.
• Split up the scripts in smaller bits. For example valet/create-db.sh and mysql/create-db.sh. That makes it easy to swap out tasks in the main script. And makes it more flexibel.