Vimacs

A Neovim Configuration. Inspired by JetBrains, Emacs, VS Code. Built on top of NvChad's UI.

Preface

This Neovim Distribution is heavily focused on performance, feature and beauty.

Vimacs is Beautiful

Vimacs uses a base configuration called NvChad which is beautiful out of the box.

Vimacs is Feature-rich

Vimacs comes with dozens of neovim plugins optimized for your daily use

Vimacs uses external programse to enhance it's functionality. (e.g) Vimacs has an optional mail client based on neomutt

The following image shows the which-key.nvim help for <leader> (aka space) key

[!NOTE] Green text means the top of the keymapping tree (e.g <leader>a includes everything related to AI, <leader>ai opens the Cody AI assistant in a vertical split) Red text means the direct cmd (e.g <leader>. opens the file manager)

Vimacs is Performant?

Because of the extensive ecosystem of Vimacs, Performance optimizations are crucial.

With the power of lazy loading (~%97.5), you only pay for what you use (lazy.nvim)

In addition to that, external programs use the system shell as an interface which doesn't reduce performance.

Showcase

Prerequisites

Vimacs requires Neovim Nightly for all the features to work properly. Although It's possible to use Vimacs with stable neovim, It's not recommended.

Also vimacs comes with a lot of dependencies. Follow the instructions on this page to install them.

[!NOTE] Some of the vimacs features will require additional setup. (e.g AI Assistant, Project Surfing etc.) And some of the advanced features will require additional installation (SEE for more info)

Feature List

• [x] NvChad:
  • [x] Hot reloaded themes (DEMO) (base46)
  • [x] Search Engine (IMAGE) (telescope.nvim)
  • [x] Basic Git Integration (gitsigns.nvim)
  • [x] Auto-Generated Cheatsheets (IMAGE) (native)
  • [x] Beautiful UI (native)

• [x] IDE:
  • [x] On-Click Updates (DEMO) (NvChad)
  • [x] Plugin Manager (lazy.nvim)
  • [x] Inline Code Runner (sniprun)
  • [x] Profiler (perfanno.nvim)
  • [x] Project:
  • [x] Project Manager (DEMO) (native)
  • [x] Project Search (telescope-project.nvim)
  • [x] Smooth Debugging Experience (DEMO) (nvim-dap) (nvim-dap-ui) (nvim-dap-virtual-text) (cmp-dap) (nvim-dap-repl-highlights) (mason.nvim) (mason-nvim-dap.nvim) (native)
  • [x] Markdown Preview (DEMO) (markdown-preview.nvim)
  • [x] Undo History Fuzzy Search (telescope-undo.nvim)
  • [x] Undo Tree (undotree)
  • [x] Code Symbols Navigation (symbols-outline.nvim)
  • [x] Git:
  • [x] Github Integration (octo.nvim)
  • [x] Github Action Tracking (gh-actions.nvim)
  • [x] Magit (neogit)
  • [x] Git Conflict Viewer (git-conflict.nvim)
  • [x] Project Runner (compiler.nvim)
  • [x] Task Framework (overseer.nvim)
  • [x] Testing Framework (neotest)
  • [x] LSP
  • [x] Code Actions
  • [x] Diagnostics
  • [x] Hover
  • [x] Go-To Actions
  • [x] Rename
  • [x] Inline Signature Help (lsp_signature.nvim)
  • [x] Completion (nvim-cmp) (nvim-lspconfig) (mason.nvim)
  • [x] File Tree (nvim-tree)
  • [x] Folding Mode (nvim-ufo)
  • [x] Brace Hints (nvim-biscuits)
  • [x] Tree-Sitter Hints (DEMO) (nvim_context_vt)
  • [x] Smooth Sine Scrolling (neoscroll.nvim)
  • [x] Session Manager (persistence.nvim)

