diff --git a/.gitignore b/.gitignore index a52bd495579..443b736ca01 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,10 @@ spell/ # nvim-pack-lock.json in version control - see :help vim.pack-lockfile # For the official `nvim-lua/kickstart.nvim` git repository, we leave it ignored to avoid unneeded # merge conflicts. -nvim-pack-lock.json +# nvim-pack-lock.json .DS_Store + +# Per-machine local overrides β€” each machine maintains its own copy, never committed. +# See lua/local.lua.example for available options. +lua/local.lua diff --git a/README.md b/README.md index 7c62e907134..863a312887c 100644 --- a/README.md +++ b/README.md @@ -1,345 +1,150 @@ -# kickstart.nvim +# 🌌 Whipsmart.nvim -## Introduction +Whipsmart.nvim is a modular, native-first Neovim configuration built on top of the Neovim 0.12+ `vim.pack` system. It evolved from [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) into a modular, machine-aware "Grand Unified" configuration. -A starting point for Neovim that is: +## ✨ Features -* Small -* Single-file -* Completely Documented +- **Modular Architecture**: Plugin configurations are isolated in `lua/plugins/*.lua`. +- **Native-First**: Leverages Neovim 0.12's built-in `vim.pack` for plugin management and native LSP/Autocomplete improvements. +- **Ergonomic Dashboard**: Includes `pack-manager.nvim` to provide a polished, Lazy-like UI on top of native primitives. +- **Machine Awareness**: Built-in hostname detection in `init.lua` for machine-specific overrides. +- **Version Pinning**: Uses `nvim-pack-lock.json` for reproducible environments across all your hardware. -**NOT** a Neovim distribution, but instead a starting point for your configuration. +## πŸš€ Quick Start -## Installation +### 1. Prerequisites -### Install Neovim +Ensure you are running **Neovim 0.12+** (nightly or latest stable). You will also need: +- `git`, `make`, `unzip`, `gcc` +- [ripgrep](https://github.com/BurntSushi/ripgrep) and [fd](https://github.com/sharkdp/fd) +- A [Nerd Font](https://www.nerdfonts.com/) (recommended) -Kickstart.nvim targets *only* the latest -['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest -['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. -If you are experiencing issues, please make sure you have at least the latest -stable version. Most likely, you want to install neovim via a [package -manager](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package). -To check your neovim version, run `nvim --version` and make sure it is not -below the latest -['stable'](https://github.com/neovim/neovim/releases/tag/stable) version. If -your chosen install method only gives you an outdated version of neovim, find -alternative [installation methods below](#alternative-neovim-installation-methods). - -### Install External Dependencies - -External Requirements: -- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`) -- [ripgrep](https://github.com/BurntSushi/ripgrep#installation), - [fd-find](https://github.com/sharkdp/fd#installation) -- [tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/blob/master/crates/cli/README.md#installation) -- Clipboard tool (xclip/xsel/win32yank or other depending on the platform) -- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons - - if you have it set `vim.g.have_nerd_font` in `init.lua` to true -- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji` -- Language Setup: - - If you want to write Typescript, you need `npm` - - If you want to write Golang, you will need `go` - - etc. - -> [!NOTE] -> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes -> and quick install snippets - -### Install Kickstart - -> [!NOTE] -> [Backup](#FAQ) your previous configuration (if any exists) - -Neovim's configurations are located under the following paths, depending on your OS: - -| OS | PATH | -| :- | :--- | -| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` | -| Windows (cmd)| `%localappdata%\nvim\` | -| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` | - -#### Recommended Step - -[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo -so that you have your own copy that you can modify, then install by cloning the -fork to your machine using one of the commands below, depending on your OS. - -> [!NOTE] -> Your fork's URL will be something like this: -> `https://github.com//kickstart.nvim.git` - -You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore` -file too - it's ignored in the kickstart repo to make maintenance easier, but -it's recommended to track it in version control (see `:help vim.pack-lockfile`). - -#### Clone kickstart.nvim - -> [!NOTE] -> If following the recommended step above (i.e., forking the repo), replace -> `nvim-lua` with `` in the commands below - -
Linux and Mac +### 2. Installation ```sh -git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim -``` +# Clone your fork (replace with your GitHub handle) +git clone https://github.com//whipsmart.nvim.git ~/.config/nvim -
- -
Windows - -If you're using `cmd.exe`: - -``` -git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim" -``` - -If you're using `powershell.exe` - -``` -git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim" -``` - -
- -### Post Installation - -Start Neovim - -```sh +# Start Neovim β€” plugins install automatically on first launch nvim ``` -That's it! `vim.pack` will install all the plugins from your config. Use -`:lua vim.pack.update(nil, { offline = true })` to inspect plugin state and -`:lua vim.pack.update()` to fetch updates (`:write` applies updates, `:quit` -cancels them). - -#### Read The Friendly Documentation - -Read through the `init.lua` file in your configuration folder for more -information about extending and exploring Neovim. That also includes -examples of adding popularly requested plugins. - -> [!NOTE] -> For more information about a particular plugin check its repository's documentation. - - -### Getting Started - -[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o) - -### FAQ - -* What should I do if I already have a pre-existing Neovim configuration? - * You should back it up and then delete all associated files. - * This includes your existing init.lua and the Neovim files in `~/.local` - which can be deleted with `rm -rf ~/.local/share/nvim/` -* Can I keep my existing configuration in parallel to kickstart? - * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` - to maintain multiple configurations. For example, you can install the kickstart - configuration in `~/.config/nvim-kickstart` and create an alias: - ``` - alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim' - ``` - When you run Neovim using `nvim-kickstart` alias it will use the alternative - config directory and the matching local directory - `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim - distribution that you would like to try out. -* What if I want to "uninstall" this configuration: - * Remove your config directory and local data directory (for example, - `~/.config/nvim` and `~/.local/share/nvim`). -* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files? - * The main purpose of kickstart is to serve as a teaching tool and a reference - configuration that someone can easily use to `git clone` as a basis for their own. - As you progress in learning Neovim and Lua, you might consider splitting `init.lua` - into smaller parts. A fork of kickstart that does this while maintaining the - same functionality is available here: - * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim) - * Discussions on this topic can be found here: - * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218) - * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473) - -### Install Recipes - -Below you can find OS specific install instructions for Neovim and dependencies. +On first launch, Mason will install the default LSP servers and formatters. Once complete, verify your environment: -After installing all the dependencies continue with the [Install Kickstart](#install-kickstart) step. - -#### Windows Installation - -
Windows with Microsoft C++ Build Tools and CMake -Kickstart's default config is make-only for `telescope-fzf-native.nvim`. -If `make` is unavailable, the plugin is skipped. - -Recommended: install `make` (see the chocolatey section below). - -If you want a CMake-only setup, customize `init.lua` in two places: - -1. Include `telescope-fzf-native.nvim` when `cmake` is available: - -```lua -if vim.fn.executable 'make' == 1 or vim.fn.executable 'cmake' == 1 then - table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') -end +```vim +:checkhealth whipsmart ``` -2. In the `PackChanged` hook, use CMake when `make` is unavailable: +### 3. Register Your Machine + +Open `init.lua` and add a branch for your hostname in the **Machine Specific Setup** block: ```lua -if name == 'telescope-fzf-native.nvim' then - if vim.fn.executable 'make' == 1 then - run_build(name, { 'make' }, ev.data.path) - elseif vim.fn.executable 'cmake' == 1 then - run_build(name, { 'cmake', '-S.', '-Bbuild', '-DCMAKE_BUILD_TYPE=Release' }, ev.data.path) - run_build(name, { 'cmake', '--build', 'build', '--config', 'Release', '--target', 'install' }, ev.data.path) - end - return +local hostname = vim.uv.os_gethostname() +if hostname == 'vera' then + -- existing machine +elseif hostname == 'your-hostname' then + -- machine-specific overrides (font size, LSP servers, etc.) end ``` -See `telescope-fzf-native` documentation for [build details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation). -
-
Windows with gcc/make using chocolatey -Alternatively, one can install gcc and make which don't require changing the config, -the easiest way is to use choco: +Also add the machine to the list in `UNIFIED.md` under **Machine Detection**. Then push so the other machines stay in sync. -1. install [chocolatey](https://chocolatey.org/install) -either follow the instructions on the page or use winget, -run in cmd as **admin**: -``` -winget install --accept-source-agreements chocolatey.chocolatey -``` +## πŸ› οΈ Package Management -2. install all requirements using choco, exit the previous cmd and -open a new one so that choco path is set, and run in cmd as **admin**: -``` -choco install -y neovim git ripgrep wget fd unzip gzip mingw make tree-sitter -``` -
-
WSL (Windows Subsystem for Linux) +Whipsmart provides two ways to manage your plugins: -``` -wsl --install -wsl -sudo add-apt-repository ppa:neovim-ppa/unstable -y -sudo apt update -sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim -``` -
+### The "Lazy" Way (High-Level UI) +Press **`pm`** to open the **Package Manager Menu**. This dashboard allows you to: +- Check for updates +- Install new plugins +- Disable/Enable existing plugins +- Clean up unused packages -#### Linux Install -
Ubuntu Install Steps +### The "Native" Way (Low-Level Access) +Whipsmart also exposes the raw `vim.pack` primitives: +- **`ps`**: **Sync** (Triggers `vim.pack.update()` to fetch new metadata). +- **`pi`**: **Inspect** (View current plugin status offline). +- **`:w`**: Inside the update buffer, write to disk to apply changes. -``` -sudo add-apt-repository ppa:neovim-ppa/unstable -y -sudo apt update -sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim -``` -
-
Debian Install Steps +## πŸ—οΈ Project Layout +```text +~/.config/nvim/ +β”œβ”€β”€ init.lua # Core options, keymaps, and plugin loader +β”œβ”€β”€ UNIFIED.md # The Grand Unified roadmap and local instructions +β”œβ”€β”€ nvim-pack-lock.json # Plugin lockfile (Tracked in Git) +└── lua/ + β”œβ”€β”€ plugins/ # Core plugin modules (explicit load order in init.lua) + β”‚ β”œβ”€β”€ pack_manager.lua # pack-manager.nvim UI setup + β”‚ β”œβ”€β”€ core_ui.lua # Which-key, Colorscheme, Oil, Mini.nvim + β”‚ β”œβ”€β”€ telescope.lua # Fuzzy Finding + β”‚ β”œβ”€β”€ lsp.lua # LSP, Mason, and Tooling + β”‚ β”œβ”€β”€ cmp.lua # Autocompletion and Snippets + β”‚ β”œβ”€β”€ treesitter.lua # Syntax Highlighting + β”‚ └── format.lua # Conform.nvim Formatting + β”œβ”€β”€ whipsmart/ # Opt-in extras (not loaded by default) + β”‚ β”œβ”€β”€ health.lua # :checkhealth whipsmart + β”‚ └── plugins/ # autopairs, debug, gitsigns+, indent, lint, neo-tree + └── custom/ + └── plugins/ # Your personal plugins β€” no merge conflicts here ``` -sudo apt update -sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip curl - -# Now we install nvim -curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz -sudo rm -rf /opt/nvim-linux-x86_64 -sudo mkdir -p /opt/nvim-linux-x86_64 -sudo chmod a+rX /opt/nvim-linux-x86_64 -sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz - -# make it available in /usr/local/bin, distro installs to /usr/bin -sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/ -``` -
-
Fedora Install Steps -``` -sudo dnf install -y gcc make git ripgrep fd-find tree-sitter-cli unzip neovim -``` -
+## πŸ’» Customization -
Arch Install Steps +### Adding a Personal Plugin +Drop a `.lua` file in `lua/custom/plugins/` β€” it is loaded automatically on startup and will never conflict with upstream changes. +Example `lua/custom/plugins/harpoon.lua`: +```lua +vim.pack.add { 'https://github.com/ThePrimeagen/harpoon' } +require('harpoon').setup {} ``` -sudo pacman -S --noconfirm --needed gcc make git ripgrep fd tree-sitter-cli unzip neovim -``` -
- -### Alternative neovim installation methods - -For some systems it is not unexpected that the [package manager installation -method](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package) -recommended by neovim is significantly behind. If that is the case for you, -pick one of the following methods that are known to deliver fresh neovim versions very quickly. -They have been picked for their popularity and because they make installing and updating -neovim to the latest versions easy. You can also find more detail about the -available methods being discussed -[here](https://github.com/nvim-lua/kickstart.nvim/issues/1583). - -
Bob +### Adding a Core Plugin +To add a plugin to the core `lua/plugins/` layer, create the file and then register it in the explicit loader list in `init.lua` (Section 2): -[Bob](https://github.com/MordechaiHadad/bob) is a Neovim version manager for -all platforms. Simply install -[rustup](https://rust-lang.github.io/rustup/installation/other.html), -and run the following commands: - -```bash -rustup default stable -rustup update stable -cargo install bob-nvim -bob use stable +```lua +for _, mod in ipairs { + ... + 'plugins.my_new_plugin', -- add here +} do ``` -
- -
Homebrew - -[Homebrew](https://brew.sh) is a package manager popular on Mac and Linux. -Simply install using [`brew install`](https://formulae.brew.sh/formula/neovim). - -
+### Adding LSP Servers +LSP configuration lives in `lua/plugins/lsp.lua` and has two separate lists that must both be updated: -
Flatpak +1. **`servers`** β€” uses **lspconfig names** (passed to `vim.lsp.config` / `vim.lsp.enable`): + ```lua + local servers = { + lua_ls = { ... }, -- lspconfig name + pyright = {}, -- lspconfig name + } + ``` -Flatpak is a package manager for applications that allows developers to package their applications -just once to make it available on all Linux systems. Simply [install flatpak](https://flatpak.org/setup/) -and setup [flathub](https://flathub.org/setup) to [install neovim](https://flathub.org/apps/io.neovim.nvim). +2. **`mason_tools`** β€” uses **Mason registry names** (passed to `mason-tool-installer`): + ```lua + local mason_tools = { + 'lua-language-server', -- Mason name for lua_ls + 'pyright', -- Mason name (happens to match here) + 'stylua', -- formatter, Mason name + } + ``` -
+> **Note:** lspconfig names and Mason names often differ. Look up the correct Mason name at [mason-registry](https://mason-registry.dev/registry/list) and the lspconfig name in the [lspconfig server list](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md). -
asdf and mise-en-place +### Enabling Format-on-Save +In `lua/plugins/format.lua`, add filetypes to `fmt_on_save_fts`: -[asdf](https://asdf-vm.com/) and [mise](https://mise.jdx.dev/) are tool version managers, -mostly aimed towards project-specific tool versioning. However both support managing tools -globally in the user-space as well: - -
mise - -[Install mise](https://mise.jdx.dev/getting-started.html), then run: - -```bash -mise plugins install neovim -mise use neovim@stable -``` - -
- -
asdf - -[Install asdf](https://asdf-vm.com/guide/getting-started.html), then run: - -```bash -asdf plugin add neovim -asdf install neovim stable -asdf set neovim stable --home -asdf reshim neovim +```lua +local fmt_on_save_fts = { + lua = true, + go = true, +} ``` -
+### Machine-Specific Settings +Whipsmart uses hostname detection. Open `init.lua` and locate the **Machine Specific Setup** section to add overrides for your specific hardware. -
+## πŸ“œ Credits +Whipsmart started as a fork of [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim) and maintains its spirit of being a starting point rather than a distribution. diff --git a/UNIFIED.md b/UNIFIED.md new file mode 100644 index 00000000000..8cadf4fcc52 --- /dev/null +++ b/UNIFIED.md @@ -0,0 +1,96 @@ +# 🌌 Whipsmart Neovim (4rc0s/whipsmart.nvim) + +This is the **Grand Unified** Neovim configuration for all my machines, built on the Neovim 0.12+ native `vim.pack` system with a modern modular architecture. + +## πŸš€ Native Package Workflow (0.12+) +We use **`pack-manager.nvim`** for a Lazy-like UI experience: +1. `pm`: Open the **Package Manager Menu**. +2. From the menu, you can Update, Install, or Manage plugins. + +**Low-level access:** +- `ps`: **Sync** (Fetch updates via native `vim.pack.update()`). +- `pi`: **Inspect** (Native offline status). + +## πŸ—οΈ Modular Architecture +Plugin configurations are split into logically organized files in `lua/plugins/`: +- `pack_manager.lua`: The `pack-manager.nvim` UI wrapper. +- `core_ui.lua`: UI enhancements (Colorscheme, Gitsigns, Mini, etc.). +- `telescope.lua`: Fuzzy finding and LSP navigation. +- `lsp.lua`: Language Server Protocol and Mason setup. +- `cmp.lua`: Autocompletion and Snippets. +- `treesitter.lua`: Syntax highlighting and parsing. +- `format.lua`: Auto-formatting via `conform.nvim`. + +Modules are loaded in this explicit order from `init.lua` (Section 2). + +**Opt-in extras** live in `lua/whipsmart/plugins/` and are not loaded by default. +To enable one, require it from a file in `lua/custom/plugins/`: +```lua +-- lua/custom/plugins/debug.lua +require 'whipsmart.plugins.debug' +``` + +Available extras: `autopairs`, `debug` (DAP/Go), `gitsigns` (extended keymaps), +`indent_line`, `lint`, `markdown` (render-markdown + obsidian), `neo-tree`. + +The `markdown` extra reads `vim.g.obsidian_vaults` from `local.lua` to configure +obsidian.nvim; render-markdown loads unconditionally. Example `local.lua` snippet: +```lua +vim.g.obsidian_vaults = { { name = 'personal', path = '~/Obsidian/Main' } } +``` +Then activate in `lua/custom/plugins/markdown.lua`: +```lua +require 'whipsmart.plugins.markdown' +``` + +## πŸ’» Per-Machine Local Config +Each machine maintains a `lua/local.lua` that is **gitignored** and never committed. +`init.lua` loads it at startup via `pcall(require, 'local')` β€” silently skipped if absent. + +Use it for anything machine-specific: font size, colorscheme overrides, GUI settings, +local interpreter paths, or enabling whipsmart opt-in extras only on that machine. + +See `lua/local.lua.example` for a documented template. + +**Setup on a new machine:** +```sh +git clone git@github.com:4rc0s/whipsmart.nvim.git ~/.config/nvim +cp ~/.config/nvim/lua/local.lua.example ~/.config/nvim/lua/local.lua +# Edit lua/local.lua for this machine, then launch nvim +``` + +## πŸ—ΊοΈ The Grand Unified Roadmap +- [x] Rename project to **whipsmart.nvim**. +- [x] Refactor into a modular architecture. +- [x] Install `pack-manager.nvim` for an ergonomic frontend. +- [x] Complete rebrand β€” remove all `kickstart-*` augroup names and namespaces. +- [x] Fix `lua/custom/plugins/` loading (was silently never called). +- [x] Explicit plugin load order in `init.lua`. +- [x] Decouple Mason package names from lspconfig server names. +- [x] Document LSP server setup and opt-in extras workflow. +- [x] Replace hostname detection with gitignored lua/local.lua per-machine overrides. +- [x] Port hecate config: LSP servers, formatters, treesitter parsers, custom plugins. +- [x] Fix `local.lua` load order β€” `pcall(require, 'local')` moved to end of Section 1 so it can override defaults. +- [x] Add markdown opt-in extra (render-markdown, obsidian, blink.compat). +- [x] Migrate roci to whipsmart. +- [ ] Migrate vera and tau to whipsmart (create their lua/local.lua files). +- [ ] Add machine-specific UI toggles for terminal vs. GUI Neovim (via local.lua). +- [ ] Centralize snippet collections. + +## πŸ› οΈ Git Maintenance +- **Origin:** `https://github.com/4rc0s/whipsmart.nvim` + +> This project has diverged significantly from its kickstart.nvim origin in +> architecture and philosophy. Upstream syncing from kickstart.nvim is no +> longer applicable β€” whipsmart.nvim is its own project. + +### Tracking Key Upstream Dependencies + +**`pack-manager.nvim`** (`https://github.com/mplusp/pack-manager.nvim`) is the +UI layer over `vim.pack` and the most architecturally significant third-party +dependency. Watch this repo for new features, API changes, and bug fixes. + +To pick up an improvement: +1. Check the [pack-manager.nvim releases/commits](https://github.com/mplusp/pack-manager.nvim/commits/main) for relevant changes. +2. Run `ps` to pull the latest revision and update `nvim-pack-lock.json`. +3. Commit the updated lockfile to pin the new version. diff --git a/doc/kickstart.txt b/doc/kickstart.txt deleted file mode 100644 index cb87ac3f1de..00000000000 --- a/doc/kickstart.txt +++ /dev/null @@ -1,24 +0,0 @@ -================================================================================ -INTRODUCTION *kickstart.nvim* - -Kickstart.nvim is a project to help you get started on your neovim journey. - - *kickstart-is-not* -It is not: -- Complete framework for every plugin under the sun -- Place to add every plugin that could ever be useful - - *kickstart-is* -It is: -- Somewhere that has a good start for the most common "IDE" type features: - - autocompletion - - goto-definition - - find references - - fuzzy finding - - and hinting at what more can be done :) -- A place to _kickstart_ your journey. - - You should fork this project and use/modify it so that it matches your - style and preferences. If you don't want to do that, there are probably - other projects that would fit much better for you (and that's great!)! - - vim:tw=78:ts=8:ft=help:norl: diff --git a/doc/tags b/doc/tags index 687ae7721d9..f534a6675b7 100644 --- a/doc/tags +++ b/doc/tags @@ -1,3 +1,3 @@ -kickstart-is kickstart.txt /*kickstart-is* -kickstart-is-not kickstart.txt /*kickstart-is-not* -kickstart.nvim kickstart.txt /*kickstart.nvim* +whipsmart-is whipsmart.txt /*whipsmart-is* +whipsmart-is-not whipsmart.txt /*whipsmart-is-not* +whipsmart.nvim whipsmart.txt /*whipsmart.nvim* diff --git a/doc/whipsmart.txt b/doc/whipsmart.txt new file mode 100644 index 00000000000..9a0ce8d2ed3 --- /dev/null +++ b/doc/whipsmart.txt @@ -0,0 +1,26 @@ +================================================================================ +INTRODUCTION *whipsmart.nvim* + +Whipsmart.nvim is a modular, native-first Neovim configuration built on the +Neovim 0.12+ `vim.pack` system. It evolved from kickstart.nvim into a +machine-aware, reproducible starting point. + + *whipsmart-is-not* +It is not: +- A complete framework bundling every plugin under the sun +- A distro you passively consume + + *whipsmart-is* +It is: +- A clean, well-documented foundation with the most common IDE features: + - autocompletion (blink.cmp + LuaSnip) + - LSP with Mason tooling + - goto-definition, references, fuzzy finding (Telescope) + - syntax highlighting (nvim-treesitter) + - git integration (gitsigns) +- A place to build your own config from, with a modular structure you can + extend in lua/custom/plugins/ without merge conflicts. + +Run `:checkhealth whipsmart` to verify your environment is set up correctly. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/init.lua b/init.lua index 5d29c72dc94..23a01db025b 100644 --- a/init.lua +++ b/init.lua @@ -7,7 +7,7 @@ ======== .----------------------. | === | ======== ======== |.-""""""""""""""""""-.| |-----| ======== ======== || || | === | ======== -======== || KICKSTART.NVIM || |-----| ======== +======== || WHIPSMART.NVIM || |-----| ======== ======== || || | === | ======== ======== || || |-----| ======== ======== ||:Tutor || |:::::| ======== @@ -20,68 +20,18 @@ ===================================================================== ===================================================================== -What is Kickstart? +What is Whipsmart? - Kickstart.nvim is *not* a distribution. + Whipsmart.nvim is a modular, native-first Neovim configuration + built on top of the Neovim 0.12+ `vim.pack` system. - Kickstart.nvim is a starting point for your own configuration. - The goal is that you can read every line of code, top-to-bottom, understand - what your configuration is doing, and modify it to suit your needs. + It is designed to be: + - Modular: Plugin configs are split into `lua/plugins/*.lua`. + - Native: Uses built-in `vim.pack` and 0.12+ features. + - Ergonomic: Includes `pack-manager.nvim` for a Lazy-like UI. - Once you've done that, you can start exploring, configuring and tinkering to - make Neovim your own! That might mean leaving Kickstart just the way it is for a while - or immediately breaking it into modular pieces. It's up to you! + See UNIFIED.md for the Grand Unified roadmap and local instructions. - If you don't know anything about Lua, I recommend taking some time to read through - a guide. One possible example which will only take 10-15 minutes: - - https://learnxinyminutes.com/docs/lua/ - - After understanding a bit more about Lua, you can use `:help lua-guide` as a - reference for how Neovim integrates Lua. - - :help lua-guide - - (or HTML version): https://neovim.io/doc/user/lua-guide.html - -Kickstart Guide: - - TODO: The very first thing you should do is to run the command `:Tutor` in Neovim. - - If you don't know what this means, type the following: - - - - : - - Tutor - - - - (If you already know the Neovim basics, you can skip this step.) - - Once you've completed that, you can continue working through **AND READING** the rest - of the kickstart init.lua. - - Next, run AND READ `:help`. - This will open up a help window with some basic information - about reading, navigating and searching the builtin help documentation. - - This should be the first place you go to look when you're stuck or confused - with something. It's one of my favorite Neovim features. - - MOST IMPORTANTLY, we provide a keymap "sh" to [s]earch the [h]elp documentation, - which is very useful when you're not exactly sure of what you're looking for. - - I have left several `:help X` comments throughout the init.lua - These are hints about where to find more information about the relevant settings, - plugins or Neovim features used in Kickstart. - - NOTE: Look for lines like this - - Throughout the file. These are for you, the reader, to help you understand what is happening. - Feel free to delete them once you know what you're doing, but they should serve as a guide - for when you are first encountering a few different constructs in your Neovim config. - -If you experience any errors while trying to install kickstart, run `:checkhealth` for more info. - -I hope you enjoy your Neovim journey, -- TJ - -P.S. You can delete this when you're done too. It's your config now! :) --]] -- ============================================================ @@ -94,200 +44,100 @@ do -- Set as the leader key -- See `:help mapleader` - -- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used) vim.g.mapleader = ' ' vim.g.maplocalleader = ' ' -- Set to true if you have a Nerd Font installed and selected in the terminal - vim.g.have_nerd_font = false + vim.g.have_nerd_font = true -- [[ Setting options ]] -- See `:help vim.o` - -- NOTE: You can change these options as you wish! - -- For more options, you can see `:help option-list` - - -- Make line numbers default vim.o.number = true - -- You can also add relative line numbers, to help with jumping. - -- Experiment for yourself to see if you like it! - -- vim.o.relativenumber = true - - -- Enable mouse mode, can be useful for resizing splits for example! + vim.o.relativenumber = true vim.o.mouse = 'a' - - -- Don't show the mode, since it's already in the status line vim.o.showmode = false - - -- Sync clipboard between OS and Neovim. - -- Schedule the setting after `UiEnter` because it can increase startup-time. - -- Remove this option if you want your OS clipboard to remain independent. - -- See `:help 'clipboard'` vim.schedule(function() vim.o.clipboard = 'unnamedplus' end) - - -- Enable break indent vim.o.breakindent = true - - -- Enable undo/redo changes even after closing and reopening a file vim.o.undofile = true - - -- Case-insensitive searching UNLESS \C or one or more capital letters in the search term vim.o.ignorecase = true vim.o.smartcase = true - - -- Keep signcolumn on by default vim.o.signcolumn = 'yes' - - -- Decrease update time vim.o.updatetime = 250 - - -- Decrease mapped sequence wait time vim.o.timeoutlen = 300 - - -- Configure how new splits should be opened vim.o.splitright = true vim.o.splitbelow = true - - -- Sets how neovim will display certain whitespace characters in the editor. - -- See `:help 'list'` - -- and `:help 'listchars'` - -- - -- Notice listchars is set using `vim.opt` instead of `vim.o`. - -- It is very similar to `vim.o` but offers an interface for conveniently interacting with tables. - -- See `:help lua-options` - -- and `:help lua-guide-options` vim.o.list = true vim.opt.listchars = { tab = 'Β» ', trail = 'Β·', nbsp = '␣' } - - -- Preview substitutions live, as you type! vim.o.inccommand = 'split' - - -- Show which line your cursor is on vim.o.cursorline = true - - -- Minimal number of screen lines to keep above and below the cursor. vim.o.scrolloff = 10 - - -- if performing an operation that would fail due to unsaved changes in the buffer (like `:q`), - -- instead raise a dialog asking if you wish to save the current file(s) - -- See `:help 'confirm'` vim.o.confirm = true + vim.o.colorcolumn = '120' + vim.o.expandtab = false + vim.opt.isfname:append '@-@' -- [[ Basic Keymaps ]] -- See `:help vim.keymap.set()` - - -- Clear highlights on search when pressing in normal mode - -- See `:help hlsearch` vim.keymap.set('n', '', 'nohlsearch') - -- Diagnostic Config & Keymaps - -- See `:help vim.diagnostic.Opts` + -- Diagnostic Config vim.diagnostic.config { update_in_insert = false, severity_sort = true, float = { border = 'rounded', source = 'if_many' }, underline = { severity = { min = vim.diagnostic.severity.WARN } }, - - -- Can switch between these as you prefer - virtual_text = true, -- Text shows up at the end of the line - virtual_lines = false, -- Text shows up underneath the line, with virtual lines - - -- Auto open the float, so you can easily read the errors when jumping with `[d` and `]d` + virtual_text = true, + virtual_lines = false, jump = { on_jump = function(_, bufnr) - vim.diagnostic.open_float { - bufnr = bufnr, - scope = 'cursor', - focus = false, - } + vim.diagnostic.open_float { bufnr = bufnr, scope = 'cursor', focus = false } end, }, } vim.keymap.set('n', 'q', vim.diagnostic.setloclist, { desc = 'Open diagnostic [Q]uickfix list' }) - - -- Exit terminal mode in the builtin terminal with a shortcut that is a bit easier - -- for people to discover. Otherwise, you normally need to press , which - -- is not what someone will guess without a bit more experience. - -- - -- NOTE: This won't work in all terminal emulators/tmux/etc. Try your own mapping - -- or just use to exit terminal mode + vim.keymap.set('n', 'e', vim.diagnostic.open_float, { desc = 'Show diagnostic [E]rror messages' }) + vim.keymap.set('n', '[d', function() vim.diagnostic.jump { count = -1 } end, { desc = 'Go to previous [D]iagnostic' }) + vim.keymap.set('n', ']d', function() vim.diagnostic.jump { count = 1 } end, { desc = 'Go to next [D]iagnostic' }) vim.keymap.set('t', '', '', { desc = 'Exit terminal mode' }) - -- TIP: Disable arrow keys in normal mode - -- vim.keymap.set('n', '', 'echo "Use h to move!!"') - -- vim.keymap.set('n', '', 'echo "Use l to move!!"') - -- vim.keymap.set('n', '', 'echo "Use k to move!!"') - -- vim.keymap.set('n', '', 'echo "Use j to move!!"') - - -- Keybinds to make split navigation easier. - -- Use CTRL+ to switch between windows - -- - -- See `:help wincmd` for a list of all window commands + -- Split navigation vim.keymap.set('n', '', '', { desc = 'Move focus to the left window' }) vim.keymap.set('n', '', '', { desc = 'Move focus to the right window' }) vim.keymap.set('n', '', '', { desc = 'Move focus to the lower window' }) vim.keymap.set('n', '', '', { desc = 'Move focus to the upper window' }) - -- NOTE: Some terminals have colliding keymaps or are not able to send distinct keycodes - -- vim.keymap.set("n", "", "H", { desc = "Move window to the left" }) - -- vim.keymap.set("n", "", "L", { desc = "Move window to the right" }) - -- vim.keymap.set("n", "", "J", { desc = "Move window to the lower" }) - -- vim.keymap.set("n", "", "K", { desc = "Move window to the upper" }) - - -- [[ Basic Autocommands ]] - -- See `:help lua-guide-autocommands` - - -- Highlight when yanking (copying) text - -- Try it with `yap` in normal mode - -- See `:help vim.hl.on_yank()` + -- Highlight when yanking vim.api.nvim_create_autocmd('TextYankPost', { desc = 'Highlight when yanking (copying) text', - group = vim.api.nvim_create_augroup('kickstart-highlight-yank', { clear = true }), + group = vim.api.nvim_create_augroup('whipsmart-highlight-yank', { clear = true }), callback = function() vim.hl.on_yank() end, }) + + -- [[ Machine Specific Setup ]] + -- lua/local.lua is gitignored β€” each machine maintains its own copy. + -- Loaded last so it can override any default set above. + -- See lua/local.lua.example for available options. + pcall(require, 'local') end -- ============================================================ --- SECTION 2: PLUGIN MANAGER INTRO --- vim.pack intro, build hooks +-- SECTION 2: PLUGIN LOADER +-- vim.pack events and modular plugin loading -- ============================================================ do - -- [[ Intro to `vim.pack` ]] - -- `vim.pack` is a new plugin manager built into Neovim, - -- which provides a Lua interface for installing and managing plugins. - -- - -- See `:help vim.pack`, `:help vim.pack-examples` or the - -- excellent blog post from the creator of vim.pack and mini.nvim: - -- https://echasnovski.com/blog/2026-03-13-a-guide-to-vim-pack - -- - -- To inspect plugin state and pending updates, run - -- :lua vim.pack.update(nil, { offline = true }) - -- - -- To update plugins, run - -- :lua vim.pack.update() - -- - -- - -- Throughout the rest of the config there will be examples - -- of how to install and configure plugins using `vim.pack`. - -- - -- In this section we set up some autocommands to run build - -- steps for certain plugins after they are installed or updated. + -- Built-in vim.pack keymaps for low-level access + vim.keymap.set('n', 'ps', vim.pack.update, { desc = '[P]ackage [S]ync' }) + vim.keymap.set('n', 'pi', function() vim.pack.update(nil, { offline = true }) end, { desc = '[P]ackage [I]nspect' }) + -- Build steps logic local function run_build(name, cmd, cwd) local result = vim.system(cmd, { cwd = cwd }):wait() if result.code ~= 0 then - local stderr = result.stderr or '' - local stdout = result.stdout or '' - local output = stderr ~= '' and stderr or stdout - if output == '' then output = 'No output from build command.' end - vim.notify(('Build failed for %s:\n%s'):format(name, output), vim.log.levels.ERROR) + vim.notify(('Build failed for %s:\n%s'):format(name, result.stderr or result.stdout or 'No output'), vim.log.levels.ERROR) end end - -- This autocommand runs after a plugin is installed or updated and - -- runs the appropriate build command for that plugin if necessary. - -- - -- See `:help vim.pack-events` vim.api.nvim_create_autocmd('PackChanged', { callback = function(ev) local name = ev.data.spec.name @@ -296,682 +146,30 @@ do if name == 'telescope-fzf-native.nvim' and vim.fn.executable 'make' == 1 then run_build(name, { 'make' }, ev.data.path) - return - end - - if name == 'LuaSnip' then + elseif name == 'LuaSnip' then if vim.fn.has 'win32' ~= 1 and vim.fn.executable 'make' == 1 then run_build(name, { 'make', 'install_jsregexp' }, ev.data.path) end - return - end - - if name == 'nvim-treesitter' then + elseif name == 'nvim-treesitter' then if not ev.data.active then vim.cmd.packadd 'nvim-treesitter' end vim.cmd 'TSUpdate' - return - end - end, - }) -end - ----Because most plugins are hosted on GitHub, you can use the helper ----function to have less repetition in the following sections. ----@param repo string ----@return string -local function gh(repo) return 'https://github.com/' .. repo end - --- ============================================================ --- SECTION 3: UI / CORE UX PLUGINS --- guess-indent, gitsigns, which-key, colorscheme, todo-comments, mini modules --- ============================================================ -do - -- [[ Installing and Configuring Plugins ]] - -- - -- To install a plugin simply call `vim.pack.add` with its git url. - -- This will download the default branch of the plugin, which will usually be `main` or `master` - -- You can also have more advanced specs, which we will talk about later. - -- - -- For most plugins its not enough to install them, you also need to call their `.setup()` to start them. - -- - -- For example, lets say we want to install `guess-indent.nvim` - a plugin for - -- automatically detecting and setting the indentation. - -- - -- We first install it from https://github.com/NMAC427/guess-indent.nvim - -- and then call its `setup()` function to start it with default settings. - vim.pack.add { gh 'NMAC427/guess-indent.nvim' } - require('guess-indent').setup {} - - -- Because lua is a real programming language, you can also have some logic to your installation - - -- like only installing a plugin if a condition is met. - -- - -- Here we only install `nvim-web-devicons` (which adds pretty icons) if we have a Nerd Font, - -- since otherwise the icons won't display properly. - if vim.g.have_nerd_font then vim.pack.add { gh 'nvim-tree/nvim-web-devicons' } end - - -- Here is a more advanced configuration example that passes options to `gitsigns.nvim` - -- - -- See `:help gitsigns` to understand what each configuration key does. - -- Adds git related signs to the gutter, as well as utilities for managing changes - vim.pack.add { gh 'lewis6991/gitsigns.nvim' } - require('gitsigns').setup { - signs = { - add = { text = '+' }, ---@diagnostic disable-line: missing-fields - change = { text = '~' }, ---@diagnostic disable-line: missing-fields - delete = { text = '_' }, ---@diagnostic disable-line: missing-fields - topdelete = { text = 'β€Ύ' }, ---@diagnostic disable-line: missing-fields - changedelete = { text = '~' }, ---@diagnostic disable-line: missing-fields - }, - } - - -- Useful plugin to show you pending keybinds. - vim.pack.add { gh 'folke/which-key.nvim' } - require('which-key').setup { - -- Delay between pressing a key and opening which-key (milliseconds) - delay = 0, - icons = { mappings = vim.g.have_nerd_font }, - -- Document existing key chains - spec = { - { 's', group = '[S]earch', mode = { 'n', 'v' } }, - { 't', group = '[T]oggle' }, - { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first - { 'gr', group = 'LSP Actions', mode = { 'n' } }, - }, - } - - -- [[ Colorscheme ]] - -- You can easily change to a different colorscheme. - -- Change the name of the colorscheme plugin below, and then - -- change the command under that to load whatever the name of that colorscheme is. - -- - -- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. - vim.pack.add { gh 'folke/tokyonight.nvim' } - ---@diagnostic disable-next-line: missing-fields - require('tokyonight').setup { - styles = { - comments = { italic = false }, -- Disable italics in comments - }, - } - - -- Load the colorscheme here. - -- Like many other themes, this one has different styles, and you could load - -- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. - vim.cmd.colorscheme 'tokyonight-night' - - -- Highlight todo, notes, etc in comments - vim.pack.add { gh 'folke/todo-comments.nvim' } - require('todo-comments').setup { signs = false } - - -- [[ mini.nvim ]] - -- A collection of various small independent plugins/modules - vim.pack.add { gh 'nvim-mini/mini.nvim' } - - -- Better Around/Inside textobjects - -- - -- Examples: - -- - va) - [V]isually select [A]round [)]paren - -- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote - -- - ci' - [C]hange [I]nside [']quote - require('mini.ai').setup { - -- NOTE: Avoid conflicts with the built-in incremental selection mappings on Neovim>=0.12 (see `:help treesitter-incremental-selection`) - mappings = { - around_next = 'aa', - inside_next = 'ii', - }, - n_lines = 500, - } - - -- Add/delete/replace surroundings (brackets, quotes, etc.) - -- - -- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren - -- - sd' - [S]urround [D]elete [']quotes - -- - sr)' - [S]urround [R]eplace [)] ['] - require('mini.surround').setup() - - -- Simple and easy statusline. - -- You could remove this setup call if you don't like it, - -- and try some other statusline plugin - local statusline = require 'mini.statusline' - -- Set `use_icons` to true if you have a Nerd Font - statusline.setup { use_icons = vim.g.have_nerd_font } - - -- You can configure sections in the statusline by overriding their - -- default behavior. For example, here we set the section for - -- cursor location to LINE:COLUMN - ---@diagnostic disable-next-line: duplicate-set-field - statusline.section_location = function() return '%2l:%-2v' end - - -- ... and there is more! - -- Check out: https://github.com/nvim-mini/mini.nvim -end - --- ============================================================ --- SECTION 4: SEARCH & NAVIGATION --- Telescope setup, keymaps, LSP picker mappings --- ============================================================ -do - -- [[ Fuzzy Finder (files, lsp, etc) ]] - -- - -- Telescope is a fuzzy finder that comes with a lot of different things that - -- it can fuzzy find! It's more than just a "file finder", it can search - -- many different aspects of Neovim, your workspace, LSP, and more! - -- - -- There are lots of other alternative pickers (like snacks.picker, or fzf-lua) - -- so feel free to experiment and see what you like! - -- - -- The easiest way to use Telescope, is to start by doing something like: - -- :Telescope help_tags - -- - -- After running this command, a window will open up and you're able to - -- type in the prompt window. You'll see a list of `help_tags` options and - -- a corresponding preview of the help. - -- - -- Two important keymaps to use while in Telescope are: - -- - Insert mode: - -- - Normal mode: ? - -- - -- This opens a window that shows you all of the keymaps for the current - -- Telescope picker. This is really useful to discover what Telescope can - -- do as well as how to actually do it! - - ---@type (string|vim.pack.Spec)[] - local telescope_plugins = { - gh 'nvim-lua/plenary.nvim', - gh 'nvim-telescope/telescope.nvim', - gh 'nvim-telescope/telescope-ui-select.nvim', - } - if vim.fn.executable 'make' == 1 then table.insert(telescope_plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end - - -- NOTE: You can install multiple plugins at once - vim.pack.add(telescope_plugins) - - -- See `:help telescope` and `:help telescope.setup()` - require('telescope').setup { - -- You can put your default mappings / updates / etc. in here - -- All the info you're looking for is in `:help telescope.setup()` - -- - -- defaults = { - -- mappings = { - -- i = { [''] = 'to_fuzzy_refine' }, - -- }, - -- }, - -- pickers = {} - extensions = { - ['ui-select'] = { require('telescope.themes').get_dropdown() }, - }, - } - - -- Enable Telescope extensions if they are installed - pcall(require('telescope').load_extension, 'fzf') - pcall(require('telescope').load_extension, 'ui-select') - - -- See `:help telescope.builtin` - local builtin = require 'telescope.builtin' - vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) - vim.keymap.set('n', 'sk', builtin.keymaps, { desc = '[S]earch [K]eymaps' }) - vim.keymap.set('n', 'sf', builtin.find_files, { desc = '[S]earch [F]iles' }) - vim.keymap.set('n', 'ss', builtin.builtin, { desc = '[S]earch [S]elect Telescope' }) - vim.keymap.set({ 'n', 'v' }, 'sw', builtin.grep_string, { desc = '[S]earch current [W]ord' }) - vim.keymap.set('n', 'sg', builtin.live_grep, { desc = '[S]earch by [G]rep' }) - vim.keymap.set('n', 'sd', builtin.diagnostics, { desc = '[S]earch [D]iagnostics' }) - vim.keymap.set('n', 'sr', builtin.resume, { desc = '[S]earch [R]esume' }) - vim.keymap.set('n', 's.', builtin.oldfiles, { desc = '[S]earch Recent Files ("." for repeat)' }) - vim.keymap.set('n', 'sc', builtin.commands, { desc = '[S]earch [C]ommands' }) - vim.keymap.set('n', '', builtin.buffers, { desc = '[ ] Find existing buffers' }) - - -- Add Telescope-based LSP pickers when an LSP attaches to a buffer. - -- If you later switch picker plugins, this is where to update these mappings. - vim.api.nvim_create_autocmd('LspAttach', { - group = vim.api.nvim_create_augroup('telescope-lsp-attach', { clear = true }), - callback = function(event) - local buf = event.buf - - -- Find references for the word under your cursor. - vim.keymap.set('n', 'grr', builtin.lsp_references, { buffer = buf, desc = '[G]oto [R]eferences' }) - - -- Jump to the implementation of the word under your cursor. - -- Useful when your language has ways of declaring types without an actual implementation. - vim.keymap.set('n', 'gri', builtin.lsp_implementations, { buffer = buf, desc = '[G]oto [I]mplementation' }) - - -- Jump to the definition of the word under your cursor. - -- This is where a variable was first declared, or where a function is defined, etc. - -- To jump back, press . - vim.keymap.set('n', 'grd', builtin.lsp_definitions, { buffer = buf, desc = '[G]oto [D]efinition' }) - - -- Fuzzy find all the symbols in your current document. - -- Symbols are things like variables, functions, types, etc. - vim.keymap.set('n', 'gO', builtin.lsp_document_symbols, { buffer = buf, desc = 'Open Document Symbols' }) - - -- Fuzzy find all the symbols in your current workspace. - -- Similar to document symbols, except searches over your entire project. - vim.keymap.set('n', 'gW', builtin.lsp_dynamic_workspace_symbols, { buffer = buf, desc = 'Open Workspace Symbols' }) - - -- Jump to the type of the word under your cursor. - -- Useful when you're not sure what type a variable is and you want to see - -- the definition of its *type*, not where it was *defined*. - vim.keymap.set('n', 'grt', builtin.lsp_type_definitions, { buffer = buf, desc = '[G]oto [T]ype Definition' }) - end, - }) - - -- Override default behavior and theme when searching - vim.keymap.set('n', '/', function() - -- You can pass additional configuration to Telescope to change the theme, layout, etc. - builtin.current_buffer_fuzzy_find(require('telescope.themes').get_dropdown { - winblend = 10, - previewer = false, - }) - end, { desc = '[/] Fuzzily search in current buffer' }) - - -- It's also possible to pass additional configuration options. - -- See `:help telescope.builtin.live_grep()` for information about particular keys - vim.keymap.set( - 'n', - 's/', - function() - builtin.live_grep { - grep_open_files = true, - prompt_title = 'Live Grep in Open Files', - } - end, - { desc = '[S]earch [/] in Open Files' } - ) - - -- Shortcut for searching your Neovim configuration files - vim.keymap.set('n', 'sn', function() builtin.find_files { cwd = vim.fn.stdpath 'config' } end, { desc = '[S]earch [N]eovim files' }) -end - --- ============================================================ --- SECTION 5: LSP --- LSP keymaps, server configuration, Mason tools installations --- ============================================================ -do - -- [[ LSP Configuration ]] - -- Brief aside: **What is LSP?** - -- - -- LSP is an initialism you've probably heard, but might not understand what it is. - -- - -- LSP stands for Language Server Protocol. It's a protocol that helps editors - -- and language tooling communicate in a standardized fashion. - -- - -- In general, you have a "server" which is some tool built to understand a particular - -- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers - -- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone - -- processes that communicate with some "client" - in this case, Neovim! - -- - -- LSP provides Neovim with features like: - -- - Go to definition - -- - Find references - -- - Autocompletion - -- - Symbol Search - -- - and more! - -- - -- Thus, Language Servers are external tools that must be installed separately from - -- Neovim. This is where `mason` and related plugins come into play. - -- - -- If you're wondering about lsp vs treesitter, you can check out the wonderfully - -- and elegantly composed help section, `:help lsp-vs-treesitter` - - -- Useful status updates for LSP. - vim.pack.add { gh 'j-hui/fidget.nvim' } - require('fidget').setup {} - - -- This function gets run when an LSP attaches to a particular buffer. - -- That is to say, every time a new file is opened that is associated with - -- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this - -- function will be executed to configure the current buffer - vim.api.nvim_create_autocmd('LspAttach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }), - callback = function(event) - -- NOTE: Remember that Lua is a real programming language, and as such it is possible - -- to define small helper and utility functions so you don't have to repeat yourself. - -- - -- In this case, we create a function that lets us more easily define mappings specific - -- for LSP related items. It sets the mode, buffer and description for us each time. - local map = function(keys, func, desc, mode) - mode = mode or 'n' - vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) - end - - -- Rename the variable under your cursor. - -- Most Language Servers support renaming across files, etc. - map('grn', vim.lsp.buf.rename, '[R]e[n]ame') - - -- Execute a code action, usually your cursor needs to be on top of an error - -- or a suggestion from your LSP for this to activate. - map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) - - -- WARN: This is not Goto Definition, this is Goto Declaration. - -- For example, in C this would take you to the header. - map('grD', vim.lsp.buf.declaration, '[G]oto [D]eclaration') - - -- The following two autocommands are used to highlight references of the - -- word under your cursor when your cursor rests there for a little while. - -- See `:help CursorHold` for information about when this is executed - -- - -- When you move your cursor, the highlights will be cleared (the second autocommand). - local client = vim.lsp.get_client_by_id(event.data.client_id) - if client and client:supports_method('textDocument/documentHighlight', event.buf) then - local highlight_augroup = vim.api.nvim_create_augroup('kickstart-lsp-highlight', { clear = false }) - vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, { - buffer = event.buf, - group = highlight_augroup, - callback = vim.lsp.buf.document_highlight, - }) - - vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { - buffer = event.buf, - group = highlight_augroup, - callback = vim.lsp.buf.clear_references, - }) - - vim.api.nvim_create_autocmd('LspDetach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }), - callback = function(event2) - vim.lsp.buf.clear_references() - vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf } - end, - }) - end - - -- The following code creates a keymap to toggle inlay hints in your - -- code, if the language server you are using supports them - -- - -- This may be unwanted, since they displace some of your code - if client and client:supports_method('textDocument/inlayHint', event.buf) then - map('th', function() vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled { bufnr = event.buf }) end, '[T]oggle Inlay [H]ints') end end, }) - -- Enable the following language servers - -- Feel free to add/remove any LSPs that you want here. They will automatically be installed. - -- See `:help lsp-config` for information about keys and how to configure - ---@type table - local servers = { - -- clangd = {}, - -- gopls = {}, - -- pyright = {}, - -- rust_analyzer = {}, - -- - -- Some languages (like typescript) have entire language plugins that can be useful: - -- https://github.com/pmizio/typescript-tools.nvim - -- - -- But for many setups, the LSP (`ts_ls`) will work just fine - -- ts_ls = {}, - - stylua = {}, -- Used to format Lua code - - -- Special Lua Config, as recommended by neovim help docs - lua_ls = { - on_init = function(client) - client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua) - - if client.workspace_folders then - local path = client.workspace_folders[1].name - if path ~= vim.fn.stdpath 'config' and (vim.uv.fs_stat(path .. '/.luarc.json') or vim.uv.fs_stat(path .. '/.luarc.jsonc')) then return end - end - - client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, { - runtime = { - version = 'LuaJIT', - path = { 'lua/?.lua', 'lua/?/init.lua' }, - }, - workspace = { - checkThirdParty = false, - -- NOTE: this is a lot slower and will cause issues when working on your own configuration. - -- See https://github.com/neovim/nvim-lspconfig/issues/3189 - library = vim.tbl_extend('force', vim.api.nvim_get_runtime_file('', true), { - '${3rd}/luv/library', - '${3rd}/busted/library', - }), - }, - }) - end, - ---@type lspconfig.settings.lua_ls - settings = { - Lua = { - format = { enable = false }, -- Disable formatting (formatting is done by stylua) - }, - }, - }, - } - - vim.pack.add { - gh 'neovim/nvim-lspconfig', - gh 'mason-org/mason.nvim', - gh 'mason-org/mason-lspconfig.nvim', - gh 'WhoIsSethDaniel/mason-tool-installer.nvim', - } - - -- Automatically install LSPs and related tools to stdpath for Neovim - require('mason').setup {} - - -- Ensure the servers and tools above are installed - -- - -- To check the current status of installed tools and/or manually install - -- other tools, you can run - -- :Mason - -- - -- You can press `g?` for help in this menu. - local ensure_installed = vim.tbl_keys(servers or {}) - vim.list_extend(ensure_installed, { - -- You can add other tools here that you want Mason to install - }) - - require('mason-tool-installer').setup { ensure_installed = ensure_installed } - - for name, server in pairs(servers) do - vim.lsp.config(name, server) - vim.lsp.enable(name) - end -end - --- ============================================================ --- SECTION 6: FORMATTING --- conform.nvim setup and keymap --- ============================================================ -do - -- [[ Formatting ]] - vim.pack.add { gh 'stevearc/conform.nvim' } - require('conform').setup { - notify_on_error = false, - format_on_save = function(bufnr) - -- You can specify filetypes to autoformat on save here: - local enabled_filetypes = { - -- lua = true, - -- python = true, - } - if enabled_filetypes[vim.bo[bufnr].filetype] then - return { timeout_ms = 500 } - else - return nil - end - end, - default_format_opts = { - lsp_format = 'fallback', -- Use external formatters if configured below, otherwise use LSP formatting. Set to `false` to disable LSP formatting entirely. - }, - -- You can also specify external formatters in here. - formatters_by_ft = { - -- rust = { 'rustfmt' }, - -- Conform can also run multiple formatters sequentially - -- python = { "isort", "black" }, - -- - -- You can use 'stop_after_first' to run the first available formatter from the list - -- javascript = { "prettierd", "prettier", stop_after_first = true }, - }, - } - - vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) -end - --- ============================================================ --- SECTION 7: AUTOCOMPLETE & SNIPPETS --- blink.cmp and luasnip setup --- ============================================================ -do - -- [[ Snippet Engine ]] - - -- NOTE: You can also specify plugin using a version range for its git tag. - -- See `:help vim.version.range()` for more info - vim.pack.add { { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' } } - require('luasnip').setup {} - - -- `friendly-snippets` contains a variety of premade snippets. - -- See the README about individual language/framework/plugin snippets: - -- https://github.com/rafamadriz/friendly-snippets - -- - -- vim.pack.add { gh 'rafamadriz/friendly-snippets' } - -- require('luasnip.loaders.from_vscode').lazy_load() - - -- [[ Autocomplete Engine ]] - vim.pack.add { { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' } } - require('blink.cmp').setup { - keymap = { - -- 'default' (recommended) for mappings similar to built-in completions - -- to accept ([y]es) the completion. - -- This will auto-import if your LSP supports it. - -- This will expand snippets if the LSP sent a snippet. - -- 'super-tab' for tab to accept - -- 'enter' for enter to accept - -- 'none' for no mappings - -- - -- For an understanding of why the 'default' preset is recommended, - -- you will need to read `:help ins-completion` - -- - -- No, but seriously. Please read `:help ins-completion`, it is really good! - -- - -- All presets have the following mappings: - -- /: move to right/left of your snippet expansion - -- : Open menu or open docs if already open - -- / or /: Select next/previous item - -- : Hide menu - -- : Toggle signature help - -- - -- See `:help blink-cmp-config-keymap` for defining your own keymap - preset = 'default', - - -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: - -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps - }, - - appearance = { - -- 'mono' (default) for 'Nerd Font Mono' or 'normal' for 'Nerd Font' - -- Adjusts spacing to ensure icons are aligned - nerd_font_variant = 'mono', - }, - - completion = { - -- By default, you may press `` to show the documentation. - -- Optionally, set `auto_show = true` to show the documentation after a delay. - documentation = { auto_show = false, auto_show_delay_ms = 500 }, - }, - - sources = { - default = { 'lsp', 'path', 'snippets' }, - }, - - snippets = { preset = 'luasnip' }, - - -- Blink.cmp includes an optional, recommended rust fuzzy matcher, - -- which automatically downloads a prebuilt binary when enabled. - -- - -- By default, we use the Lua implementation instead, but you may enable - -- the rust implementation via `'prefer_rust_with_warning'` - -- - -- See `:help blink-cmp-config-fuzzy` for more information - fuzzy = { implementation = 'lua' }, - - -- Shows a signature help window while you type arguments for a function - signature = { enabled = true }, - } -end - --- ============================================================ --- SECTION 8: TREESITTER --- Parser installation, syntax highlighting, folds, indentation --- ============================================================ -do - -- [[ Configure Treesitter ]] - -- Used to highlight, edit, and navigate code - -- - -- See `:help nvim-treesitter-intro` - - -- NOTE: You can also specify a branch or a specific commit - vim.pack.add { { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' } } - - -- Ensure basic parsers are installed - local parsers = { 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc' } - require('nvim-treesitter').install(parsers) - - ---@param buf integer - ---@param language string - local function treesitter_try_attach(buf, language) - -- Check if a parser exists and load it - if not vim.treesitter.language.add(language) then return end - -- Enable syntax highlighting and other treesitter features - vim.treesitter.start(buf, language) - - -- Enable treesitter based folds - -- For more info on folds see `:help folds` - -- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()' - -- vim.wo.foldmethod = 'expr' - - -- Check if treesitter indentation is available for this language, and if so enable it - -- in case there is no indent query, the indentexpr will fallback to the vim's built in one - local has_indent_query = vim.treesitter.query.get(language, 'indents') ~= nil - - -- Enable treesitter based indentation - if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end + -- Load plugin modules in explicit order + for _, mod in ipairs { + 'plugins.pack_manager', + 'plugins.core_ui', + 'plugins.telescope', + 'plugins.lsp', + 'plugins.cmp', + 'plugins.treesitter', + 'plugins.format', + } do + require(mod) end - local available_parsers = require('nvim-treesitter').get_available() - vim.api.nvim_create_autocmd('FileType', { - callback = function(args) - local buf, filetype = args.buf, args.match - - local language = vim.treesitter.language.get_lang(filetype) - if not language then return end - - local installed_parsers = require('nvim-treesitter').get_installed 'parsers' - - if vim.tbl_contains(installed_parsers, language) then - -- Enable the parser if it is already installed - treesitter_try_attach(buf, language) - elseif vim.tbl_contains(available_parsers, language) then - -- If a parser is available in `nvim-treesitter`, auto-install it and enable it after the installation is done - require('nvim-treesitter').install(language):await(function() treesitter_try_attach(buf, language) end) - else - -- Try to enable treesitter features in case the parser exists but is not available from `nvim-treesitter` - treesitter_try_attach(buf, language) - end - end, - }) -end - --- ============================================================ --- SECTION 9: OPTIONAL EXAMPLES / NEXT STEPS --- kickstart.plugins.* examples --- ============================================================ -do - -- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the - -- init.lua. If you want these files, they are in the repository, so you can just download them and - -- place them in the correct locations. - - -- NOTE: Next step on your Neovim journey: Add/Configure additional plugins for Kickstart - -- - -- Here are some example plugins that I've included in the Kickstart repository. - -- Uncomment any of the lines below to enable them (you will need to restart nvim). - -- - -- require 'kickstart.plugins.debug' - -- require 'kickstart.plugins.indent_line' - -- require 'kickstart.plugins.lint' - -- require 'kickstart.plugins.autopairs' - -- require 'kickstart.plugins.neo-tree' - -- require 'kickstart.plugins.gitsigns' -- adds gitsigns recommended keymaps - - -- NOTE: You can add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` - -- - -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. - -- require 'custom.plugins' + -- Load user custom plugins from lua/custom/plugins/ + require 'custom.plugins' end --- The line beneath this is called `modeline`. See `:help modeline` -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/custom/plugins/gitsigns.lua b/lua/custom/plugins/gitsigns.lua new file mode 100644 index 00000000000..c6ff4061166 --- /dev/null +++ b/lua/custom/plugins/gitsigns.lua @@ -0,0 +1,2 @@ +-- Enable extended gitsigns keymaps (hunk navigation, stage/reset, blame, diff, text object) +require 'whipsmart.plugins.gitsigns' diff --git a/lua/custom/plugins/init.lua b/lua/custom/plugins/init.lua index c05db465ea5..4b3701b5ed2 100644 --- a/lua/custom/plugins/init.lua +++ b/lua/custom/plugins/init.lua @@ -1,7 +1,7 @@ -- You can add your own plugins here or in other files in this directory! -- I promise not to create any merge conflicts in this directory :) -- --- See the kickstart.nvim README for more information +-- See the whipsmart.nvim README for more information -- Iterate over all Lua files in the plugins directory and load them local plugins_dir = vim.fs.joinpath(vim.fn.stdpath 'config', 'lua', 'custom', 'plugins') diff --git a/lua/custom/plugins/rust.lua b/lua/custom/plugins/rust.lua new file mode 100644 index 00000000000..0398975c523 --- /dev/null +++ b/lua/custom/plugins/rust.lua @@ -0,0 +1,2 @@ +-- Rust: rustaceanvim manages rust-analyzer (installed by Mason via lsp.lua) +vim.pack.add { { src = 'https://github.com/mrcjkb/rustaceanvim', version = vim.version.range '^6' } } diff --git a/lua/custom/plugins/trouble.lua b/lua/custom/plugins/trouble.lua new file mode 100644 index 00000000000..fe22fc4b4fb --- /dev/null +++ b/lua/custom/plugins/trouble.lua @@ -0,0 +1,9 @@ +vim.pack.add { 'https://github.com/folke/trouble.nvim' } +require('trouble').setup {} + +vim.keymap.set('n', 'xx', 'Trouble diagnostics toggle', { desc = 'Diagnostics (Trouble)' }) +vim.keymap.set('n', 'xX', 'Trouble diagnostics toggle filter.buf=0', { desc = 'Buffer Diagnostics (Trouble)' }) +vim.keymap.set('n', 'cs', 'Trouble symbols toggle focus=false', { desc = 'Symbols (Trouble)' }) +vim.keymap.set('n', 'cl', 'Trouble lsp toggle focus=false win.position=right', { desc = 'LSP Definitions/References (Trouble)' }) +vim.keymap.set('n', 'xL', 'Trouble loclist toggle', { desc = 'Location List (Trouble)' }) +vim.keymap.set('n', 'xQ', 'Trouble qflist toggle', { desc = 'Quickfix List (Trouble)' }) diff --git a/lua/local.lua.example b/lua/local.lua.example new file mode 100644 index 00000000000..2f304b74149 --- /dev/null +++ b/lua/local.lua.example @@ -0,0 +1,25 @@ +-- lua/local.lua β€” machine-specific overrides +-- +-- Copy this file to lua/local.lua on each machine. It is gitignored and +-- never committed, so each machine can have its own version. +-- +-- This file is loaded at startup via pcall(require, 'local') in init.lua. +-- It runs after global options are set, so anything here overrides the defaults. + +-- Example: GUI font (for Neovide, etc.) +-- vim.o.guifont = 'JetBrainsMono Nerd Font:h13' + +-- Example: disable Nerd Font if the terminal doesn't support it +-- vim.g.have_nerd_font = false + +-- Example: machine-specific colorscheme +-- vim.cmd.colorscheme 'catppuccin' + +-- Example: larger scroll offset on a big monitor +-- vim.o.scrolloff = 15 + +-- Example: use a local Python interpreter +-- vim.g.python3_host_prog = '/usr/local/bin/python3' + +-- Example: enable a whipsmart opt-in extra only on this machine +-- require 'whipsmart.plugins.debug' diff --git a/lua/plugins/cmp.lua b/lua/plugins/cmp.lua new file mode 100644 index 00000000000..96e7285d417 --- /dev/null +++ b/lua/plugins/cmp.lua @@ -0,0 +1,20 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- AUTOCOMPLETE & SNIPPETS +-- blink.cmp and luasnip setup +-- ============================================================ + +vim.pack.add { { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' } } +require('luasnip').setup {} + +vim.pack.add { { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' } } +require('blink.cmp').setup { + keymap = { preset = 'default' }, + appearance = { nerd_font_variant = 'mono' }, + completion = { documentation = { auto_show = false, auto_show_delay_ms = 500 } }, + sources = { default = { 'lsp', 'path', 'snippets' } }, + snippets = { preset = 'luasnip' }, + fuzzy = { implementation = 'prefer_rust' }, + signature = { enabled = true }, +} diff --git a/lua/plugins/core_ui.lua b/lua/plugins/core_ui.lua new file mode 100644 index 00000000000..6856fb182e3 --- /dev/null +++ b/lua/plugins/core_ui.lua @@ -0,0 +1,72 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- UI / CORE UX PLUGINS +-- guess-indent, gitsigns, which-key, colorscheme, todo-comments, mini modules +-- ============================================================ + +-- Detect and set indentation +vim.pack.add { gh 'NMAC427/guess-indent.nvim' } +require('guess-indent').setup {} + +-- Pretty icons (if Nerd Font is available) +if vim.g.have_nerd_font then vim.pack.add { gh 'nvim-tree/nvim-web-devicons' } end + +-- Git related signs in the gutter +vim.pack.add { gh 'lewis6991/gitsigns.nvim' } +require('gitsigns').setup { + signs = { + add = { text = '+' }, + change = { text = '~' }, + delete = { text = '_' }, + topdelete = { text = 'β€Ύ' }, + changedelete = { text = '~' }, + }, +} + +-- Keybind popup +vim.pack.add { gh 'folke/which-key.nvim' } +require('which-key').setup { + delay = 0, + icons = { mappings = vim.g.have_nerd_font }, + spec = { + { 's', group = '[S]earch', mode = { 'n', 'v' } }, + { 't', group = '[T]oggle' }, + { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, + { 'gr', group = 'LSP Actions', mode = { 'n' } }, + }, +} + +-- Colorscheme +vim.pack.add { gh 'folke/tokyonight.nvim' } +require('tokyonight').setup { + styles = { + comments = { italic = false }, + }, +} +vim.cmd.colorscheme 'tokyonight-night' + +-- File explorer +vim.pack.add { gh 'stevearc/oil.nvim' } +require('oil').setup { + view_options = { show_hidden = true }, +} +vim.keymap.set('n', '-', 'Oil', { desc = 'Open parent directory' }) + +-- TODO comments +vim.pack.add { gh 'folke/todo-comments.nvim' } +require('todo-comments').setup { signs = false } + +-- mini.nvim modules +vim.pack.add { gh 'nvim-mini/mini.nvim' } +require('mini.ai').setup { + mappings = { + around_next = 'aa', + inside_next = 'ii', + }, + n_lines = 500, +} +require('mini.surround').setup() +local statusline = require 'mini.statusline' +statusline.setup { use_icons = vim.g.have_nerd_font } +statusline.section_location = function() return '%2l:%-2v' end diff --git a/lua/plugins/format.lua b/lua/plugins/format.lua new file mode 100644 index 00000000000..5752d6ccc22 --- /dev/null +++ b/lua/plugins/format.lua @@ -0,0 +1,41 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- FORMATTING +-- conform.nvim setup and keymap +-- ============================================================ + +vim.pack.add { gh 'stevearc/conform.nvim' } + +require('conform').setup { + notify_on_error = false, + format_on_save = { timeout_ms = 500, lsp_format = 'fallback' }, + formatters_by_ft = { + lua = { 'stylua' }, + python = { 'ruff_format', 'ruff_organize_imports' }, + rust = { 'rustfmt' }, + go = { 'goimports', 'gofmt' }, + javascript = { 'prettierd', 'prettier', stop_after_first = true }, + typescript = { 'prettierd', 'prettier', stop_after_first = true }, + javascriptreact = { 'prettierd', 'prettier', stop_after_first = true }, + typescriptreact = { 'prettierd', 'prettier', stop_after_first = true }, + json = { 'prettierd', 'prettier', stop_after_first = true }, + html = { 'prettierd', 'prettier', stop_after_first = true }, + css = { 'prettierd', 'prettier', stop_after_first = true }, + markdown = { 'prettierd', 'prettier', stop_after_first = true }, + yaml = { 'prettierd', 'prettier', stop_after_first = true }, + }, +} + +vim.api.nvim_create_user_command('Format', function(args) + local range = nil + if args.count ~= -1 then + local end_line = vim.api.nvim_buf_get_lines(0, args.line2 - 1, args.line2, true)[1] + range = { start = { args.line1, 0 }, ['end'] = { args.line2, end_line:len() } } + end + require('conform').format { async = true, lsp_format = 'fallback', range = range } +end, { range = true }) + +vim.keymap.set({ 'n', 'v' }, 'cf', function() + require('conform').format { async = false, lsp_format = 'fallback', timeout_ms = 1000 } +end, { desc = '[C]ode [F]ormat file or range' }) diff --git a/lua/plugins/lsp.lua b/lua/plugins/lsp.lua new file mode 100644 index 00000000000..fccad152fef --- /dev/null +++ b/lua/plugins/lsp.lua @@ -0,0 +1,149 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- LSP +-- LSP keymaps, server configuration, Mason tools installations +-- ============================================================ + +vim.pack.add { gh 'j-hui/fidget.nvim' } +require('fidget').setup {} + +vim.api.nvim_create_autocmd('LspAttach', { + group = vim.api.nvim_create_augroup('whipsmart-lsp-attach', { clear = true }), + callback = function(event) + local map = function(keys, func, desc, mode) + mode = mode or 'n' + vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) + end + + map('grn', vim.lsp.buf.rename, '[R]e[n]ame') + map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) + map('grD', vim.lsp.buf.declaration, '[G]oto [D]eclaration') + + local client = vim.lsp.get_client_by_id(event.data.client_id) + if client and client:supports_method('textDocument/documentHighlight', event.buf) then + local highlight_augroup = vim.api.nvim_create_augroup('whipsmart-lsp-highlight', { clear = false }) + vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, { + buffer = event.buf, + group = highlight_augroup, + callback = vim.lsp.buf.document_highlight, + }) + vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { + buffer = event.buf, + group = highlight_augroup, + callback = vim.lsp.buf.clear_references, + }) + vim.api.nvim_create_autocmd('LspDetach', { + group = vim.api.nvim_create_augroup('whipsmart-lsp-detach', { clear = true }), + callback = function(event2) + vim.lsp.buf.clear_references() + vim.api.nvim_clear_autocmds { group = 'whipsmart-lsp-highlight', buffer = event2.buf } + end, + }) + end + + if client and client:supports_method('textDocument/inlayHint', event.buf) then + map('th', function() vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled { bufnr = event.buf }) end, '[T]oggle Inlay [H]ints') + end + end, +}) + +local servers = { + stylua = {}, + lua_ls = { + on_init = function(client) + client.server_capabilities.documentFormattingProvider = false + if client.workspace_folders then + local path = client.workspace_folders[1].name + if path ~= vim.fn.stdpath 'config' and (vim.uv.fs_stat(path .. '/.luarc.json') or vim.uv.fs_stat(path .. '/.luarc.jsonc')) then return end + end + client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, { + runtime = { version = 'LuaJIT', path = { 'lua/?.lua', 'lua/?/init.lua' } }, + workspace = { + checkThirdParty = false, + library = vim.tbl_extend('force', vim.api.nvim_get_runtime_file('', true), { + '${3rd}/luv/library', + '${3rd}/busted/library', + }), + }, + }) + end, + settings = { Lua = { format = { enable = false } } }, + }, + gopls = {}, + basedpyright = { + settings = { + basedpyright = { + analysis = { + autoSearchPaths = true, + useLibraryCodeForTypes = true, + diagnosticMode = 'openFilesOnly', + }, + }, + }, + before_init = function(_, config) + local root_dir = config.root_dir + if root_dir then + local venv_path = root_dir .. '/.venv' + if vim.fn.isdirectory(venv_path) == 1 then + local python_path = venv_path .. '/bin/python' + if vim.fn.filereadable(python_path) == 1 then + config.settings.python = config.settings.python or {} + config.settings.python.pythonPath = python_path + end + end + end + end, + }, + ts_ls = {}, +} + +vim.pack.add { + gh 'neovim/nvim-lspconfig', + gh 'mason-org/mason.nvim', + gh 'WhoIsSethDaniel/mason-tool-installer.nvim', +} + +-- Mason package names (may differ from lspconfig server names, e.g. lua_ls -> lua-language-server) +local mason_tools = { + 'lua-language-server', + 'stylua', + 'gopls', + 'goimports', + 'basedpyright', + 'ruff', + 'typescript-language-server', + 'prettierd', + 'rust-analyzer', -- installed by Mason, managed by rustaceanvim (see custom/plugins/rust.lua) +} + +require('mason').setup {} +require('mason-tool-installer').setup { ensure_installed = mason_tools } + +for name, server in pairs(servers) do + vim.lsp.config(name, server) + vim.lsp.enable(name) +end + +-- System-installed LSPs (not managed by Mason) +if vim.fn.executable 'nimls' == 1 then + vim.lsp.config('nimls', {}) + vim.lsp.enable 'nimls' +end + +if vim.fn.executable 'gleam' == 1 then + vim.lsp.config('gleam', {}) + vim.lsp.enable 'gleam' +end + +-- Gleam indentation +vim.api.nvim_create_autocmd('FileType', { + group = vim.api.nvim_create_augroup('whipsmart-gleam-indent', { clear = true }), + pattern = 'gleam', + callback = function() + vim.bo.shiftwidth = 2 + vim.bo.tabstop = 2 + vim.bo.softtabstop = 2 + vim.bo.expandtab = true + end, +}) diff --git a/lua/plugins/pack_manager.lua b/lua/plugins/pack_manager.lua new file mode 100644 index 00000000000..86d0cfcfb34 --- /dev/null +++ b/lua/plugins/pack_manager.lua @@ -0,0 +1,11 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- PACK-MANAGER.NVIM +-- Lazy-like UI dashboard for vim.pack +-- ============================================================ + +vim.pack.add { gh 'mplusp/pack-manager.nvim' } + +-- Keymap to open the dashboard +vim.keymap.set('n', 'pm', 'PackMenu', { desc = '[P]ackage [M]anager (UI)' }) diff --git a/lua/plugins/telescope.lua b/lua/plugins/telescope.lua new file mode 100644 index 00000000000..1644ad55b1f --- /dev/null +++ b/lua/plugins/telescope.lua @@ -0,0 +1,70 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- SEARCH & NAVIGATION +-- Telescope setup, keymaps, LSP picker mappings +-- ============================================================ + +local telescope_plugins = { + gh 'nvim-lua/plenary.nvim', + gh 'nvim-telescope/telescope.nvim', + gh 'nvim-telescope/telescope-ui-select.nvim', +} +if vim.fn.executable 'make' == 1 then table.insert(telescope_plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end + +vim.pack.add(telescope_plugins) + +require('telescope').setup { + extensions = { + ['ui-select'] = { require('telescope.themes').get_dropdown() }, + }, +} + +pcall(require('telescope').load_extension, 'fzf') +pcall(require('telescope').load_extension, 'ui-select') + +local builtin = require 'telescope.builtin' +vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) +vim.keymap.set('n', 'sk', builtin.keymaps, { desc = '[S]earch [K]eymaps' }) +vim.keymap.set('n', 'sf', builtin.find_files, { desc = '[S]earch [F]iles' }) +vim.keymap.set('n', 'ss', builtin.builtin, { desc = '[S]earch [S]elect Telescope' }) +vim.keymap.set({ 'n', 'v' }, 'sw', builtin.grep_string, { desc = '[S]earch current [W]ord' }) +vim.keymap.set('n', 'sg', builtin.live_grep, { desc = '[S]earch by [G]rep' }) +vim.keymap.set('n', 'sd', builtin.diagnostics, { desc = '[S]earch [D]iagnostics' }) +vim.keymap.set('n', 'sr', builtin.resume, { desc = '[S]earch [R]esume' }) +vim.keymap.set('n', 's.', builtin.oldfiles, { desc = '[S]earch Recent Files ("." for repeat)' }) +vim.keymap.set('n', 'sc', builtin.commands, { desc = '[S]earch [C]ommands' }) +vim.keymap.set('n', '', builtin.buffers, { desc = '[ ] Find existing buffers' }) + +vim.api.nvim_create_autocmd('LspAttach', { + group = vim.api.nvim_create_augroup('whipsmart-telescope-lsp-attach', { clear = true }), + callback = function(event) + local buf = event.buf + vim.keymap.set('n', 'grr', builtin.lsp_references, { buffer = buf, desc = '[G]oto [R]eferences' }) + vim.keymap.set('n', 'gri', builtin.lsp_implementations, { buffer = buf, desc = '[G]oto [I]mplementation' }) + vim.keymap.set('n', 'grd', builtin.lsp_definitions, { buffer = buf, desc = '[G]oto [D]efinition' }) + vim.keymap.set('n', 'gO', builtin.lsp_document_symbols, { buffer = buf, desc = 'Open Document Symbols' }) + vim.keymap.set('n', 'gW', builtin.lsp_dynamic_workspace_symbols, { buffer = buf, desc = 'Open Workspace Symbols' }) + vim.keymap.set('n', 'grt', builtin.lsp_type_definitions, { buffer = buf, desc = '[G]oto [T]ype Definition' }) + end, +}) + +vim.keymap.set('n', '/', function() + builtin.current_buffer_fuzzy_find(require('telescope.themes').get_dropdown { + winblend = 10, + previewer = false, + }) +end, { desc = '[/] Fuzzily search in current buffer' }) + +vim.keymap.set('n', 's/', function() + builtin.live_grep { + grep_open_files = true, + prompt_title = 'Live Grep in Open Files', + } +end, { desc = '[S]earch [/] in Open Files' }) + +vim.keymap.set('n', 'sn', function() builtin.find_files { cwd = vim.fn.stdpath 'config' } end, { desc = '[S]earch [N]eovim files' }) +vim.keymap.set('n', '', builtin.git_files, { desc = 'Search [G]it Files' }) +vim.keymap.set('n', 'pf', function() + builtin.grep_string { search = vim.fn.input 'Grep > ' } +end, { desc = '[P]roject [F]ind (grep with input)' }) diff --git a/lua/plugins/treesitter.lua b/lua/plugins/treesitter.lua new file mode 100644 index 00000000000..6277a15e33d --- /dev/null +++ b/lua/plugins/treesitter.lua @@ -0,0 +1,38 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ============================================================ +-- TREESITTER +-- Parser installation, syntax highlighting, folds, indentation +-- ============================================================ + +vim.pack.add { { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' } } + +local parsers = { + 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc', + 'rust', 'go', 'javascript', 'typescript', 'python', 'json', 'yaml', 'toml', 'gleam', 'nim', +} +require('nvim-treesitter').install(parsers) + +local function treesitter_try_attach(buf, language) + if not vim.treesitter.language.add(language) then return end + vim.treesitter.start(buf, language) + local has_indent_query = vim.treesitter.query.get(language, 'indents') ~= nil + if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end +end + +local available_parsers = require('nvim-treesitter').get_available() +vim.api.nvim_create_autocmd('FileType', { + callback = function(args) + local buf, filetype = args.buf, args.match + local language = vim.treesitter.language.get_lang(filetype) + if not language then return end + local installed_parsers = require('nvim-treesitter').get_installed 'parsers' + if vim.tbl_contains(installed_parsers, language) then + treesitter_try_attach(buf, language) + elseif vim.tbl_contains(available_parsers, language) then + require('nvim-treesitter').install(language):await(function() treesitter_try_attach(buf, language) end) + else + treesitter_try_attach(buf, language) + end + end, +}) diff --git a/lua/kickstart/health.lua b/lua/whipsmart/health.lua similarity index 95% rename from lua/kickstart/health.lua rename to lua/whipsmart/health.lua index 9910238148f..56bb7bb10cf 100644 --- a/lua/kickstart/health.lua +++ b/lua/whipsmart/health.lua @@ -2,6 +2,7 @@ -- -- This file is not required for your own configuration, -- but helps people determine if their system is setup correctly. +-- Run :checkhealth whipsmart to use it. -- --]] @@ -35,7 +36,7 @@ end return { check = function() - vim.health.start 'kickstart.nvim' + vim.health.start 'whipsmart.nvim' vim.health.info [[NOTE: Not every warning is a 'must-fix' in `:checkhealth` diff --git a/lua/kickstart/plugins/autopairs.lua b/lua/whipsmart/plugins/autopairs.lua similarity index 100% rename from lua/kickstart/plugins/autopairs.lua rename to lua/whipsmart/plugins/autopairs.lua diff --git a/lua/kickstart/plugins/debug.lua b/lua/whipsmart/plugins/debug.lua similarity index 100% rename from lua/kickstart/plugins/debug.lua rename to lua/whipsmart/plugins/debug.lua diff --git a/lua/kickstart/plugins/gitsigns.lua b/lua/whipsmart/plugins/gitsigns.lua similarity index 100% rename from lua/kickstart/plugins/gitsigns.lua rename to lua/whipsmart/plugins/gitsigns.lua diff --git a/lua/kickstart/plugins/indent_line.lua b/lua/whipsmart/plugins/indent_line.lua similarity index 100% rename from lua/kickstart/plugins/indent_line.lua rename to lua/whipsmart/plugins/indent_line.lua diff --git a/lua/kickstart/plugins/lint.lua b/lua/whipsmart/plugins/lint.lua similarity index 100% rename from lua/kickstart/plugins/lint.lua rename to lua/whipsmart/plugins/lint.lua diff --git a/lua/whipsmart/plugins/markdown.lua b/lua/whipsmart/plugins/markdown.lua new file mode 100644 index 00000000000..11d042259c4 --- /dev/null +++ b/lua/whipsmart/plugins/markdown.lua @@ -0,0 +1,84 @@ +local function gh(repo) return 'https://github.com/' .. repo end + +-- ── render-markdown (always loaded) ───────────────────────────────────────── +vim.pack.add { + gh 'MeanderingProgrammer/render-markdown.nvim', + gh 'nvim-treesitter/nvim-treesitter', +} + +require('render-markdown').setup { + render_modes = { 'n', 'c' }, + heading = { enabled = true }, + bullet = { enabled = true }, + checkbox = { enabled = true }, + code = { enabled = true }, +} + +vim.api.nvim_create_autocmd('FileType', { + desc = 'Markdown editing options', + group = vim.api.nvim_create_augroup('whipsmart-markdown', { clear = true }), + pattern = 'markdown', + callback = function() + vim.opt_local.wrap = true + vim.opt_local.linebreak = true + vim.opt_local.spell = true + vim.opt_local.spelllang = 'en_us' + vim.opt_local.conceallevel = 2 + end, +}) + +-- ── obsidian (opt-in β€” requires vim.g.obsidian_vaults to be set in local.lua) ─ +-- Example local.lua entry: +-- vim.g.obsidian_vaults = { { name = 'personal', path = '~/Obsidian/Main' } } +if not vim.g.obsidian_vaults then return end + +-- blink.compat must be unversioned (HEAD) β€” released tags lack cmp.get_config() +vim.pack.add { + { src = gh 'epwalsh/obsidian.nvim', version = vim.version.range '*' }, + gh 'nvim-lua/plenary.nvim', + gh 'saghen/blink.compat', +} + +require('blink.compat').setup {} + +require('obsidian').setup { + workspaces = vim.g.obsidian_vaults, + completion = { nvim_cmp = false, min_chars = 2 }, +} + +-- Register obsidian nvim-cmp sources via blink.compat shim +local cmp = require 'cmp' +cmp.register_source('obsidian', require('cmp_obsidian').new()) +cmp.register_source('obsidian_new', require('cmp_obsidian_new').new()) +cmp.register_source('obsidian_tags', require('cmp_obsidian_tags').new()) + +-- Extend blink.cmp config post-setup via the v1 merge_with API. +-- Called from custom/plugins/ (Section 3), so plugins.cmp has already run setup(). +require('blink.cmp.config').merge_with { + completion = { + trigger = { + -- Remove '[' so [[ wikilinks trigger the completion menu + show_on_x_blocked_trigger_characters = { "'", '"', '(', '{' }, + }, + menu = { + -- Suppress auto-popup in markdown/text except when '[' was the trigger + auto_show = function(ctx) + if vim.tbl_contains({ 'markdown', 'text' }, vim.bo.filetype) then + return ctx.trigger.initial_kind == 'trigger_character' + and ctx.trigger.initial_character == '[' + end + return true + end, + }, + }, + sources = { + per_filetype = { + markdown = { 'obsidian', 'obsidian_new', 'obsidian_tags', 'lsp', 'path', 'snippets', 'buffer' }, + }, + providers = { + obsidian = { name = 'obsidian', module = 'blink.compat.source' }, + obsidian_new = { name = 'obsidian_new', module = 'blink.compat.source' }, + obsidian_tags = { name = 'obsidian_tags', module = 'blink.compat.source' }, + }, + }, +} diff --git a/lua/kickstart/plugins/neo-tree.lua b/lua/whipsmart/plugins/neo-tree.lua similarity index 100% rename from lua/kickstart/plugins/neo-tree.lua rename to lua/whipsmart/plugins/neo-tree.lua diff --git a/nvim-pack-lock.json b/nvim-pack-lock.json new file mode 100644 index 00000000000..eec6d6175d8 --- /dev/null +++ b/nvim-pack-lock.json @@ -0,0 +1,104 @@ +{ + "plugins": { + "LuaSnip": { + "rev": "642b0c595e11608b4c18219e93b88d7637af27bc", + "src": "https://github.com/L3MON4D3/LuaSnip", + "version": "2.0.0 - 3.0.0" + }, + "blink.cmp": { + "rev": "78336bc89ee5365633bcf754d93df01678b5c08f", + "src": "https://github.com/saghen/blink.cmp", + "version": "1.0.0 - 2.0.0" + }, + "conform.nvim": { + "rev": "dca1a190aa85f9065979ef35802fb77131911106", + "src": "https://github.com/stevearc/conform.nvim" + }, + "fidget.nvim": { + "rev": "889e2e96edef4e144965571d46f7a77bcc4d0ddf", + "src": "https://github.com/j-hui/fidget.nvim" + }, + "gitsigns.nvim": { + "rev": "dd3f588bacbeb041be6facf1742e42097f62165d", + "src": "https://github.com/lewis6991/gitsigns.nvim" + }, + "guess-indent.nvim": { + "rev": "84a4987ff36798c2fc1169cbaff67960aed9776f", + "src": "https://github.com/NMAC427/guess-indent.nvim" + }, + "mason-lspconfig.nvim": { + "rev": "51feb0ada33d18f3c5c71ffb46005dbf8b33bef4", + "src": "https://github.com/mason-org/mason-lspconfig.nvim" + }, + "mason-tool-installer.nvim": { + "rev": "443f1ef8b5e6bf47045cb2217b6f748a223cf7dc", + "src": "https://github.com/WhoIsSethDaniel/mason-tool-installer.nvim" + }, + "mason.nvim": { + "rev": "e54f5bf5f12c560da31c17eee5b3e1bd369f3ff9", + "src": "https://github.com/mason-org/mason.nvim" + }, + "mini.nvim": { + "rev": "a5fda91040763cf9ad70bdce1c656b0f4ba1d16e", + "src": "https://github.com/nvim-mini/mini.nvim" + }, + "nvim-lspconfig": { + "rev": "451d4ef9abd4f0f08e379ef0d55d1c391b6125a7", + "src": "https://github.com/neovim/nvim-lspconfig" + }, + "nvim-treesitter": { + "rev": "4916d6592ede8c07973490d9322f187e07dfefac", + "src": "https://github.com/nvim-treesitter/nvim-treesitter", + "version": "'main'" + }, + "nvim-web-devicons": { + "rev": "2795c26c916bb3c57dde308b82be51971fa92747", + "src": "https://github.com/nvim-tree/nvim-web-devicons" + }, + "oil.nvim": { + "rev": "0fcc83805ad11cf714a949c98c605ed717e0b83e", + "src": "https://github.com/stevearc/oil.nvim" + }, + "pack-manager.nvim": { + "rev": "e947437ab03c2e20d7eb4e27d1a5f043a9ab1d72", + "src": "https://github.com/mplusp/pack-manager.nvim" + }, + "plenary.nvim": { + "rev": "74b06c6c75e4eeb3108ec01852001636d85a932b", + "src": "https://github.com/nvim-lua/plenary.nvim" + }, + "rustaceanvim": { + "rev": "88575b98bb9937fb9983ddec5e532b67e75ce677", + "src": "https://github.com/mrcjkb/rustaceanvim", + "version": "6.0.0 - 7.0.0" + }, + "telescope-fzf-native.nvim": { + "rev": "b25b749b9db64d375d782094e2b9dce53ad53a40", + "src": "https://github.com/nvim-telescope/telescope-fzf-native.nvim" + }, + "telescope-ui-select.nvim": { + "rev": "6e51d7da30bd139a6950adf2a47fda6df9fa06d2", + "src": "https://github.com/nvim-telescope/telescope-ui-select.nvim" + }, + "telescope.nvim": { + "rev": "f04ab730b8f9c6bf3f54a206d0dcddfd70c52d59", + "src": "https://github.com/nvim-telescope/telescope.nvim" + }, + "todo-comments.nvim": { + "rev": "31e3c38ce9b29781e4422fc0322eb0a21f4e8668", + "src": "https://github.com/folke/todo-comments.nvim" + }, + "tokyonight.nvim": { + "rev": "cdc07ac78467a233fd62c493de29a17e0cf2b2b6", + "src": "https://github.com/folke/tokyonight.nvim" + }, + "trouble.nvim": { + "rev": "bd67efe408d4816e25e8491cc5ad4088e708a69a", + "src": "https://github.com/folke/trouble.nvim" + }, + "which-key.nvim": { + "rev": "3aab2147e74890957785941f0c1ad87d0a44c15a", + "src": "https://github.com/folke/which-key.nvim" + } + } +}