From 98691619efff28e38b797e74e0b996ea449e28b6 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Sun, 1 Dec 2024 10:13:35 +0300
Subject: [PATCH] docs: update changelogs

---
 docs/release-notes/rl-0.4.md   |  2 +-
 docs/release-notes/rl-0.7.md   | 37 ++++++++++++++++++++++++++++++----
 modules/extra/deprecations.nix |  4 +---
 3 files changed, 35 insertions(+), 8 deletions(-)

diff --git a/docs/release-notes/rl-0.4.md b/docs/release-notes/rl-0.4.md
index ad3cc4dd..f5c2c338 100644
--- a/docs/release-notes/rl-0.4.md
+++ b/docs/release-notes/rl-0.4.md
@@ -49,7 +49,7 @@ absence.
 - Made Copilot's Node package configurable. It is recommended to keep as
   default, but providing a different NodeJS version is now possible.
 
-- Added [](#opt-vim.cursorlineOpt) for configuring Neovim's cursorlineOpt.
+- Added `vim.cursorlineOpt` for configuring Neovim's `vim.o.cursorlineopt`.
 
 - Added `filetree.nvimTreeLua.view.cursorline`, default false, to enable
   cursorline in nvimtre.
diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md
index 8dcfc5b0..1a23634c 100644
--- a/docs/release-notes/rl-0.7.md
+++ b/docs/release-notes/rl-0.7.md
@@ -91,6 +91,30 @@ default. This is to avoid conflicts with other modules. You can change
 `maplocalleader` with `vim.globals.maplocalleader`, but it's recommended to set
 it to something other than `mapleader` to avoid conflicts.
 
+### `vim.*` changes {#sec-vim-opt-changes}
+
+Inline with the [leader changes](#sec-leader-changes), we have removed some
+options that were under `vim` as convenient shorthands for `vim.o.*` options.
+
+::: {.warning}
+
+As v0.7 features the addition of [](#opt-vim.options), those options are now
+considered as deprecated. You should migrate to the appropriate options in the
+`vim.options` submodule.
+
+:::
+
+The changes are, in no particular order:
+
+- `colourTerm`, `mouseSupport`, `cmdHeight`, `updateTime`, `mapTime`,
+  `cursorlineOpt`, `splitBelow`, `splitRight`, `autoIndent` and `wordWrap` have
+  been mapped to their [](#opt-vim.options) equivalents. Please see the module
+  definition for the updated options.
+
+- `tabWidth` has been **removed** as it lead to confusing behaviour. You can
+  replicate the same functionality by setting `shiftwidth`, `tabstop` and
+  `softtabstop` under `vim.options` as you see fit.
+
 ## Changelog {#sec-release-0.7-changelog}
 
 [ItsSorae](https://github.com/ItsSorae):
@@ -133,10 +157,10 @@ it to something other than `mapleader` to avoid conflicts.
   recommended to go through rustacean.nvim's README to take a closer look at its
   features and usage
 
-- Add [lz.n] support and lazy-load some builtin plugins.
-
 [lz.n]: https://github.com/mrcjkb/lz.n
 
+- Add [lz.n] support and lazy-load some builtin plugins.
+
 [jacekpoz](https://jacekpoz.pl):
 
 [ocaml-lsp]: https://github.com/ocaml/ocaml-lsp
@@ -300,17 +324,22 @@ it to something other than `mapleader` to avoid conflicts.
   spellfiles to Neovim's runtime with ease.
 
 - Add combined nvf configuration (`config.vim`) into the final package's
-  passthru as `passthru.neovimConfiguration` for easier debugging.
+  `passthru` as `passthru.neovimConfiguration` for easier debugging.
 
 - Add support for [tiny-devicons-auto-colors] under
   `vim.visuals.tiny-devicons-auto-colors`
 
+- Move options that used to set `vim.o` values (e.g. `vim.wordWrap`) into
+  `vim.options` as default values. Some are left as they don't have a direct
+  equivalent, but expect a switch eventually.
+
 [ppenguin](https://github.com/ppenguin):
 
 - Telescope:
   - Fixed `project-nvim` command and keybinding
   - Added default ikeybind/command for `Telescope resume` (`<leader>fr`)
-- Add `hcl` lsp/formatter (not the same as `terraform`, which is not useful for e.g. `nomad` config files).
+- Add `hcl` lsp/formatter (not the same as `terraform`, which is not useful for
+  e.g. `nomad` config files).
 
 [Soliprem](https://github.com/Soliprem):
 
diff --git a/modules/extra/deprecations.nix b/modules/extra/deprecations.nix
index ed28201d..e4cb193f 100644
--- a/modules/extra/deprecations.nix
+++ b/modules/extra/deprecations.nix
@@ -3,7 +3,7 @@
   inherit (lib.lists) concatLists;
   inherit (lib.nvim.config) batchRenameOptions;
 
-  migrationTable = {
+  renamedVimOpts = batchRenameOptions ["vim"] ["vim" "options"] {
     colourTerm = "termguicolors";
     mouseSupport = "mouse";
     cmdHeight = "cmdheight";
@@ -15,8 +15,6 @@
     autoIndent = "autoindent";
     wordWrap = "wrap";
   };
-
-  renamedVimOpts = batchRenameOptions ["vim"] ["vim" "options"] migrationTable;
 in {
   imports = concatLists [
     [