• [x] Neovim:
  • [x] Language aware comments (Comment.nvim)
  • [x] Escape Insert Mode [jj, jk] (better-escape.nvim)
  • [x] Surround Manupilation (nvim-surround)
  • [x] Conditional + Smart File Switcher (DEMO) (other.nvim)
  • [x] Inline Bookmark Indicator (marks.nvim)
  • [x] Case Toggle (native)
  • [x] Inline UnJoining (DEMO) (treesj)
  • [x] QuickFix:
  • [x] QuickFix File Preview (DEMO) (nvim-bqf)
  • [x] Prettier Quick Fix (nvim-pqf)
  • [x] Jump Navigation (DEMO) (flash.nvim)
  • [x] File Marks (DEMO) (harpoon)
  • [x] Align Actions (DEMO) (vim-easy-align)
  • [x] Window Manager (winshift.nvim)
  • [x] Text Objets:
  • [x] Additional Text Objects (ns-textobject.nvim) (nvim-various-textobjs)
  • [x] Custom Toggle (dial.nvim)
  • [x] Exchange Motions (vim-exchange)

• [x] Miscellaneous:
  • [x] Regular Expression Explainer (Hypersonic.nvim)
  • [x] File Manager (telescope-file-browser.nvim)
  • [x] Pop-up Language Translator (vim-translator)
  • [x] REPL Translate (pantran.nvim)
  • [x] LeetCode Integration (LeetBuddy.nvim)
  • [x] Advanced Color Picker (ccc.nvim)
  • [x] Nerd Font Picker (nerdy.nvim)
  • [x] Programming
  • [x] Function Argument Highlighter (hlargs.nvim)
  • [x] Virtual Reference Table (lsp-lens.nvim)
  • [x] CheatSheets (cheetsheets.nvim)
  • [x] Real-time Colorscheme Editor (lush.nvim)
  • [x] Clipboard Manager (nvim-neoclip.lua)
  • [x] ToDo Manager (todo-comments.nvim)
  • [x] Games:
  • [x] Sudoku (sudoku.nvim)
  • [x] VimBeGood (vim-be-good)
  • [x] Tetris (nvim-tetris)
  • [x] KillerSheep (killersheep.nvim)
  • [x] Buffer Text Animations (cellular-automaton.nvim)
  • [x] Mine Sweeper (nvimesweeper)
  • [x] MonkeyType (speedtyper.nvim)
  • [x] URL Manager (urlview.nvim)
  • [x] External Browser Search (browse.nvim)
  • [x] Apps:
  • [x] Daily Calendar (apc.nvim)
  • [x] Plugin Surf (telescope-lazy.nvim)
  • [x] Integrated:
  • [x] Browser (brow.sh)
  • [x] Lynx (lynx)
  • [x] Discord Client (discord) (TOU)
  • [x] Hacker News Client (hacker_news_tui)
  • [x] IRC Client (weechat)
  • [x] Email Client (neomutt)
  • [x] World Map (mapscii)
  • [x] Music Player (ncmpcpp)
  • [x] Reddit Client (tuir)
  • [x] Stackoverflow (stackoverflow_tui)
  • [x] WhatsApp Client (nchat)

• [x] Advanced:
  • [x] Org-Mode (orgmode)
  • [x] Doc:
  • [x] Org:
    • [x] Code Block LSP (nvim-FeMaco.lua)
  • [x] Markdown:
    • [x] Markdown Mode (mkdnflow.nvim)
    • [x] Inline Code Evaluation (mdeval.nvim)
    • [x] Code Block LSP (nvim-FeMaco.lua)
    • [x] Toggle Checkbox (markdown-togglecheck)
    • [x] Mind Maps (markmap.nvim)
  • [x] Modes:
    • [x] Table Mode (DEMO) (vim-table-mode)
    • [x] Beautiful Comments (comment-box.nvim)
    • [x] Due Mode (DEMO) (due.nvim)
  • [x] Compiler Explorer (compiler-explorer.nvim)
  • [x] Tree-Sitter Explorer (neovim):
  • [x] Query Editor
  • [x] Parse Tree
  • [x] Hover Actions
  • [x] Language:
  • [x] C++:
    • [x] Doc Search (cppman.nvim)
  • [x] Rust:
    • [x] Advanced crates.io Integration (crates.nvim)
  • [x] Inline Document Generation (DEMO) (neogen)
  • [x] PasteBin Client with multi-backends (paperplanes.nvim)
  • [x] Refactoring:
  • [x] Generic Refactoring (refactoring.nvim)
  • [x] Smart Inline Actions (DEMO) (tree-sitter) (ts-node-action) (native)
  • [x] Custom Code Actions (ts-node-action)
  • [x] C++ native refactoring (nvim-treesitter-cpp-tools)
  • [x] Snippet Engine (DEMO) (LuaSnip)
  • [x] AI:
  • [x] Github Copilot (copilot.lua)
  • [x] AI Assistant (DEMO) (sg.nvim)
  • [x] Multi-backend LLM Integration (llm.nvim)

