From 8865b7c1a4a430b0b755206047a855b031045a0a Mon Sep 17 00:00:00 2001
From: cademichael <cade.lueker@gmail.com>
Date: Sun, 12 Jul 2026 19:57:36 -0600
Subject: [PATCH] refactor: update neovim setup for new plugin

---
 src/getting-started.md | 94 +++++++++++++++++++-----------------------
 1 file changed, 43 insertions(+), 51 deletions(-)

diff --git a/src/getting-started.md b/src/getting-started.md
index 9fac031..bc09fc8 100644
--- a/src/getting-started.md
+++ b/src/getting-started.md
@@ -117,71 +117,63 @@ The snippet above provides the following keybindings.
 
 ![Visual Studio Code1](images/neovim.png)
 
-### Manual Configuration
+#### Installation
 
-If you would rather setup the LSP server yourself the code from the plugin is as follows.
+Install with your plugin manager of choice using the repo `flix/nvim`.
 
-1. Tell nvim what filetypes are Flix files
+Neovim 0.12 ships a built-in plugin manager, so no third party is required:
 
 ```lua
-vim.filetype.add({
-  extension = {
-    flix = "flix",
-  }
-})
+-- Neovim 0.12+ (vim.pack)
+vim.pack.add({ "https://github.com/flix/nvim" })
+
+require("flix").setup()
+vim.lsp.enable("flix")
 ```
 
-2. Configure the Flix LSP for neovim's native LSP client
+With [lazy.nvim](https://github.com/folke/lazy.nvim):
 
 ```lua
--- check if "flix" has already been setup
-if not vim.lsp.config["flix"] then
-  -- create flix LSP configuration for native LSP
-  vim.lsp.config('flix', {
-    -- choose just one `cmd` definition
-    -- for a project local `flix.jar` ie flix.jar is installed in the root of your project
-    cmd = { "java", "-jar", "flix.jar", "lsp" },
-    -- for a global flix installation ie with "homebrew" or "nix"
-    cmd = {"flix", "lsp"},
-    filetypes = { "flix" },
-    root_markers = { "flix.toml" }, -- where to set the root directory
-    cmd_cwd = vim.fs.root(0, { 'flix.toml' }),
-    root_dir = vim.fs.root(0, { 'flix.toml' }),
-})
-end
+{
+  "flix/nvim",
+  ft = "flix",
+  config = function()
+    require("flix").setup()
+    vim.lsp.enable("flix")
+  end,
+}
 ```
 
-3. Create an autocmd to set flix defualts such as comments and indenting, and to run the codelens whenever your flix buffer changes.
+#### Configuration
+
+Call `require("flix").setup()` to register the config, then enable the server:
 
 ```lua
--- auto commands
--- create named "groups" to prevent autocmd conflicts
-local flix = vim.api.nvim_create_augroup("flix.ft", { clear = true })
-local flix_lsp = vim.api.nvim_create_augroup("flix.lsp", { clear = true })
--- autocmd that activates when a "flix" buffer is entered
-vim.api.nvim_create_autocmd("FileType", {
-  group = flix,
-  pattern = "flix",
-  callback = function(args)
-    vim.api.nvim_clear_autocmds({ group = flix_lsp, buffer = args.buf }) -- prevent duplicates
-    -- set flix defaults
-    vim.opt_local.tabstop = 4
-    vim.opt_local.shiftwidth = 4
-    vim.opt_local.softtabstop = 4
-    vim.bo.commentstring = "// %s"
-    -- refresh codelens
-    vim.api.nvim_create_autocmd({ 'BufEnter', 'CursorHold', 'InsertLeave' }, {
-      group = flix_lsp,
-      buffer = args.buf,
-      callback = function()
-        vim.lsp.codelens.refresh({ bufnr = args.buf })
-      end
-    })
-  end
-})
+-- create the Flix LSP config
+require("flix").setup()
+-- enable the server
+vim.lsp.enable("flix")
+```
+
+Set local Flix keybindings with an autocommand or by creating `ftplugin/flix.lua`
+in your own config. The example below maps run/test for a Flix project:
+
+```lua
+-- import the `flix_cmd` function
+local flix_cmd = require("flix.commands").flix_cmd
+-- setting `buffer` keeps the mappings scoped to Flix buffers
+local bufnr = vim.api.nvim_get_current_buf()
+
+vim.keymap.set("n", "<Space>br", function() flix_cmd("run") end,
+  { noremap = true, silent = true, buffer = bufnr, desc = "run flix project" })
+vim.keymap.set("n", "<Space>bt", function() flix_cmd("test") end,
+  { noremap = true, silent = true, buffer = bufnr, desc = "test flix project" })
 ```
 
-> place this code in your `$HOME/.config/nvim/init.lua` or wherever you configure your lsp in neovim.
+`flix_cmd` finds the project root from `root_markers`, so it works even when the
+LSP is not attached, and reports an error if no `flix.toml` is found.
+
+> place this code in your `$HOME/.config/nvim/init.lua` or wherever you configure your plugins in neovim.
 
 ## Using Flix from Emacs