Skip to content

otavioschwanck/neomood

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeoMood

neomood

A performance-optimized Neovim configuration designed for Ruby on Rails and JavaScript/TypeScript development.

Features

  • 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

Installation

Quick Start

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/nvim

Try Before You Commit

To 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

Requirements

  • 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.

Upgrading

To receive updates while maintaining your customizations:

  1. Add NeoMood as upstream remote:

    cd ~/.config/nvim
    git remote add upstream https://github.com/otavioschwanck/neomood.git
  2. Fetch and merge updates:

    git fetch upstream
    git merge upstream/master
  3. Resolve any conflicts and commit your merge.

This workflow allows you to get new features while preserving your personal customizations.

Customization

NeoMood is designed to be forked and customized. Key files to modify:

  • lua/neomood/options.lua - Vim options and settings
  • lua/neomood/mappings.lua - Key mappings
  • lua/plugins/ - Plugin configurations
  • lua/neomood/autocmds.lua - Auto commands

Documentation

Support

If you encounter issues:

  1. Run :checkhealth to verify your environment
  2. Check the documentation for troubleshooting
  3. Open an issue with your environment details

License

MIT License - Feel free to fork and customize for your needs.

About

Neovim starting configuration for Rails Developers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors