@seantrane/dotfiles

Backup, restore, and sync the prefs and settings for your toolbox. Your dotfiles might be the most important files on your machine.

Table of Contents

• About the dotfiles
• Fork It or Clone It
• Install
• Usage
• Thanks
• Support
• Contributing
• Changelog
• License

---

About the dotfiles

These are my dotfiles. The child of many influences, primarily Zach Holman's dotfiles, who I owe a great deal of credit to.

See Thanks section for full credits.

This is a highly organized and adaptive dotfiles approach. Instead of using a limited set of bloated files, this approach is topic-centric and uses a folder-file structure to allow more effective customization, and diff-tracking.

These dotfiles are meant to support both MacOS and Linux at the same time. I use both regularly and prefer a consistent experience. However, most installs use Homebrew and will not work if Homebrew does not support the OS.

---

Fork It or Clone It

Although one could run the install instructions right from this repo, one should fork or clone the repo into one's own Git provider, first. Then change all references below, from github.com/seantrane/dotfiles to your.com/profile/repo. Doing that will ensure all changes are committed to one's dotfiles repo.

---

Install

Step 1

Extract the contents of the repository to ~/.dotfiles. The command below will either use git, if available, or curl to clone the repo to that location.

if type "git" &> /dev/null; then git clone https://github.com/seantrane/dotfiles.git ~/.dotfiles; else cd; curl -LOk https://github.com/seantrane/dotfiles/archive/main.zip; unzip main.zip; mv dotfiles-main .dotfiles; rm main.zip; fi

Step 2

Every file can be edited or removed as one pleases, but there are few primary files to focus on. Every file is heavily commented and should be intuitive to follow. Learn more about file structure and processing, in contributing docs.

👀 Note: Editing Brewfile.symlink file is a must. Because it contains my software preferences that others may not want. In fact, when I use my dotfiles between work and personal machines, this is the only file I really change.

1. Edit system/Brewfile.symlink, for preferred software, resources, and anything else that can be installed using Homebrew Bundle.
2. Edit macos/set-defaults.sh, for macOS defaults, preferences.
3. Edit system/Gemfile.symlink, for global Ruby gems.
4. Edit script/install, for OS-specific installs, global Node.js/npm dependencies.
5. (Optional) Edit zsh/zpreztorc.symlink, for Prezto configuration.
6. (Optional) Edit zsh/zshenv.symlink and zsh/zshrc.symlink, for Zsh configuration.
7. (Optional) Edit bash/bashrc.symlink, for Bash configuration.

Step 3

To bootstrap the .dotfiles and install dependencies, run the following command.

~/.dotfiles/script/bootstrap

This process will...

