Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otavioschwanck/mood-nvim
A Neovim configuration for Rails and Javascript
https://github.com/otavioschwanck/mood-nvim
Last synced: 3 months ago
JSON representation
A Neovim configuration for Rails and Javascript
- Host: GitHub
- URL: https://github.com/otavioschwanck/mood-nvim
- Owner: otavioschwanck
- Created: 2022-03-10T15:44:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T09:52:36.000Z (9 months ago)
- Last Synced: 2024-04-12T12:07:01.658Z (9 months ago)
- Language: Lua
- Homepage:
- Size: 45.5 MB
- Stars: 79
- Watchers: 7
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-neovim - otavioschwanck/mood-nvim - Ready to use configuration for Ruby on Rails, JavaScript and Typescript. (Preconfigured Configuration / Competitive Programming)
README
# Introduction
mooD Nvim is a configuration made for those who wants to install and use, without worries.
- [🪄 Features](#-features)
- [📃 Dependencies](#-dependencies)
- [💾 Installation](#-installation)
- [⚠️ Disclaimer](#️-disclaimer)
- [🔗 Useful links](#-useful-links)
- [🎓 How to learn the keybindings of this configuration?](#-how-to-learn-the-keybindings-of-this-configuration)
# 🪄 Features
- 🌜 100% on Lua
- 💡 IDE Features: LSP, snippets, autocomplete, go to definition, go to references, etc.
- 📚 Handbook (SPC h h) and Tutorial (SPC h T) natively. Most of cool feature are listed there.
- ▶️ Awesome Test Runner.
- 🧑✈️ Codeium Integration (like Copilot or Whisperer)
- ✏️ Fully customizable by user (plugins, settings, LSP)
- 🔎 Find In Folder helpers: Find inside models, controller, etc using keybindngs. See `keybindings.lua` (`SPC f p`) for more examples. You can define your own custom finders.
- 🪟 TMUX Framework with `tmux-awesome-manager` that can:
- 🖥️ You can bind terminal commands in your `keybindings.lua` (`SPC f p`).
- 🚃 Useful for commands such as rails console, server, sidekiq, yarn start, generate, open production stuff, etc. (Examples on `keybindings.lua`)
- 📽️ You can define server terminal commands separated by project and run with a single command.
# 📃 Dependencies
- Neovim >= 0.9.5 < 0.10 (Neovim 0.10 is still buggy for rubocop LSP, lets use 0.9) You can use [Bob](https://github.com/MordechaiHadad/bob) to install the 0.9.5
- lazygit (optional)
- ripgrep
- NerdFonts
- Python
- pynvim (without this, it will thrown an error when you open mood)
- git-delta (for lazygit, optional) - [Installation](https://dandavison.github.io/delta/installation.html)
# 💾 Installation
We created a bash script to make your life easier and install Mood Nvim automatically.
Just run the below command in the terminal on either mac or linux (ubuntu only), choose what you want to install and have fun!
```sh
bash <(curl -Ls https://raw.githubusercontent.com/otavioschwanck/mood-nvim/main/bin/mood-installer.sh)
```
If you will use tmux, after the first open, press `C-x I` to install the packages.
To install manually, check the [Manual Installation Page](https://github.com/otavioschwanck/mood-nvim/wiki/Manual-Installation#manual-installation).
After the installation, check if is missing something with `:checkhealth`
When you run the tmux for the first time, press `C-x I` to install the missing plugins.
# ⚠️ Disclaimer
This configuration is made to use with Alacritty and Tmux. Please install it and learn before use it.
# 🔗 Useful links
- [changelog](https://github.com/otavioschwanck/mood-nvim/wiki/Changelog)
- [breaking changes](https://github.com/otavioschwanck/mood-nvim/wiki/Breaking-Changes)
# 🎓 How to learn the keybindings of this configuration?
Just press `SPC h h` to open the handbook inside vim.