commit a0d2bcdfb09244d0e9a61d73d9c50a9379350bcd Author: Tap Tap Date: Thu Oct 29 11:26:24 2026 +0100 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fdb4ce0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.github +lazy-lock.json +nvim-pack-lock.json diff --git a/.stylua.toml b/.stylua.toml new file mode 100644 index 0000000..edfa506 --- /dev/null +++ b/.stylua.toml @@ -0,0 +1,7 @@ +column_width = 160 +line_endings = "Unix" +indent_type = "Spaces" +indent_width = 2 +quote_style = "AutoPreferSingle" +call_parentheses = "None" +collapse_simple_statement = "Always" diff --git a/README.md b/README.md new file mode 100644 index 0000000..7c62e90 --- /dev/null +++ b/README.md @@ -0,0 +1,345 @@ +# kickstart.nvim + +## Introduction + +A starting point for Neovim that is: + +* Small +* Single-file +* Completely Documented + +**NOT** a Neovim distribution, but instead a starting point for your configuration. + +## Installation + +### Install Neovim + +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 + +```sh +git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.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 +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. + +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 +``` + +2. In the `PackChanged` hook, use CMake when `make` is unavailable: + +```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 +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: + +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 +``` + +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) + +``` +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 +``` +
+ +#### Linux Install +
Ubuntu Install Steps + +``` +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 + +``` +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 +``` +
+ +
Arch Install Steps + +``` +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 + +[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 +``` + +
+ +
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). + +
+ +
Flatpak + +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). + +
+ +
asdf and mise-en-place + +[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 +``` + +
+ +
diff --git a/doc/kickstart.txt b/doc/kickstart.txt new file mode 100644 index 0000000..cb87ac3 --- /dev/null +++ b/doc/kickstart.txt @@ -0,0 +1,24 @@ +================================================================================ +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 new file mode 100644 index 0000000..687ae77 --- /dev/null +++ b/doc/tags @@ -0,0 +1,3 @@ +kickstart-is kickstart.txt /*kickstart-is* +kickstart-is-not kickstart.txt /*kickstart-is-not* +kickstart.nvim kickstart.txt /*kickstart.nvim* diff --git a/init.lua b/init.lua new file mode 100644 index 0000000..2e4e60b --- /dev/null +++ b/init.lua @@ -0,0 +1,112 @@ +--[[ + +===================================================================== +==================== READ THIS BEFORE CONTINUING ==================== +===================================================================== +======== .-----. ======== +======== .----------------------. | === | ======== +======== |.-""""""""""""""""""-.| |-----| ======== +======== || || | === | ======== +======== || KICKSTART.NVIM || |-----| ======== +======== || || | === | ======== +======== || || |-----| ======== +======== ||:Tutor || |:::::| ======== +======== |'-..................-'| |____o| ======== +======== `"")----------------(""` ___________ ======== +======== /::::::::::| |::::::::::\ \ no mouse \ ======== +======== /:::========| |==hjkl==:::\ \ required \ ======== +======== '""""""""""""' '""""""""""""' '""""""""""' ======== +======== ======== +===================================================================== +===================================================================== + +What is Kickstart? + + Kickstart.nvim is *not* a distribution. + + 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. + + 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! + + 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! :) +--]] + +---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 +function gh(repo) return 'https://github.com/' .. repo end +function safe_require(name, setup, callback) + local ok, plugin = pcall(require, name) + if ok then + if type(setup) == 'table' or setup == nil then plugin.setup(setup or {}) end + if type(callback) == 'function' then callback(plugin) end + else + vim.notify('Could not load plugin: ' .. name .. '\nError: ' .. plugin, vim.log.levels.WARN) + end +end + +require 'foundation' + +require 'pack' +require 'ui' +require 'search' +require 'formatting' +require 'autocomplete' +require 'debugging' +require 'lsp' +require 'treesitter' +require 'optional' diff --git a/lua/autocomplete.lua b/lua/autocomplete.lua new file mode 100644 index 0000000..85e5f07 --- /dev/null +++ b/lua/autocomplete.lua @@ -0,0 +1,86 @@ +-- ============================================================ +-- 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.*' } } + safe_require('luasnip', {}, function(luasnip) + luasnip.config.setup { enable_autosnippets = true } + require('luasnip.loaders.from_lua').lazy_load { paths = { '~/.config/nvim/lua/snippets/' } } + end) + + -- `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.lib' } } + vim.pack.add { { src = gh 'saghen/blink.cmp' } } + safe_require('blink.cmp', { + 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 = 'super-tab', + preset = 'enter', + + -- 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 = true, 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 diff --git a/lua/custom/plugins/init.lua b/lua/custom/plugins/init.lua new file mode 100644 index 0000000..c05db46 --- /dev/null +++ b/lua/custom/plugins/init.lua @@ -0,0 +1,13 @@ +-- 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 + +-- 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') +for file_name, type in vim.fs.dir(plugins_dir) do + if type == 'file' and file_name:match '%.lua$' and file_name ~= 'init.lua' then + local module = file_name:gsub('%.lua$', '') + require('custom.plugins.' .. module) + end +end diff --git a/lua/debugging.lua b/lua/debugging.lua new file mode 100644 index 0000000..ac32874 --- /dev/null +++ b/lua/debugging.lua @@ -0,0 +1,165 @@ +do + vim.pack.add { + 'https://github.com/mfussenegger/nvim-dap', + 'https://github.com/rcarriga/nvim-dap-ui', + 'https://github.com/nvim-neotest/nvim-nio', + 'https://github.com/mason-org/mason.nvim', + 'https://github.com/jay-babu/mason-nvim-dap.nvim', + -- 'https://github.com/leoluz/nvim-dap-go', + } + + safe_require('dap', false, function(dap) + -- Basic debugging keymaps, feel free to change to your liking! + vim.keymap.set('n', '', function() dap.continue() end, { desc = 'Debug: Start/Continue' }) + vim.keymap.set('n', '', function() dap.step_into() end, { desc = 'Debug: Step Into' }) + vim.keymap.set('n', '', function() dap.step_over() end, { desc = 'Debug: Step Over' }) + vim.keymap.set('n', '', function() dap.step_out() end, { desc = 'Debug: Step Out' }) + vim.keymap.set('n', 'b', function() dap.toggle_breakpoint() end, { desc = 'Debug: Toggle Breakpoint' }) + vim.keymap.set('n', 'B', function() dap.set_breakpoint(vim.fn.input 'Breakpoint condition: ') end, { desc = 'Debug: Set Breakpoint' }) + + dap.adapters.gdb = { + type = 'executable', + command = 'gdb', + args = { '--interpreter=dap', '--eval-command', 'set print pretty on' }, + } + dap.configurations.c = { + { + name = 'Launch', + type = 'gdb', + request = 'launch', + program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + args = {}, -- provide arguments if needed + cwd = '${workspaceFolder}', + stopAtBeginningOfMainSubprogram = false, + }, + { + name = 'Select and attach to process', + type = 'gdb', + request = 'attach', + program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + pid = function() + local name = vim.fn.input 'Executable name (filter): ' + return require('dap.utils').pick_process { filter = name } + end, + cwd = '${workspaceFolder}', + }, + { + name = 'Attach to gdbserver :1234', + type = 'gdb', + request = 'attach', + target = 'localhost:1234', + program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + cwd = '${workspaceFolder}', + }, + } + + safe_require('dapui', { + -- Dap UI setup + -- For more information, see |:help nvim-dap-ui| + ---@diagnostic disable-next-line: missing-fields + -- Set icons to characters that are more likely to work in every terminal. + -- Feel free to remove or use ones that you like more! :) + -- Don't feel like these are good choices. + icons = { expanded = '▾', collapsed = '▸', current_frame = '*' }, + ---@diagnostic disable-next-line: missing-fields + controls = { + icons = { + pause = '⏸', + play = '▶', + step_into = '⏎', + step_over = '⏭', + step_out = '⏮', + step_back = 'b', + run_last = '▶▶', + terminate = '⏹', + disconnect = '⏏', + }, + }, + }, function(dapui) + -- Toggle to see last session result. Without this, you can't see session output in case of unhandled exception. + vim.keymap.set('n', '', function() dapui.toggle() end, { desc = 'Debug: See last session result.' }) + + dap.listeners.after.event_initialized['dapui_config'] = dapui.open + dap.listeners.before.event_terminated['dapui_config'] = dapui.close + dap.listeners.before.event_exited['dapui_config'] = dapui.close + end) + end) + + safe_require('mason-nvim-dap', { + -- Makes a best effort to setup the various debuggers with + -- reasonable debug configurations + automatic_installation = true, + + -- You can provide additional configuration to the handlers, + -- see mason-nvim-dap README for more information + handlers = {}, + + -- You'll need to check that you have the required things installed + -- online, please don't ask me how to install them :) + ensure_installed = { + -- Update this to ensure that you have the debuggers for the langs you want + 'python', + 'kotlin', + }, + }) + + -- Change breakpoint icons + -- vim.api.nvim_set_hl(0, 'DapBreak', { fg = '#e51400' }) + -- vim.api.nvim_set_hl(0, 'DapStop', { fg = '#ffcc00' }) + -- local breakpoint_icons = vim.g.have_nerd_font + -- and { Breakpoint = '', BreakpointCondition = '', BreakpointRejected = '', LogPoint = '', Stopped = '' } + -- or { Breakpoint = '●', BreakpointCondition = '⊜', BreakpointRejected = '⊘', LogPoint = '◆', Stopped = '⭔' } + -- for type, icon in pairs(breakpoint_icons) do + -- local tp = 'Dap' .. type + -- local hl = (type == 'Stopped') and 'DapStop' or 'DapBreak' + -- vim.fn.sign_define(tp, { text = icon, texthl = hl, numhl = hl }) + -- end + + -- Install golang specific config + -- require('dap-go').setup { + -- delve = { + -- -- On Windows delve must be run attached or it crashes. + -- -- See https://github.com/leoluz/nvim-dap-go/blob/main/README.md#configuring + -- detached = vim.fn.has 'win32' == 0, + -- }, + -- } + + -- vim.pack.add { gh 'mfussenegger/nvim-dap' } + -- safe_require('dap', false, function(dap) + -- dap.adapters.gdb = { + -- type = 'executable', + -- command = 'gdb', + -- args = { '--interpreter=dap', '--eval-command', 'set print pretty on' }, + -- } + -- dap.configurations.c = { + -- { + -- name = 'Launch', + -- type = 'gdb', + -- request = 'launch', + -- program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + -- args = {}, -- provide arguments if needed + -- cwd = '${workspaceFolder}', + -- stopAtBeginningOfMainSubprogram = false, + -- }, + -- { + -- name = 'Select and attach to process', + -- type = 'gdb', + -- request = 'attach', + -- program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + -- pid = function() + -- local name = vim.fn.input 'Executable name (filter): ' + -- return require('dap.utils').pick_process { filter = name } + -- end, + -- cwd = '${workspaceFolder}', + -- }, + -- { + -- name = 'Attach to gdbserver :1234', + -- type = 'gdb', + -- request = 'attach', + -- target = 'localhost:1234', + -- program = function() return vim.fn.input('Path to executable: ', vim.fn.getcwd() .. '/', 'file') end, + -- cwd = '${workspaceFolder}', + -- }, + -- } + -- end) +end diff --git a/lua/formatting.lua b/lua/formatting.lua new file mode 100644 index 0000000..1d2aca4 --- /dev/null +++ b/lua/formatting.lua @@ -0,0 +1,46 @@ +-- ============================================================ +-- SECTION 6: FORMATTING +-- conform.nvim setup and keymap +-- ============================================================ +do + -- [[ Formatting ]] + vim.pack.add { gh 'stevearc/conform.nvim' } + safe_require('conform', { + notify_on_error = true, + format_after_save = { + lsp_fallback = true, + timeout_ms = 500, + }, + -- 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 = { + bash = { 'shfmt' }, + sh = { 'shfmt' }, + zsh = { 'shfmt' }, + python = { 'black', 'isort' }, + lua = { 'stylua' }, + c = { 'clang-format' }, + cpp = { 'clang-format' }, + kotlin = { 'ktfmt' }, + -- + -- You can use 'stop_after_first' to run the first available formatter from the list + -- javascript = { "prettierd", "prettier", stop_after_first = true }, + }, + }, function() + vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) + end) +end diff --git a/lua/foundation.lua b/lua/foundation.lua new file mode 100644 index 0000000..0065a27 --- /dev/null +++ b/lua/foundation.lua @@ -0,0 +1,167 @@ +-- ============================================================ +-- SECTION 1: FOUNDATION +-- Core Neovim settings, leaders, options, basic keymaps, basic autocmds +-- ============================================================ +do + -- Enable faster startup by caching compiled Lua modules + vim.loader.enable() + + -- 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 + + -- [[ 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.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 + + -- [[ Basic Keymaps ]] + -- See `:help vim.keymap.set()` + + vim.keymap.set('n', 'bn', vim.cmd.bnext, { desc = 'Next Buffer' }) + vim.keymap.set('n', 'bp', vim.cmd.bprev, { desc = 'Previous Buffer' }) + + -- vim.keymap.set('n', 'ex', vim.cmd.Ex, { desc = 'Open Explorer' }) + + -- 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` + 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` + jump = { + on_jump = function(_, bufnr) + 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('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 + 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()` + vim.api.nvim_create_autocmd('TextYankPost', { + desc = 'Highlight when yanking (copying) text', + group = vim.api.nvim_create_augroup('kickstart-highlight-yank', { clear = true }), + callback = function() vim.hl.on_yank() end, + }) +end diff --git a/lua/kickstart/health.lua b/lua/kickstart/health.lua new file mode 100644 index 0000000..9910238 --- /dev/null +++ b/lua/kickstart/health.lua @@ -0,0 +1,52 @@ +--[[ +-- +-- This file is not required for your own configuration, +-- but helps people determine if their system is setup correctly. +-- +--]] + +local check_version = function() + local verstr = tostring(vim.version()) + if not vim.version.ge then + vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr)) + return + end + + if vim.version.ge(vim.version(), '0.12') then + vim.health.ok(string.format("Neovim version is: '%s'", verstr)) + else + vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr)) + end +end + +local check_external_reqs = function() + -- Basic utils: `git`, `make`, `unzip` + for _, exe in ipairs { 'git', 'make', 'unzip', 'rg' } do + local is_executable = vim.fn.executable(exe) == 1 + if is_executable then + vim.health.ok(string.format("Found executable: '%s'", exe)) + else + vim.health.warn(string.format("Could not find executable: '%s'", exe)) + end + end + + return true +end + +return { + check = function() + vim.health.start 'kickstart.nvim' + + vim.health.info [[NOTE: Not every warning is a 'must-fix' in `:checkhealth` + + Fix only warnings for plugins and languages you intend to use. + Mason will give warnings for languages that are not installed. + You do not need to install, unless you want to use those languages!]] + + local uv = vim.uv or vim.loop + vim.health.info('System Information: ' .. vim.inspect(uv.os_uname())) + + check_version() + check_external_reqs() + end, +} diff --git a/lua/kickstart/plugins/autopairs.lua b/lua/kickstart/plugins/autopairs.lua new file mode 100644 index 0000000..1d2cdab --- /dev/null +++ b/lua/kickstart/plugins/autopairs.lua @@ -0,0 +1,5 @@ +-- autopairs +-- https://github.com/windwp/nvim-autopairs + +vim.pack.add { 'https://github.com/windwp/nvim-autopairs' } +require('nvim-autopairs').setup {} diff --git a/lua/kickstart/plugins/debug.lua b/lua/kickstart/plugins/debug.lua new file mode 100644 index 0000000..db5448c --- /dev/null +++ b/lua/kickstart/plugins/debug.lua @@ -0,0 +1,95 @@ +-- debug.lua +-- +-- Shows how to use the DAP plugin to debug your code. +-- +-- Primarily focused on configuring the debugger for Go, but can +-- be extended to other languages as well. That's why it's called +-- kickstart.nvim and not kitchen-sink.nvim ;) + +vim.pack.add { + 'https://github.com/mfussenegger/nvim-dap', + 'https://github.com/rcarriga/nvim-dap-ui', + 'https://github.com/nvim-neotest/nvim-nio', + 'https://github.com/mason-org/mason.nvim', + 'https://github.com/jay-babu/mason-nvim-dap.nvim', + 'https://github.com/leoluz/nvim-dap-go', +} + +-- Basic debugging keymaps, feel free to change to your liking! +vim.keymap.set('n', '', function() require('dap').continue() end, { desc = 'Debug: Start/Continue' }) +vim.keymap.set('n', '', function() require('dap').step_into() end, { desc = 'Debug: Step Into' }) +vim.keymap.set('n', '', function() require('dap').step_over() end, { desc = 'Debug: Step Over' }) +vim.keymap.set('n', '', function() require('dap').step_out() end, { desc = 'Debug: Step Out' }) +vim.keymap.set('n', 'b', function() require('dap').toggle_breakpoint() end, { desc = 'Debug: Toggle Breakpoint' }) +vim.keymap.set('n', 'B', function() require('dap').set_breakpoint(vim.fn.input 'Breakpoint condition: ') end, { desc = 'Debug: Set Breakpoint' }) +-- Toggle to see last session result. Without this, you can't see session output in case of unhandled exception. +vim.keymap.set('n', '', function() require('dapui').toggle() end, { desc = 'Debug: See last session result.' }) + +local dap = require 'dap' +local dapui = require 'dapui' + +require('mason-nvim-dap').setup { + -- Makes a best effort to setup the various debuggers with + -- reasonable debug configurations + automatic_installation = true, + + -- You can provide additional configuration to the handlers, + -- see mason-nvim-dap README for more information + handlers = {}, + + -- You'll need to check that you have the required things installed + -- online, please don't ask me how to install them :) + ensure_installed = { + -- Update this to ensure that you have the debuggers for the langs you want + 'delve', + }, +} + +-- Dap UI setup +-- For more information, see |:help nvim-dap-ui| +---@diagnostic disable-next-line: missing-fields +dapui.setup { + -- Set icons to characters that are more likely to work in every terminal. + -- Feel free to remove or use ones that you like more! :) + -- Don't feel like these are good choices. + icons = { expanded = '▾', collapsed = '▸', current_frame = '*' }, + ---@diagnostic disable-next-line: missing-fields + controls = { + icons = { + pause = '⏸', + play = '▶', + step_into = '⏎', + step_over = '⏭', + step_out = '⏮', + step_back = 'b', + run_last = '▶▶', + terminate = '⏹', + disconnect = '⏏', + }, + }, +} + +-- Change breakpoint icons +-- vim.api.nvim_set_hl(0, 'DapBreak', { fg = '#e51400' }) +-- vim.api.nvim_set_hl(0, 'DapStop', { fg = '#ffcc00' }) +-- local breakpoint_icons = vim.g.have_nerd_font +-- and { Breakpoint = '', BreakpointCondition = '', BreakpointRejected = '', LogPoint = '', Stopped = '' } +-- or { Breakpoint = '●', BreakpointCondition = '⊜', BreakpointRejected = '⊘', LogPoint = '◆', Stopped = '⭔' } +-- for type, icon in pairs(breakpoint_icons) do +-- local tp = 'Dap' .. type +-- local hl = (type == 'Stopped') and 'DapStop' or 'DapBreak' +-- vim.fn.sign_define(tp, { text = icon, texthl = hl, numhl = hl }) +-- end + +dap.listeners.after.event_initialized['dapui_config'] = dapui.open +dap.listeners.before.event_terminated['dapui_config'] = dapui.close +dap.listeners.before.event_exited['dapui_config'] = dapui.close + +-- Install golang specific config +require('dap-go').setup { + delve = { + -- On Windows delve must be run attached or it crashes. + -- See https://github.com/leoluz/nvim-dap-go/blob/main/README.md#configuring + detached = vim.fn.has 'win32' == 0, + }, +} diff --git a/lua/kickstart/plugins/gitsigns.lua b/lua/kickstart/plugins/gitsigns.lua new file mode 100644 index 0000000..b7e40a8 --- /dev/null +++ b/lua/kickstart/plugins/gitsigns.lua @@ -0,0 +1,57 @@ +-- Adds git related signs to the gutter, as well as utilities for managing changes +-- NOTE: gitsigns is already included in init.lua but contains only the base +-- config. This will add also the recommended keymaps. + +vim.pack.add { 'https://github.com/lewis6991/gitsigns.nvim' } + +require('gitsigns').setup { + on_attach = function(bufnr) + local gitsigns = require 'gitsigns' + + local function map(mode, l, r, opts) + opts = opts or {} + opts.buffer = bufnr + vim.keymap.set(mode, l, r, opts) + end + + -- Navigation + map('n', ']c', function() + if vim.wo.diff then + vim.cmd.normal { ']c', bang = true } + else + gitsigns.nav_hunk 'next' + end + end, { desc = 'Jump to next git [c]hange' }) + + map('n', '[c', function() + if vim.wo.diff then + vim.cmd.normal { '[c', bang = true } + else + gitsigns.nav_hunk 'prev' + end + end, { desc = 'Jump to previous git [c]hange' }) + + -- Actions + -- visual mode + map('v', 'hs', function() gitsigns.stage_hunk { vim.fn.line '.', vim.fn.line 'v' } end, { desc = 'git [s]tage hunk' }) + map('v', 'hr', function() gitsigns.reset_hunk { vim.fn.line '.', vim.fn.line 'v' } end, { desc = 'git [r]eset hunk' }) + -- normal mode + map('n', 'hs', gitsigns.stage_hunk, { desc = 'git [s]tage hunk' }) + map('n', 'hr', gitsigns.reset_hunk, { desc = 'git [r]eset hunk' }) + map('n', 'hS', gitsigns.stage_buffer, { desc = 'git [S]tage buffer' }) + map('n', 'hR', gitsigns.reset_buffer, { desc = 'git [R]eset buffer' }) + map('n', 'hp', gitsigns.preview_hunk, { desc = 'git [p]review hunk' }) + map('n', 'hi', gitsigns.preview_hunk_inline, { desc = 'git preview hunk [i]nline' }) + map('n', 'hb', function() gitsigns.blame_line { full = true } end, { desc = 'git [b]lame line' }) + map('n', 'hd', gitsigns.diffthis, { desc = 'git [d]iff against index' }) + map('n', 'hD', function() gitsigns.diffthis '@' end, { desc = 'git [D]iff against last commit' }) + map('n', 'hQ', function() gitsigns.setqflist 'all' end, { desc = 'git hunk [Q]uickfix list (all files in repo)' }) + map('n', 'hq', gitsigns.setqflist, { desc = 'git hunk [q]uickfix list (all changes in this file)' }) + -- Toggles + map('n', 'tb', gitsigns.toggle_current_line_blame, { desc = '[T]oggle git show [b]lame line' }) + map('n', 'tw', gitsigns.toggle_word_diff, { desc = '[T]oggle git intra-line [w]ord diff' }) + + -- Text object + map({ 'o', 'x' }, 'ih', gitsigns.select_hunk) + end, +} diff --git a/lua/kickstart/plugins/indent_line.lua b/lua/kickstart/plugins/indent_line.lua new file mode 100644 index 0000000..7187365 --- /dev/null +++ b/lua/kickstart/plugins/indent_line.lua @@ -0,0 +1,6 @@ +-- Add indentation guides even on blank lines + +-- Enable `lukas-reineke/indent-blankline.nvim` +-- See `:help ibl` +vim.pack.add { 'https://github.com/lukas-reineke/indent-blankline.nvim' } +require('ibl').setup {} diff --git a/lua/kickstart/plugins/lint.lua b/lua/kickstart/plugins/lint.lua new file mode 100644 index 0000000..d630544 --- /dev/null +++ b/lua/kickstart/plugins/lint.lua @@ -0,0 +1,53 @@ +-- Linting + +vim.pack.add { 'https://github.com/mfussenegger/nvim-lint' } + +local lint = require 'lint' +lint.linters_by_ft = { + markdown = { 'markdownlint' }, -- Make sure to install `markdownlint` via mason / npm +} + +-- To allow other plugins to add linters to require('lint').linters_by_ft, +-- instead set linters_by_ft like this: +-- lint.linters_by_ft = lint.linters_by_ft or {} +-- lint.linters_by_ft['markdown'] = { 'markdownlint' } +-- +-- However, note that this will enable a set of default linters, +-- which will cause errors unless these tools are available: +-- { +-- clojure = { "clj-kondo" }, +-- dockerfile = { "hadolint" }, +-- inko = { "inko" }, +-- janet = { "janet" }, +-- json = { "jsonlint" }, +-- markdown = { "vale" }, +-- rst = { "vale" }, +-- ruby = { "ruby" }, +-- terraform = { "tflint" }, +-- text = { "vale" } +-- } +-- +-- You can disable the default linters by setting their filetypes to nil: +-- lint.linters_by_ft['clojure'] = nil +-- lint.linters_by_ft['dockerfile'] = nil +-- lint.linters_by_ft['inko'] = nil +-- lint.linters_by_ft['janet'] = nil +-- lint.linters_by_ft['json'] = nil +-- lint.linters_by_ft['markdown'] = nil +-- lint.linters_by_ft['rst'] = nil +-- lint.linters_by_ft['ruby'] = nil +-- lint.linters_by_ft['terraform'] = nil +-- lint.linters_by_ft['text'] = nil + +-- Create autocommand which carries out the actual linting +-- on the specified events. +local lint_augroup = vim.api.nvim_create_augroup('lint', { clear = true }) +vim.api.nvim_create_autocmd({ 'BufEnter', 'BufWritePost', 'InsertLeave' }, { + group = lint_augroup, + callback = function() + -- Only run the linter in buffers that you can modify in order to + -- avoid superfluous noise, notably within the handy LSP pop-ups that + -- describe the hovered symbol using Markdown. + if vim.bo.modifiable then lint.try_lint() end + end, +}) diff --git a/lua/kickstart/plugins/neo-tree.lua b/lua/kickstart/plugins/neo-tree.lua new file mode 100644 index 0000000..d9d6993 --- /dev/null +++ b/lua/kickstart/plugins/neo-tree.lua @@ -0,0 +1,26 @@ +-- Neo-tree is a Neovim plugin to browse the file system +-- https://github.com/nvim-neo-tree/neo-tree.nvim + +local plugins = { + { src = 'https://github.com/nvim-neo-tree/neo-tree.nvim', version = vim.version.range '*' }, + 'https://github.com/nvim-lua/plenary.nvim', + 'https://github.com/MunifTanjim/nui.nvim', +} + +if vim.g.have_nerd_font then + table.insert(plugins, 'https://github.com/nvim-tree/nvim-web-devicons') -- not strictly required, but recommended +end + +vim.pack.add(plugins) + +vim.keymap.set('n', '\\', 'Neotree reveal', { desc = 'NeoTree reveal', silent = true }) + +require('neo-tree').setup { + filesystem = { + window = { + mappings = { + ['\\'] = 'close_window', + }, + }, + }, +} diff --git a/lua/lsp.lua b/lua/lsp.lua new file mode 100644 index 0000000..177d02a --- /dev/null +++ b/lua/lsp.lua @@ -0,0 +1,277 @@ +-- ============================================================ +-- 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' } + safe_require 'fidget' + + -- 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('lr', vim.lsp.buf.rename, '[R]e[n]ame') + map('ld', vim.lsp.buf.definition, '[L]sp goto [D]definition') + map('la', vim.lsp.buf.code_action, '[L]sp goto Code [A]ction', { 'n', 'x' }) + -- Apply all automatic code fixes in the current buffer + map('lA', function() + vim.lsp.buf.code_action { + context = { + only = { 'source.fixAll' }, + diagnostics = {}, + }, + apply = true, + } + end, '[L]sp Fix [A]ll in buffer') + map('lD', vim.lsp.buf.declaration, '[L]sp goto [D]eclaration') + + map('es', vim.diagnostic.open_float, '[E]rror message [S]how') + map('ej', function() vim.diagnostic.jump { count = 1 } end, '[E]rror next') + map('ek', function() vim.diagnostic.jump { count = -1 } end, '[E]rror previous') + + -- 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 + local formatters_and_tools = { + 'clang-format', -- Using the correct hyphen! + 'isort', + 'ktfmt', + 'nixfmt', + 'shfmt', + 'stylua', + 'black', + } + ---@type table + local servers = { + -- json + jsonls = {}, + -- terraform + terraformls = {}, + -- c + clangd = { + cmd = { + 'clangd', + '--background-index', + '--clang-tidy', + '--query-driver=/nix/store/*/bin/*gcc*', + }, + }, + neocmake = {}, + -- nix + nil_ls = {}, + -- python + -- pylsp = { + -- -- plugins = { + -- -- -- formatter options + -- -- black = { enabled = true }, + -- -- autopep8 = { enabled = false }, + -- -- yapf = { enabled = false }, + -- -- -- linter options + -- -- pylint = { enabled = true, executable = 'pylint' }, + -- -- pyflakes = { enabled = false }, + -- -- pycodestyle = { enabled = false }, + -- -- -- type checker + -- -- pylsp_mypy = { enabled = true }, + -- -- -- auto-completion options + -- -- jedi_completion = { fuzzy = true }, + -- -- -- import sorting + -- -- pyls_isort = { enabled = true }, + -- -- }, + -- }, + pyright = {}, + ruff = {}, + isort = {}, + -- kotlin + kotlin_lsp = {}, + -- latex + texlab = {}, + -- bash + bashls = {}, + -- markdown + markdown_oxide = {}, + kakehashi = { + filetypes = { 'markdown' }, + init_options = { + languageServers = { + ['texlab'] = { + cmd = { 'texlab' }, + languages = { 'latex' }, + }, + ['lua_ls'] = { + cmd = { 'lua-language-server' }, + languages = { 'lua' }, + }, + }, + languages = { + _ = { + autoInstall = true, + }, + markdown = { + bridge = { + texlab = { enabled = true }, + lua_ls = { enabled = true }, + }, + }, + }, + }, + }, + + -- 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 = {}, + + -- 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 + safe_require 'mason' + + -- 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, formatters_and_tools) + + safe_require('mason-tool-installer', { ensure_installed = ensure_installed, auto_update = true, run_on_start = true }, function(_) + -- for name in ensure_installed do + -- vim.lsp.enable(name) + -- end + + for name, server in pairs(servers) do + vim.lsp.config(name, server) + vim.lsp.enable(name) + end + end) + + vim.diagnostic.config { update_in_insert = true } +end diff --git a/lua/optional.lua b/lua/optional.lua new file mode 100644 index 0000000..b67c1ca --- /dev/null +++ b/lua/optional.lua @@ -0,0 +1,87 @@ +-- ============================================================ +-- SECTION 9: OPTIONAL EXAMPLES / NEXT STEPS +-- kickstart.plugins.* examples +-- ============================================================ +do + -- IMPORTANT: on first install do the following: + -- cd ~/.local/share/nvim/site/pack/core/opt/markdown-preview.nvim/app + -- yarn install + vim.pack.add { gh 'iamcco/markdown-preview.nvim' } + vim.g.mkdp_auto_start = 0 + vim.g.mkdp_auto_close = 1 + vim.g.mkdp_refresh_slow = 0 + vim.g.mkdp_port = '8080' + vim.g.mkdp_filetypes = { 'markdown' } + vim.g.mkdp_auto_open = 1 + vim.g.mkdp_theme = 'dark' + vim.g.mkdp_enable_mathjax = 1 + + vim.pack.add { gh 'neogitorg/neogit', gh 'sindrets/diffview.nvim', gh 'm00qek/baleia.nvim' } + safe_require('neogit', false, function(_) + vim.keymap.set('n', 'gg', vim.cmd.Neogit, { desc = 'Open Neogit' }) + vim.keymap.set('n', 'gd', ':DiffviewOpen') + vim.keymap.set('n', 'gc', vim.cmd.DiffviewClose) + end) + + vim.pack.add { gh 'windwp/nvim-autopairs' } + safe_require 'nvim-autopairs' + + vim.pack.add { gh 'lukas-reineke/indent-blankline.nvim' } + safe_require 'ibl' + + vim.pack.add { gh 'stevearc/oil.nvim' } + safe_require('oil', { + view_options = { + show_hidden = true, + }, + }, function(oil) + vim.keymap.set('n', 'ex', function() oil.open() end, { desc = 'Open parent directory of current file' }) + vim.keymap.set('n', 'ep', function() oil.open(vim.fn.getcwd()) end, { desc = 'Open oil in project root (CWD)' }) + end) + + -- vim.pack.add { gh 'm4xshen/autoclose.nvim' } + -- safe_require 'autoclose' + + -- require('markdown-preview.nvim').setup {} + -- + -- -- build = "cd app && npm install", + -- -- + -- -- -- Lazy-load the plugin on specific commands or filetypes for speed. + -- -- cmd = { "MarkdownPreviewToggle", "MarkdownPreview", "MarkdownPreviewStop" }, + -- -- ft = { "markdown" }, + -- -- Tell the plugin to activate for markdown files. + -- vim.g.mkdp_filetypes = { 'markdown' } + -- + -- -- Automatically open the preview in the browser. + -- vim.g.mkdp_auto_open = 1 + -- + -- -- Use a dark theme for the preview. + -- vim.g.mkdp_theme = 'dark' + -- + -- -- CRITICAL: This enables LaTeX rendering via MathJax. + -- vim.g.mkdp_enable_mathjax = 1 + + -- 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' +end + +-- The line beneath this is called `modeline`. See `:help modeline` +-- vim: ts=2 sts=2 sw=2 et diff --git a/lua/pack.lua b/lua/pack.lua new file mode 100644 index 0000000..512720a --- /dev/null +++ b/lua/pack.lua @@ -0,0 +1,65 @@ +-- ============================================================ +-- SECTION 2: PLUGIN MANAGER INTRO +-- vim.pack intro, build hooks +-- ============================================================ +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. + + 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) + 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 + local kind = ev.data.kind + if kind ~= 'install' and kind ~= 'update' then return end + + 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 + 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 + if not ev.data.active then vim.cmd.packadd 'nvim-treesitter' end + vim.cmd 'TSUpdate' + return + end + end, + }) +end diff --git a/lua/search.lua b/lua/search.lua new file mode 100644 index 0000000..4fe8bea --- /dev/null +++ b/lua/search.lua @@ -0,0 +1,156 @@ +-- ============================================================ +-- 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()` + local extensions = {} + local ok, themes = pcall(require, 'telescope.themes') + if ok then extensions = { ['ui-select'] = { + themes.get_dropdown(), + } } end + safe_require('telescope', { + -- 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 = extensions, + }, function(telescope) + -- 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 + + vim.keymap.set( + 'n', + 'lf', + function() builtin.lsp_dynamic_workspace_symbols { symbols = { 'Function', 'Method', 'Constructor', 'Operator' } } end, + { desc = 'Find Functions / Methods' } + ) + vim.keymap.set( + 'n', + 'lv', + function() builtin.lsp_dynamic_workspace_symbols { symbols = { 'Variable', 'Field', 'Property', 'Constat' } } end, + { desc = 'Find Variables' } + ) + vim.keymap.set( + 'n', + 'lc', + function() builtin.lsp_dynamic_workspace_symbols { symbols = { 'Class', 'Struct', 'Interface' } } end, + { desc = 'Find Classes' } + ) + + -- 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', 'gll', 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) +end diff --git a/lua/snippets/markdown.lua b/lua/snippets/markdown.lua new file mode 100644 index 0000000..db06472 --- /dev/null +++ b/lua/snippets/markdown.lua @@ -0,0 +1,156 @@ +local ls = require 'luasnip' +local fmta = require('luasnip.extras.fmt').fmta + +local function in_math() + local node = vim.treesitter.get_node() + while node do + if node:type() == 'inline_formula' or node:type() == 'math_environment' then return true end + node = node:parent() + end + return false +end + +local snippets = {} + +local function create_snippet(trig, snip, desc, math) + local snip = snip or '\\' .. trig + snip = snip .. '<>' + local desc = desc or trig + local _, icount = string.gsub(snip, '<>', '') + local is = {} + local condition = {} + if math == nil then condition = { condition = in_math } end + for i = 1, icount - 1 do + table.insert(is, ls.insert_node(i)) + end + table.insert(is, ls.insert_node(0)) + table.insert(snippets, ls.snippet({ trig = trig, snippetType = 'autosnippet', desc = desc }, fmta(snip, is), condition)) +end + +local add = create_snippet + +add('bold', '**<>**', 'bold', false) + +for i = 1, 9 do + add('x' .. i, 'x_' .. i) + add('xb' .. i, 'x_{' .. i .. '<>}') +end +add('xn', 'x_n') +add('xbn', 'x_{n<>}') +add('xb', 'x_{<>}') +add('dots', '\\dots', 'dots') + +add 'langle' +add 'rangle' +add 'land' +add 'lor' +add 'iff' +add 'cdot' + +add('mathbb', '\\mathbb{<>}') +add 'rightarrow' +add 'leftarrow' + +add('^', '^{<>}', '^') +add('_', '_{<>}', '_') +add('text', '\\text{<>}', 'text') + +add('exists', '\\exists') +add('forall', '\\forall') +add 'in' +add('mathcal', '\\mathcal{<>}') +add 'setminus' +add('textit', '\\textit{<>}') + +add('frac', '\\frac{<>}{<>}', 'frac') +add('sqrt', '\\sqrt{<>}', 'sqrt') +add('times', '\\times', 'times') +add('imp', '\\implies', 'implies') +add('sum', '\\sum_{<>}^{<>}', 'sum') +add('inf', '\\infinity', 'infinity') +add('cases', '\\begin{cases} <> & \\text{if } <> \\text{then} <> \\\\ <> & {else } <> \\end{cases}', 'cases') +add('int', '\\int_{<>}^{<>} <> \\, d', 'int') +add('vec', '\\vec{<>}', 'vector') +add 'emptyset' + +-- set operations +add('subset', '\\subset', 'subset') +add('subseteq', '\\subseteq', 'subset equals') +add('cup', '\\cup', 'cup') +add('cap', '\\cap', 'cap') + +-- bool +add('leq', '\\leq', 'less equal') +add('geq', '\\geq', 'greater equals') + +local greek_letters = { + 'alpha', + 'beta', + 'gamma', + 'delta', + 'epsilon', + 'zeta', + 'eta', + 'theta', + 'iota', + 'kappa', + 'lambda', + 'mu', + 'nu', + 'xi', + 'omicron', + 'pi', + 'rho', + 'sigma', + 'tau', + 'upsilon', + 'phi', + 'chi', + 'psi', + 'omega', +} + +for _, letter in pairs(greek_letters) do + add(letter, '\\' .. letter, letter) + local upper_letter = letter:sub(1, 1):upper() .. letter:sub(2) + add(upper_letter, '\\' .. upper_letter, upper_letter) +end + +table.insert( + snippets, + ls.snippet( + { trig = 'im', snippetType = 'snippet', desc = 'Inline Math' }, + fmta('$<>$<>', { + ls.i(1), + ls.i(0), + }) + ) +) + +return snippets +-- return { +-- -- 1. Trigger inline math mode anywhere by typing 'mk' +-- s( +-- { trig = 'mk', snippetType = 'autosnippet', desc = 'Inline Math' }, +-- fmta('$<>$<>', { +-- i(1), +-- i(0), +-- }) +-- ), +-- +-- -- 2. LaTeX Fraction: Only triggers if you are already inside $ ... $ +-- s( +-- { trig = 'ff', snippetType = 'autosnippet', desc = 'LaTeX Fraction' }, +-- fmta('\\frac{<>}{<>}<>', { +-- i(1), +-- i(2), +-- i(0), +-- }), +-- { +-- condition = in_math, -- This magic line prevents 'ff' from triggering in normal text +-- } +-- ), +-- +-- -- 3. Superscript shortcut: Triggers inside math mode +-- s({ trig = 'sr', snippetType = 'autosnippet', desc = 'Squared' }, { t '^2' }, { condition = in_math }), +-- } diff --git a/lua/treesitter.lua b/lua/treesitter.lua new file mode 100644 index 0000000..c58fdb8 --- /dev/null +++ b/lua/treesitter.lua @@ -0,0 +1,95 @@ +-- ============================================================ +-- SECTION 8: TREESITTER +-- Parser installation, syntax highlighting, folds, indentation +-- ============================================================ +do + vim.pack.add { { src = gh 'romus204/tree-sitter-manager.nvim' } } + safe_require('tree-sitter-manager', { + ensure_installed = { + 'bash', + 'c', + 'css', + 'dockerfile', + 'gitignore', + 'go', + 'html', + 'java', + 'javascript', + 'json', + 'kotlin', + 'latex', + 'lua', + 'markdown', + 'markdown_inline', + 'python', + 'query', + 'sql', + 'typst', + 'yaml', + 'vim', + 'vimdoc', + }, + sync_install = false, + auto_install = true, + + -- Native highlight integration + highlight = true, + }) +end + +-- 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 +-- 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 diff --git a/lua/ui.lua b/lua/ui.lua new file mode 100644 index 0000000..efe66ba --- /dev/null +++ b/lua/ui.lua @@ -0,0 +1,131 @@ +-- ============================================================ +-- 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' } + safe_require 'guess-indent' + + -- 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' } + safe_require('gitsigns', { + 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 'nvim-tree/nvim-web-devicons' } + vim.pack.add { gh 'folke/which-key.nvim' } + safe_require('which-key', { + -- 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' } + safe_require('tokyonight', { + styles = { + comments = { italic = false }, -- Disable italics in comments + }, + }, function(_) + -- 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' + end) + + -- vim.pack.add { gh 'catppuccin/nvim' } + -- vim.cmd.colorscheme 'catppuccin-nvim' + -- + -- -- Highlight todo, notes, etc in comments + -- vim.pack.add { gh 'folke/todo-comments.nvim' } + -- safe_require('todo-comments', { signs = false }) + -- + -- [[ mini.nvim ]] + -- A collection of various small independent plugins/modules + vim.pack.add { gh 'nvim-mini/mini.nvim' } + vim.cmd.packadd '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 + safe_require('mini.ai', { + -- 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 [)] ['] + safe_require 'mini.surround' + + -- Simple and easy statusline. + -- You could remove this setup call if you don't like it, + -- and try some other statusline plugin + -- Set `use_icons` to true if you have a 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 + -- ... and there is more! + -- Check out: https://github.com/nvim-mini/mini.nvim + safe_require('mini.statusline', { use_icons = vim.g.have_nerd_font }, function(statusline) + statusline.section_location = function() return '%2l:%-2v' end + end) + + -- vim.pack.add { + -- { src = 'https://github.com/nvim-mini/mini.files', version = 'stable' }, + -- } + -- safe_require 'mini.files' +end