dev-environment-files/README.md

# My Dev Environment Files 🚀
**IMPORTANT:** These are primarily meant for inspiration. I wouldn't just blindly use them. Proceed at your own risk!

📹 Youtube Playlist With Detailed Walkthroughs on My Setup: [💻 My Dev Environment & Workflow](https://youtube.com/playlist?list=PLnu5gT9QrFg36OehOdECFvxFFeMHhb_07)

# Terminal Setup
✍🏼 Blog Post Step-by-Step Guide: [How To Setup Your Mac Terminal](https://josean.com/posts/terminal-setup)

📹 Youtube Guide: [How To Make Your Boring Mac Terminal So Much Better](https://www.youtube.com/watch?v=CF1tMjvHDRA&list=PLnu5gT9QrFg36OehOdECFvxFFeMHhb_07&index=2&t=479s)

### Relevant Files
- [.zshrc](.zshrc) - Zsh Shell Configuration
- [coolnight.itermcolors](coolnight.itermcolors) - iTerm2 Color Scheme

# Tmux Setup
✍🏼 Blog Post: [How To Use and Configure Tmux Alongside Neovim](https://josean.com/posts/tmux-setup)

📹 Youtube Guide: [How I Setup And Use Tmux Alongside Neovim for an Awesome Dev Workflow](https://youtu.be/U-omALWIBos)

### Relevant Files
- [.tmux.conf](.tmux.conf) - Tmux Configuration File

# Neovim Setup
💡 **Tip:** I highly recommend following along with me on youtube and use the repo as reference to set up the config. You'll understand everything a lot better and be able to change things and evolve the setup into your own!

*If you clone the repo into your machine and use the config by copying .config/nvim to your home folder, you'll have to restart neovim after the plugins install. After restart, if you are opening a lua file or another file I have language servers configured for, like html, css or javascript/typescript, you might also get an error saying that the server failed to start. This is because Mason hasn't installed it yet. Press enter to continue, Mason will automatically install it.*

📹 Youtube Step-by-Step Guide: [How I Setup Neovim On My Mac To Make It Amazing](https://youtu.be/vdn_pKJUda8)

### Relevant Files
- [.config/nvim](.config/nvim)

### Setup Requires
- True Color Terminal Like: [iTerm2](https://iterm2.com/)
- [Neovim](https://neovim.io/) (Version 0.8 or Later)
- [Nerd Font](https://www.nerdfonts.com/) - I use Meslo Nerd Font
- [Ripgrep](https://github.com/BurntSushi/ripgrep) - For Telescope Fuzzy Finder
- XCode Command Line Tools
- If working with typescript/javascript and the typescript language server like me. You might need to install node.

If you're on mac, like me, you can install iTerm2, Neovim, Ripgrep and Node with homebrew.
```bash
brew install --cask iterm2
```
```bash
brew install neovim
```
```bash
brew install ripgrep
```
```bash
brew install node
```

For XCode Command Line Tools do:
```bash
xcode-select --install
```

### Issue with Nvim-Treesitter Update and Lua Parser
The homebrew install of neovim 0.8 includes a built-in lua parser that is no longer compatible with the latest version of "nvim-treesitter".

To fix it, after opening Neovim do this:

```bash
:TSInstall lua
```

It will ask if you would like to reinstall the parser. Answer "y" for yes. After that is finished, restart neovim and the problem should be fixed.


## Plugins
#### Plugin Manager
- [wbthomason/packer](https://github.com/wbthomason/packer.nvim) - Popular plugin manager

#### Dependency For Other Plugins
- [nvim-lua/plenary](https://github.com/nvim-lua/plenary.nvim) - Useful lua functions other plugins use

#### Preferred Colorscheme
- [bluz71/vim-nightfly-guicolors](https://github.com/bluz71/vim-nightfly-guicolors)

#### Navigating Between Neovim Windows and Tmux
- [christoomey/vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator)

#### Essentials
- [tpope/vim-surround](https://github.com/tpope/vim-surround) - manipulate surroundings with "ys", "ds", and "cs"
- [vim-scripts/ReplaceWithRegister](https://github.com/vim-scripts/ReplaceWithRegister) - replace things with register with "gr"
- [numToStr/Comment.nvim](https://github.com/numToStr/Comment.nvim) - toggle comments with "gc"

#### File Explorer
- [nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua)

#### VS Code Like Icons
- [kyazdani42/nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons)

#### Status Line
- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)

#### Fuzzy Finder
- [nvim-telescope/telescope-fzf-native.nvim](https://github.com/nvim-telescope/telescope-fzf-native.nvim) - Dependency for better performance
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Fuzzy Finder

#### Autocompletion
- [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp) - Completion plugin
- [hrsh7th/cmp-buffer](https://github.com/hrsh7th/cmp-buffer) - Completion source for text in current buffer
- [hrsh7th/cmp-path](https://github.com/hrsh7th/cmp-path) - Completion source for file system paths

#### Snippets
- [L3MON4D3/LuaSnip](https://github.com/L3MON4D3/LuaSnip) - Snippet engine
- [rafamadriz/friendly-snippets](https://github.com/rafamadriz/friendly-snippets) - Useful snippets for different languages
- [saadparwaiz1/cmp_luasnip](https://github.com/saadparwaiz1/cmp_luasnip) - Completion source for snippet autocomplete

#### Managing & Installing Language Servers, Linters & Formatters
- [williamboman/mason.nvim](https://github.com/williamboman/mason.nvim)

#### LSP Configuration
- [williamboman/mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim) - Bridges gap b/w mason & lspconfig
- [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Easy way to configure lsp servers
- [hrsh7th/cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) - Smart code autocompletion with lsp
- [glepnir/lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim) - Enhanced uis for lsp
- [jose-elias-alvarez/typescript.nvim](https://github.com/jose-elias-alvarez/typescript.nvim) - Additional functionality for typescript server
- [onsails/lspkind.nvim](https://github.com/onsails/lspkind.nvim) - Vs Code Like Icons for autocompletion

#### Formatting & Linting
- [jose-elias-alvarez/null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) - Easy way to configure formatters & linters
- [jayp0521/mason-null-ls.nvim](https://github.com/jayp0521/mason-null-ls.nvim) - Bridges gap b/w mason & null-ls

#### Syntax Highlighting & Autoclosing Things
- [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Treesitter configuration
- [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) - Autoclose brackets, parens, quotes, etc...
- [windwp/nvim-ts-autotag](https://github.com/windwp/nvim-ts-autotag) - Autoclose tags

#### Git
- [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Show line modifications on left hand side
Created Readme.md 2022-10-17 23:05:01 +02:00			`# My Dev Environment Files 🚀`
			`IMPORTANT: These are primarily meant for inspiration. I wouldn't just blindly use them. Proceed at your own risk!`

			`📹 Youtube Playlist With Detailed Walkthroughs on My Setup: [💻 My Dev Environment & Workflow](https://youtube.com/playlist?list=PLnu5gT9QrFg36OehOdECFvxFFeMHhb_07)`

			`# Terminal Setup`
Update Readme.md 2022-10-18 22:46:22 +02:00			`✍🏼 Blog Post Step-by-Step Guide: [How To Setup Your Mac Terminal](https://josean.com/posts/terminal-setup)`
Created Readme.md 2022-10-17 23:05:01 +02:00
Fixed youtube link titles 2022-10-28 08:55:56 +02:00			`📹 Youtube Guide: [How To Make Your Boring Mac Terminal So Much Better](https://www.youtube.com/watch?v=CF1tMjvHDRA&list=PLnu5gT9QrFg36OehOdECFvxFFeMHhb_07&index=2&t=479s)`
Created Readme.md 2022-10-17 23:05:01 +02:00
			`### Relevant Files`
			`- [.zshrc](.zshrc) - Zsh Shell Configuration`
			`- [coolnight.itermcolors](coolnight.itermcolors) - iTerm2 Color Scheme`

Added tmux setup section to readme 2022-10-28 08:52:52 +02:00			`# Tmux Setup`
Fixed titles 2022-10-28 08:56:39 +02:00			`✍🏼 Blog Post: [How To Use and Configure Tmux Alongside Neovim](https://josean.com/posts/tmux-setup)`
Added tmux setup section to readme 2022-10-28 08:52:52 +02:00
Fixed titles 2022-10-28 08:56:39 +02:00			`📹 Youtube Guide: [How I Setup And Use Tmux Alongside Neovim for an Awesome Dev Workflow](https://youtu.be/U-omALWIBos)`
Added tmux setup section to readme 2022-10-28 08:52:52 +02:00
			`### Relevant Files`
			`- [.tmux.conf](.tmux.conf) - Tmux Configuration File`

Created Readme.md 2022-10-17 23:05:01 +02:00			`# Neovim Setup`
Update Readme 2022-10-20 22:27:17 +02:00			`💡 Tip: I highly recommend following along with me on youtube and use the repo as reference to set up the config. You'll understand everything a lot better and be able to change things and evolve the setup into your own!`
Updated readme 2022-10-19 18:37:40 +02:00
Update Readme 2022-11-02 01:42:37 +01:00			`If you clone the repo into your machine and use the config by copying .config/nvim to your home folder, you'll have to restart neovim after the plugins install. After restart, if you are opening a lua file or another file I have language servers configured for, like html, css or javascript/typescript, you might also get an error saying that the server failed to start. This is because Mason hasn't installed it yet. Press enter to continue, Mason will automatically install it.`
Updated readme 2022-10-19 18:37:40 +02:00
Update Readme.md 2022-10-18 22:34:23 +02:00			`📹 Youtube Step-by-Step Guide: [How I Setup Neovim On My Mac To Make It Amazing](https://youtu.be/vdn_pKJUda8)`
Created Readme.md 2022-10-17 23:05:01 +02:00
Moved nvim-treesitter error explanation. 2022-11-06 00:05:39 +01:00			`### Relevant Files`
			`- [.config/nvim](.config/nvim)`
Update Readme 2022-11-02 01:03:06 +01:00
Update Readme 2022-11-01 22:41:15 +01:00			`### Setup Requires`
Created Readme.md 2022-10-17 23:05:01 +02:00			`- True Color Terminal Like: [iTerm2](https://iterm2.com/)`
			`- [Neovim](https://neovim.io/) (Version 0.8 or Later)`
			`- [Nerd Font](https://www.nerdfonts.com/) - I use Meslo Nerd Font`
Added brew install commands and ripgrep to neovim setup requirements. 2022-10-19 03:00:57 +02:00			`- [Ripgrep](https://github.com/BurntSushi/ripgrep) - For Telescope Fuzzy Finder`
Update Readme 2022-11-05 23:23:18 +01:00			`- XCode Command Line Tools`
Update readme 2022-10-23 07:55:15 +02:00			`- If working with typescript/javascript and the typescript language server like me. You might need to install node.`
Added brew install commands and ripgrep to neovim setup requirements. 2022-10-19 03:00:57 +02:00
Update Readme 2022-11-02 01:28:15 +01:00			`If you're on mac, like me, you can install iTerm2, Neovim, Ripgrep and Node with homebrew.`
Added brew install commands and ripgrep to neovim setup requirements. 2022-10-19 03:00:57 +02:00			```bash
			`brew install --cask iterm2`
			```
			```bash
			`brew install neovim`
			```
			```bash
			`brew install ripgrep`
			```
Update Readme 2022-11-02 01:28:15 +01:00			```bash
			`brew install node`
			```
Created Readme.md 2022-10-17 23:05:01 +02:00
Update Readme 2022-11-05 23:23:18 +01:00			`For XCode Command Line Tools do:`
			```bash
			`xcode-select --install`
			```

Moved nvim-treesitter error explanation. 2022-11-06 00:05:39 +01:00			`### Issue with Nvim-Treesitter Update and Lua Parser`
			`The homebrew install of neovim 0.8 includes a built-in lua parser that is no longer compatible with the latest version of "nvim-treesitter".`

			`To fix it, after opening Neovim do this:`

			```bash
			`:TSInstall lua`
			```

			`It will ask if you would like to reinstall the parser. Answer "y" for yes. After that is finished, restart neovim and the problem should be fixed.`

Created Readme.md 2022-10-17 23:05:01 +02:00
			`## Plugins`
			`#### Plugin Manager`
			`- [wbthomason/packer](https://github.com/wbthomason/packer.nvim) - Popular plugin manager`

			`#### Dependency For Other Plugins`
			`- [nvim-lua/plenary](https://github.com/nvim-lua/plenary.nvim) - Useful lua functions other plugins use`

			`#### Preferred Colorscheme`
			`- [bluz71/vim-nightfly-guicolors](https://github.com/bluz71/vim-nightfly-guicolors)`

			`#### Navigating Between Neovim Windows and Tmux`
			`- [christoomey/vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator)`

			`#### Essentials`
			`- [tpope/vim-surround](https://github.com/tpope/vim-surround) - manipulate surroundings with "ys", "ds", and "cs"`
			`- [vim-scripts/ReplaceWithRegister](https://github.com/vim-scripts/ReplaceWithRegister) - replace things with register with "gr"`
			`- [numToStr/Comment.nvim](https://github.com/numToStr/Comment.nvim) - toggle comments with "gc"`

			`#### File Explorer`
			`- [nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua)`

			`#### VS Code Like Icons`
			`- [kyazdani42/nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons)`

			`#### Status Line`
			`- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)`

			`#### Fuzzy Finder`
			`- [nvim-telescope/telescope-fzf-native.nvim](https://github.com/nvim-telescope/telescope-fzf-native.nvim) - Dependency for better performance`
			`- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) - Fuzzy Finder`

			`#### Autocompletion`
			`- [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp) - Completion plugin`
			`- [hrsh7th/cmp-buffer](https://github.com/hrsh7th/cmp-buffer) - Completion source for text in current buffer`
			`- [hrsh7th/cmp-path](https://github.com/hrsh7th/cmp-path) - Completion source for file system paths`

			`#### Snippets`
			`- [L3MON4D3/LuaSnip](https://github.com/L3MON4D3/LuaSnip) - Snippet engine`
			`- [rafamadriz/friendly-snippets](https://github.com/rafamadriz/friendly-snippets) - Useful snippets for different languages`
			`- [saadparwaiz1/cmp_luasnip](https://github.com/saadparwaiz1/cmp_luasnip) - Completion source for snippet autocomplete`

			`#### Managing & Installing Language Servers, Linters & Formatters`
			`- [williamboman/mason.nvim](https://github.com/williamboman/mason.nvim)`

			`#### LSP Configuration`
			`- [williamboman/mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim) - Bridges gap b/w mason & lspconfig`
			`- [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) - Easy way to configure lsp servers`
			`- [hrsh7th/cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) - Smart code autocompletion with lsp`
			`- [glepnir/lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim) - Enhanced uis for lsp`
			`- [jose-elias-alvarez/typescript.nvim](https://github.com/jose-elias-alvarez/typescript.nvim) - Additional functionality for typescript server`
			`- [onsails/lspkind.nvim](https://github.com/onsails/lspkind.nvim) - Vs Code Like Icons for autocompletion`

			`#### Formatting & Linting`
			`- [jose-elias-alvarez/null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim) - Easy way to configure formatters & linters`
			`- [jayp0521/mason-null-ls.nvim](https://github.com/jayp0521/mason-null-ls.nvim) - Bridges gap b/w mason & null-ls`

			`#### Syntax Highlighting & Autoclosing Things`
			`- [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - Treesitter configuration`
			`- [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) - Autoclose brackets, parens, quotes, etc...`
			`- [windwp/nvim-ts-autotag](https://github.com/windwp/nvim-ts-autotag) - Autoclose tags`

			`#### Git`
			`- [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) - Show line modifications on left hand side`