Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 3.17 KB

README.md

File metadata and controls

84 lines (64 loc) · 3.17 KB
Raw

Forest's Dotfiles

I ❤️ dotfiles.

About

Dotfiles are what power your system. These are mine. They're mostly for OS X since that's what I use. My default shell these days is zsh. I use oh-my-zsh for managing lots of common stuff. All of the dotfile management is done with rcm and packages are managed with homebrew.

Whats in it?

  • Defaults for vim, tmux, git, iex, psql, and zsh shell.
  • Version management for elixir, erlang, ruby, node, etc (via. mise)
  • Lots of aliases for common commands.
  • Installation software via homebrew. See Brewfile.
  • Starship terminal prompt configuration.
  • Hammerspoon configuration for macOS automation.
  • Dash settings for offline docs and code snippets.
  • iTerm themes
  • Nerd Fonts

Install

Running ./bootstrap.sh will install all dependencies and create symlinks to all of the dotfiles. I try to make sure its up to date but every now and then there is a missing dependency. If you want to set up your mac with the same defaults that I do you can also run ./set-defaults.sh. If you need to add new dotfiles or symlinks in the future then you can simply run rcup in the dotfiles dir.

Most Frequently Used Commands

Git

  • gcom - check out the default branch
  • gib - set the integration branch (defaults to main)
  • gnf - create a new feature branch based on the integration branch
  • gsy - sync branch with upstream integration branch and push to origin
  • gpl - pull
  • gpc - push the current branch to origin
flowchart TD
    CLONE[Clone Repo]
    DEVELOP[Checkout develop branch \n <code>> gcod</code>]
    INTEGRATION[Configure integration branch \n <code>> gib develop gibd </code>]
    FEAT[Create a Feature branch \n <code>> gnf TK-421-my-feature-name </code>]
    COMMIT[Commit some code \n <code>> git commit ... </code>]
    SYNC[Push code upstream, sync with integration branch \n <code>> gsy </code>]
    PR_EXISTS?{PR Exists?}
    PR[Create a PR, maybe a draft]
    MERGE_CONFLICTS?{Merge conflicts?}
    RESOLVE_MERGE[Resolve merge conflicts]
    FEATURE_COMPLETE?{Is the feature \n complete?}


    CLONE  --> DEVELOP  --> INTEGRATION --> FEAT --> COMMIT --> SYNC --> PR_EXISTS?

    PR_EXISTS? -->|no| PR -->|keep going| COMMIT
    PR_EXISTS? -->|yes| MERGE_CONFLICTS?

    MERGE_CONFLICTS? -->|no| FEATURE_COMPLETE?
    MERGE_CONFLICTS? -->|yes| RESOLVE_MERGE -->|run again, stopped due to conflict| SYNC

    FEATURE_COMPLETE? -->|yes| DONE
    FEATURE_COMPLETE? -->|no, keep going| COMMIT
Loading

Elixir

  • im - run app in iex
  • mtw - run tests in watch mode
  • mtws - run tests in watch mode, only rerun stale tests
  • mps - run the Phoenix server
  • mdg - get mix dependencies
  • mqc - run the quick check mix task alias
  • mcov - run tests with coverage and open the results
  • notebooks - start Livebook

Other

  • de - edit these dotfiles
  • fzf - command-line fuzzy finder (ctrl-r)
  • pgst - start postgres db
  • pgsp - stop postgres db