{"id":20140049,"url":"https://github.com/jeremy-code/dotfiles","last_synced_at":"2025-03-02T23:22:07.947Z","repository":{"id":242315998,"uuid":"808086894","full_name":"jeremy-code/dotfiles","owner":"jeremy-code","description":"My dotfiles using GNU Stow, Homebrew, and Oh My Zsh","archived":false,"fork":false,"pushed_at":"2024-06-23T03:21:59.000Z","size":79,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T09:46:14.512Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeremy-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-30T11:02:45.000Z","updated_at":"2024-06-23T03:22:02.000Z","dependencies_parsed_at":"2024-06-20T17:24:41.922Z","dependency_job_id":null,"html_url":"https://github.com/jeremy-code/dotfiles","commit_stats":null,"previous_names":["jeremy-code/dotfiles"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremy-code%2Fdotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremy-code%2Fdotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremy-code%2Fdotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremy-code%2Fdotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeremy-code","download_url":"https://codeload.github.com/jeremy-code/dotfiles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241583959,"owners_count":19986074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T21:48:55.804Z","updated_at":"2025-03-02T23:22:07.930Z","avatar_url":"https://github.com/jeremy-code.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dotfiles [![License](https://img.shields.io/github/license/jeremy-code/dotfiles)](LICENSE)\n\nThese are my dotfiles. There are many like these, but these ones are mine.\n\nIntended for a MacOS development environment development in JavaScript/TypeScript with [Homebrew](https://brew.sh/) as the package manager, [iTerm2](https://iterm2.com/) as the terminal emulator, [Visual Studio Code](https://code.visualstudio.com/) as the primary editor, and [`zsh`](https://www.zsh.org/) with [Oh My Zsh](https://ohmyz.sh/) as the primary shell.\n\n## Features\n\n- [GNU Stow](https://www.gnu.org/software/stow/)\n- [Homebrew](https://brew.sh/)\n- [iTerm2](https://iterm2.com/)\n- [Oh My Zsh](https://ohmyz.sh/)\n  - [zsh-nvm](https://github.com/lukechilds/zsh-nvm)\n  - [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)\n  - [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting)\n- [Visual Studio Code](https://code.visualstudio.com/)\n- [`zsh`](https://www.zsh.org/)\n\n## Installation\n\n```bash\n# Clone the repository into `~/.dotfiles`\ngit clone --recurse-submodules https://github.com/jeremy-code/dotfiles.git ~/.dotfiles\ncd ~/.dotfiles\n\n# Run initial installation script\n./install.sh\n\n# Otherwise, run the following commands manually\n\n## Install Homebrew\n/bin/sh -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n## Install Oh My Zsh\n/bin/sh -c \"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/HEAD/tools/install.sh)\"\n\n## Install Homebrew packages, MacOS App Store apps, and VS Code extensions\nbrew bundle --file ./homebrew/.Brewfile\n\n## Activate Symlinks\nstow config git homebrew zsh\nstow -t \"$HOME/Library/Application Support/Code/User\" vscode\nstow -t \"$HOME/Library/Application Support/iTerm2/DynamicProfiles\" iterm2\n\n# Run extra scripts\nsource setup-mac.sh\nsource ssh.sh\n```\n\n## Configuration\n\n### Git\n\nThe [`git`](git) directory contains `git`-related configuration files that are symlinked to `~/.config/git`:\n\n1.  [`git/.config/git/config`](git/.config/git/config) for base Git configuration settings (name, email, etc.) and to set VS Code as default editor, diff tool, and merge tool.\n2.  [`git/.config/git/ignore`](git/.config/git/ignore) for global Git ignore rules.\n\n### GNU Stow\n\nThe directories [`config`](config), [`git`](git), [`homebrew`](homebrew) are symlinked to home directory (`~` or `$HOME`).\n\n[`vscode`](vscode) and [`iterm2`](iterm2) are symlinked to their respective directories `Code/User` and `iTerm2/DynamicProfiles` in `~/Library/Application Support`.\n\n### Homebrew\n\n[Homebrew](https://brew.sh/) is used to install Homebrew formulae and casks, MacOS App Store apps, and Visual Studio Code extensions. The list of packages and apps are defined in the [`homebrew/.Brewfile`](homebrew/.Brewfile), which is symlinked to `~/.Brewfile`. After installing and running `stow`, installation can be done with `brew bundle --global`.\n\nMiscellaneous Homebrew environment variables are defined in [`homebrew/.homebrew/brew.env`](homebrew/.homebrew/brew.env), which is symlinked to `~/.homebrew/brew.env`.\n\n### iTerm2\n\nThe [`iterm2`](iterm2) directory contains the iTerm2 dynamic profile configuration file [`DynamicProfiles/profiles.json`](iterm2/DynamicProfiles/profiles.json) for custom color schemes, theming, and other settings, which is symlinked to `~/Library/Application Support/iTerm2/DynamicProfiles`. It also contains the [`Scripts`](iterm2/Scripts) directory for custom scripts to be used in iTerm2, such as setting the default profile to the aforementioned dynamic profile in [`Scripts/AutoLaunch/change_default_profile.py`](iterm2/Scripts/AutoLaunch/change_default_profile.py).\n\n### Visual Studio Code\n\nThe [`vscode`](vscode) directory contains the Visual Studio Code settings file [`settings.json`](vscode/settings.json) for custom settings, and snippets files [`snippets/*.json`](vscode/snippets) for custom code snippets. It uses [`One Dark Pro Darker`](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme) theme, [`Fira Code`](https://github.com/tonsky/FiraCode) font, and [`Material Icon Theme`](https://marketplace.visualstudio.com/items?itemName=PKief.material-icon-theme) icon theme. It also sets up various extensions for language/library tooling ([Prettier](https://prettier.io/), [ESLint](https://eslint.org/), etc.) and miscellaneous utilities ([Git Blame](https://marketplace.visualstudio.com/items?itemName=waderyan.gitblame), [Carbon](https://marketplace.visualstudio.com/items?itemName=ericadamski.carbon-now-sh), etc.).\n\n### `zsh` and Oh My Zsh\n\nThe default shell is `zsh` using the framework [Oh My Zsh](https://ohmyz.sh/). Base `zsh` configuration files are located in the [`zsh`](zsh) directory, which set up `PATH` and Oh My Zsh.\n\nAdditional configuration is in [`oh-my-zsh`](oh-my-zsh) directory (the `ZSH_CUSTOM` directory for Oh My Zsh). The files [`aliases.zsh`](oh-my-zsh/aliases.zsh), [`constants.zsh`](oh-my-zsh/constants.zsh), [`telemetry.zsh`](oh-my-zsh/telemetry.zsh) are sourced here. The plugins, which are installed as Git submodules, are [`zsh-autosuggestions`](oh-my-zsh/plugins/zsh-autosuggestions/) and [`zsh-syntax-highlighting`](oh-my-zsh/plugins/zsh-syntax-highlighting/) for `zsh` utilities and [`zsh-nvm`](oh-my-zsh/plugins/zsh-nvm/) to automatically install and load `nvm`.\n\n### Config\n\nThe [`config`](config) directory contains miscellaneous configuration files, namely:\n\n1. [`.npmrc`](config/.npmrc) for NPM configuration settings\n2. [`.editorconfig`](config/.editorconfig) for [EditorConfig](https://editorconfig.org/) settings (matching [Prettier's defaults](https://prettier.io/docs/en/configuration#editorconfig))\n3. [`.gnupg`](config/.gnupg) for GPG signing with the pinentry program [`pinentry-mac`](https://github.com/GPGTools/pinentry).\n\n## License\n\nThis project is licensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremy-code%2Fdotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeremy-code%2Fdotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremy-code%2Fdotfiles/lists"}