1. Configure the .gitconfig file.
2. Symlink all ~/.dotfiles/*/*.symlink files to the $HOME directory.
3. Install Xcode Command Line Tools (macOS only), if unavailable.
4. Install Homebrew, if unavailable.
5. Install Git, if not installed with Homebrew.
6. Install Ruby, if not installed with Homebrew.
7. Install Prezto, Zsh, and Zsh Completions.
8. Reset default shell to Zsh.

Step 4

After restarting the terminal/shell, run all installers.

~/.dotfiles/script/install

Step 5

Restart the terminal/shell.

(Optional) Step 6

1. Attention Oh My Zsh users. I prefer to use Prezto because it's faster and lightweight. Oh My Zsh can be easily swapped by editing the "Source/init Prezto" section of zsh/zshrc.symlink.
2. The Bash environment resembles the Zsh + Prezto environment as much as possible so that it's more seamless in moments when using Bash. Type bash at the Zsh-command-line to enter Bash shell, followed by exit when finished. If Bash is the preferred default, one can run chsh -s "$(brew --prefix)/bin/bash" or chshell bash, and update IDE preferences.

---

Usage

Topical

Everything is built around topic areas. If you're adding a new area to your forked dotfiles — say, "Java" — you can simply add a java directory and put files in there.

Components

There are a few special files in the hierarchy.

• bin/*: Anything in bin/ will get added to your $PATH and be made available everywhere.
• functions/*: Anything in functions/ will be sourced, auto-loaded into the shell environment.
• <topic>/*.sh: Any files ending in .sh get loaded into Bash and Zsh.
• <topic>/*.bash: Any files ending in .bash get loaded into Bash.
• <topic>/*.zsh: Any files ending in .zsh get loaded into Zsh.
• <topic>/path.{,ba,z}sh: Any file named path.sh, path.zsh or path.bash is loaded first and is expected to setup $PATH or similar.
• <topic>/completion.{ba,z}sh: Any file named completion.zsh or completion.bash is loaded last and is expected to setup autocomplete.
• <topic>/*.symlink: Any files ending in *.symlink get symlinked into the $HOME directory (without extension), enabling version control and auto-loading at the same time. These get symlinked in when you run script/bootstrap or install_dotfiles.

Updates/Maintenance

dot is a simple script that updates dependencies, packages, sets sane macOS defaults, and so on. Tweak this script, and occasionally run dot from time to time to keep your environment fresh and up-to-date. You can find this script in the bin/ directory.

---

System Provisioning Features

Node.js global dependencies

• cucumber
• ember-cli
• gulp
• less
• serverless
• yo

Ruby Gems

• boom
• jekyll
• rails
• sass

Visual Studio Code Extensions

Some extensions may be disabled (commented-out in code).

• Angular Snippets
• Apache Conf
• AsciiDoc support
• Atom Keymap
• Auto Close Tag
• Auto Rename Tag
• AutoFileName
• autopep8 Python formatter
• BalanceD Syntax Theme
• BATS (Bash Automated Testing System)
• Bash IDE
• Better Align
• Black Formatter for Python
• Bootstrap 4, Font awesome 4, Font Awesome 5 Free & Pro snippets
• Brewfile
• Bridge to Kubernetes
• Change Case
• chmod
• Code Runner
• Code Spell Checker
• Contextual Duplicate
• Cucumber (Gherkin) Syntax and Snippets
• Cuelang
• Debugger for Java
• Dev Containers
• Docker
• Document This
• DotENV
• EditorConfig for VS Code
• Elixir Support for VS Code
• ESLint
• ExpressionEngine
• Extension Pack for Java
• File Downloader
• File Utils
• Git History
• GitHub Codespaces
• gitignore
• Go
• Gradle for Java
• GraphQL for VSCode
• HashiCorp Terraform
• i18n Ally
• IntelliCode API Usage Examples
• IntelliCode
• isort
• Jasmine code snippets
• JavaScript (ES6) code snippets
• JavaScript Snippet Pack
• Jekyll Syntax Support
• Jest
• Kubernetes
• Language Support for Java(TM) by Red Hat
• Lodash Snippets
• Markdown Preview Enhanced
• Markdown Preview Github Styling
• Markdown Table Prettifier
• markdownlint
• Material Icon Theme
• Maven for Java
• Mocha Snippets
• Multiple Formatters
• New Relic CodeStream
• New Relic One
• New Relic Query Language
• npm Intellisense
• Output Colorizer
• Path Intellisense
• Prettier - Code formatter
• Project Manager for Java
• Pylance
• Python
• Python Debugger
• Rainbow CSV
• RAML
• React Native Tools
• Regex Previewer
• Remote Development
• REST Client
• Rewrap
• Sass (.sass only)
• Select Line Status Bar
• Shell Snippets
• ShellCheck
• shfmt
• slugify
• SonarLint
• Sort JSON objects
• Sort lines
• Terraform doc snippets
• Test Runner for Java
• Vetur - Vue tooling for VS Code
• VS Code database
• VS DocBlockr
• vscode-icons
• XML Tools
• YAML
• yapf Python formatter
• yo

---

Thanks

Big thanks goes out to Zach Holman, whose dotfiles were so awesome, I had to fork them. Zach forked his from Ryan Bates' dotfiles. I am grateful for their efforts. Zach wrote a post on the subject that I encourage reading.

I've also learned and depend on techniques from other dotfiles; Mathias Bynens, Paul Irish, and Simon Owen who also wrote a great article on the subject.

Learn more about dotfiles.

---

Support

Submit an issue, in which you should provide as much detail as necessary for your issue.

Bugs

I don't really promote this repository, it's just for my personal use and made available for everyone. If you experience any bugs, I'm definitely interested, but cannot promise anything.

Contributing

Contributions are always appreciated. Read CONTRIBUTING.md documentation to learn more.

Changelog

Release details are documented in the CHANGELOG.md file, and on the GitHub Releases page.

---

License

ISC License

Copyright (c) 2015 Sean Trane Sciarrone