• [x] UI:
  • [x] Beautiful Neovim UI Wrapper (dressing.nvim)
  • [x] Code MiniMap (codewindow.nvim)
  • [x] Twilight Mode (DEMO) (twilight.nvim)
  • [x] Mode Indicator Line Number (modicator.nvim)
  • [x] Zen Mode (zen-mode.nvim)
  • [x] Narrow Mode (true-zen.nvim)
  • [x] Focus Mode (true-zen.nvim)
  • [x] Minimalist Mode (true-zen.nvim)
  • [x] Atarix Mode (true-zen.nvim)
  • [x] Goyo Mode (goyo.nvim)
  • [x] Smart Column (smartcolumn.nvim)

Installation

[!TODO]: Make INSTALL Script more interactive

git clone https://github.com/NvChad/starter ~/.config/nvim 
git clone https://github.com/UTFeight/vimacs
cd vimacs && mv custom ~/.config/nvim/lua/custom
cd .. && rm -rf vimacs 
# Migration script for latest NvChad (custom folder not supported)
# Check https://nvchad.com/news/v2.5_release for details
git clone https://gist.github.com/048bed2e7570569e6b327b35d1715404.git upgradeNvChad2.5
cd upgradeNvChad2.5 && chmod +x migrate.sh && ./migrate.sh
cd .. && rm -rf upgradeNvChad2.5

1. Neotest:

• Rust:

  cargo install cargo-nextest

2. Debugger:

   # This is for unexpected scenarios only.
   # In general mason should install these X-platform
   
   #                  config.fish                  #
   #               Vimacs Mason PATH               #
   export PATH="$HOME/.local/share/nvim/mason/bin"

   Vimacs ships with default python, C/C++ and Rust debuggers. If you have any other to configure please look into custom/plugins.lua "nvim-dap" and custom/configs/nvim-dap.lua

3. Project Surfing:

[!Warning] This feature requires a base_dirs variable in custom/plugins.lua as in telescope-project.nvim

4. Github Copilot

   • Github Copilot is a paid program that suggests code when you are typing. You need to authorize by using:

   :Copilot auth

5. Null-ls

   yay -S codespell textlint markdownlint stylua ruff

6. LeetCode:

   • Must-do

7. Email Client:

   • Gmail:

     [!IMPORTANT] You need Two factor authentication enabled!

   Then follow the instructions from this site.

8. Markdown-maps:

   yarn is required for markmap.nvim plugin

   yay -S yarn # AUR

TroubleShooting

Tree-Sitter

There is a bug in ts config which causes the tree-sitter to not install bash, org, python parsers.

run the following command to fix it:

:TSInstall bash org python

In some markdown files bash scripts will give not found (@heredoc_blabla) like chunky errors which you need to install bash parser like above

Credits

• Thank you siduck for creating the wonderful neovim UI NvChad
• Thank you folke for creating the excellent plugin manager, lazy.nvim
• Thank you sourcegraph team for the amazing cody AI
• Thank you all the plugin authors
• Thank you neovim dev team

Terms of usage

Discordo

Automated user accounts or "self-bots" are against Discord's Terms of Service. I am not responsible for any loss caused by using "self-bots" or Discordo.

(See Discordo)