A performance-optimized Neovim configuration designed for Ruby on Rails and JavaScript/TypeScript development.
- Ready for Rails and JavaScript: Pre-configured LSP, snippets, and tools for Ruby on Rails and JavaScript/TypeScript development
- Optimized for Performance: Fast startup times and efficient plugin management
- Quality LSP Configuration: Fully configured language servers with intelligent code completion, diagnostics, and formatting
- Custom Rails Workflow Functions: Enhanced productivity with custom functions for Rails development patterns
Clone this repository to your Neovim configuration directory:
# Backup your existing config (optional)
mv ~/.config/nvim ~/.config/nvim.backup
# Clone NeoMood (from your fork)
git clone git@github.com:yourusername/neomood.git ~/.config/nvimTo test NeoMood without replacing your current configuration:
# Clone to a temporary directory (change username for yourname, after you forked this repository)
git clone git@github.com:yourusername/neomood.git ~/.config/neomood-test
# Start Neovim with the test configuration
NVIM_APPNAME=neomood-test nvim- Neovim 0.11+
- ripgrep (rg) - For fast file searching
- Python 3 with neovim package:
pip3 install neovim - Ruby with neovim gem:
gem install neovim - Node.js (for JavaScript/TypeScript LSP support)
- tree-sitter-cli: Should be installed with your package manager, not npm
Run :checkhealth in Neovim to verify all requirements are met.
To receive updates while maintaining your customizations:
-
Add NeoMood as upstream remote:
cd ~/.config/nvim git remote add upstream https://github.com/otavioschwanck/neomood.git
-
Fetch and merge updates:
git fetch upstream git merge upstream/master
-
Resolve any conflicts and commit your merge.
This workflow allows you to get new features while preserving your personal customizations.
NeoMood is designed to be forked and customized. Key files to modify:
lua/neomood/options.lua- Vim options and settingslua/neomood/mappings.lua- Key mappingslua/plugins/- Plugin configurationslua/neomood/autocmds.lua- Auto commands
- Installation Guide - Detailed installation instructions for different operating systems
- Tmux Workflow - Essential tmux + Alacritty integration for optimal development
- Key Mappings - Complete list of key mappings
- Plugin Reference - Overview of all included plugins
- Quick Reference - Essential mappings and commands
If you encounter issues:
- Run
:checkhealthto verify your environment - Check the documentation for troubleshooting
- Open an issue with your environment details
MIT License - Feel free to fork and customize for your needs.
