Skip to content

tranlynhathao/nvchad-macos

Repository files navigation

NvChad Neovim configuration


Features

  • features nvchad v2.5
  • target os: wsl2/linux/macos
  • modularised setup of plugins and configurations
  • scripting with bash, lua and toml as smooth as it gets
  • web development with js/ts, react and astro fully covered
  • development with rust, c and go
  • git integrated using neogit, gitsigns, diffview, telescope and vimfugitive
  • markdown preview with live changes in browser
  • round borders as a priority over sharp borders

Warning

Disclaimer: I frequently use git rebase -i to streamline my configuration. if you plan to use lazy-lock.json to stick with certain snapshots of the config, you might have a hard time due to changing commit hashes.


Dependencies

Required:

  • NVIM Stable v0.10.1+ (Nightlies might work)
  • NvChad v2.5
  • Python 3.11.7+ & pip
  • pip: pynvim==0.4.3+
  • Node.js v22+
  • npm: neovim@4.10.1+

Recommended:

  • Cargo 1.74.1+

Checklist

  • Require plugin module
    • officer
    • savior
    • gotest
    • Auto-session
    • nvim-tree-text-objects
  • Fix:
    • Format Rust, Ruby,...
    • Attempt to call local 'module' (a nil value) issue 2
    • Change UI theme issue 3
  • Optimize plugin
  • Rebuild module structure
  • Add LSP
  • Adjust keymaps: abolish

Pre-commit Hooks

This configuration uses pre-commit to automatically lint and format Lua files before committing. Set up once and never worry about code style drift again.

Included Hooks:

  • luacheck: Detects bugs and enforces best practices for Lua
  • stylua: Formats Lua code according to a standard style

Setup

  1. Install pre-commit:

    brew install pre-commit
    # or
    pip install pre-commit
  2. Install hook dependencies:

    brew install luacheck stylua
  3. Set up hooks:

    From the root of the project:

    pre-commit install
    pre-commit run --all-files

Hooks are automatically run on git commit. To manually test, use:

pre-commit run --all-files

About

Configuration appropriate for multilingual and software development

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors