Rename options to avoid confusion with module options (nix-communit…

…y#1324)

README.md

@@ -307,12 +307,12 @@ NeoVim has a lot of configuration options. You can find a list of them by doing
 `:h option-list` from within NeoVim.
 
 All of these are configurable from within NixVim. All you have to do is set the
-`options` attribute:
+`opts` attribute:
 
 ```nix
 {
   programs.nixvim = {
-    options = {
+    opts = {
       number = true;         # Show line numbers
       relativenumber = true; # Show relative line numbers
 
@@ -323,21 +323,7 @@ All of these are configurable from within NixVim. All you have to do is set the
 ```
 
 Please note that to, for example, disable numbers you would not set
-`options.nonumber` to true, you'd set `options.number` to false.
-
-### Caveats
-
-If you are using `makeNixvimWithModule`, then options are treated as options for a module. To get around this, just wrap the options in a `config` set.
-
-```nix
-{
-  config = {
-    options = {
-      # ...
-    };
-  };
-}
-```
+`opts.nonumber` to true, you'd set `opts.number` to false.
 
 ## Key mappings
 It is fully possible to define key mappings from within NixVim. This is done

example.nix

@@ -31,7 +31,7 @@
     # There is .normal, .insert, .visual, .operator, etc!
 
     # We can also set options:
-    options = {
+    opts = {
       tabstop = 4;
       shiftwidth = 4;
       expandtab = false;

modules/clipboard.nix

@@ -47,7 +47,7 @@ in {
   };
 
   config = {
-    options.clipboard = mkIf (cfg.register != null) cfg.register;
+    opts.clipboard = mkIf (cfg.register != null) cfg.register;
 
     extraPackages =
       mapAttrsToList

modules/default.nix

@@ -10,7 +10,7 @@
     ./highlights.nix
     ./keymaps.nix
     ./lua-loader.nix
-    ./options.nix
+    ./opts.nix
     ./output.nix
     ./plugins.nix
     ./warnings.nix

modules/options.nix → modules/opts.nix

@@ -6,21 +6,21 @@
 }:
 with lib; let
   optionsAttrs = {
-    options = {
+    opts = {
       prettyName = "options";
       luaVariableName = "options";
       luaApi = "opt";
       description = "The configuration options, e.g. line numbers (`vim.opt.*`)";
     };
 
-    globalOptions = {
+    globalOpts = {
       prettyName = "global options";
       luaVariableName = "global_options";
       luaApi = "opt_global";
       description = "The configuration global options (`vim.opt_global.*`)";
     };
 
-    localOptions = {
+    localOpts = {
       prettyName = "local options";
       luaVariableName = "local_options";
       luaApi = "opt_local";
@@ -47,6 +47,16 @@ in {
     )
     optionsAttrs;
 
+  # Added 2024-03-29 (do not remove)
+  imports =
+    mapAttrsToList
+    (old: new: mkRenamedOptionModule [old] [new])
+    {
+      options = "opts";
+      globalOptions = "globalOpts";
+      localOptions = "localOpts";
+    };
+
   config = {
     extraConfigLuaPre =
       concatLines

plugins/bufferlines/bufferline.nix

@@ -347,7 +347,7 @@ in {
         cfg.package
         nvim-web-devicons
       ];
-      options.termguicolors = true;
+      opts.termguicolors = true;
       extraConfigLua = ''
         require('bufferline').setup${helpers.toLuaObject setupOptions}
       '';

plugins/colorschemes/base16/default.nix

@@ -104,7 +104,7 @@ with lib;
           plugins.lualine.theme = mkIf cfg.setUpBar "base16";
           plugins.lightline.colorscheme = null;
 
-          options.termguicolors = mkDefault true;
+          opts.termguicolors = mkDefault true;
         }
         (mkIf (isString cfg.colorscheme) {
           colorscheme = "base16-${cfg.colorscheme}";

plugins/colorschemes/catppuccin.nix

@@ -379,7 +379,7 @@ in {
   config = mkIf cfg.enable {
     colorscheme = "catppuccin";
     extraPlugins = [cfg.package];
-    options = {termguicolors = true;};
+    opts.termguicolors = true;
     extraConfigLuaPre = let
       setupOptions = with cfg; {
         inherit (cfg) flavour background styles integrations;

plugins/colorschemes/dracula.nix

@@ -76,8 +76,6 @@ in {
       dracula_colorterm = mkIf (!cfg.colorterm) 0;
     };
 
-    options = {
-      termguicolors = mkDefault true;
-    };
+    opts.termguicolors = mkDefault true;
   };
 }

plugins/colorschemes/melange.nix

@@ -18,8 +18,6 @@ in {
   config = mkIf cfg.enable {
     colorscheme = "melange";
     extraPlugins = [cfg.package];
-    options = {
-      termguicolors = mkDefault true;
-    };
+    opts.termguicolors = mkDefault true;
   };
 }

plugins/colorschemes/one.nix

@@ -25,6 +25,6 @@ helpers.vim-plugin.mkVimPlugin config {
   };
 
   extraConfig = cfg: {
-    options.termguicolors = lib.mkDefault true;
+    opts.termguicolors = lib.mkDefault true;
   };
 }

plugins/colorschemes/oxocarbon.nix

@@ -20,8 +20,6 @@ in {
     colorscheme = "oxocarbon";
     extraPlugins = [cfg.package];
 
-    options = {
-      termguicolors = mkDefault true;
-    };
+    opts.termguicolors = mkDefault true;
   };
 }

plugins/colorschemes/rose-pine.nix

@@ -35,7 +35,7 @@ in {
   config = mkIf cfg.enable {
     colorscheme = "rose-pine";
     extraPlugins = [cfg.package];
-    options = {termguicolors = true;};
+    opts.termguicolors = true;
     extraConfigLuaPre = let
       setupOptions = with cfg; {
         inherit groups;

plugins/colorschemes/tokyonight.nix

@@ -70,7 +70,7 @@ in {
   config = mkIf cfg.enable {
     colorscheme = "tokyonight";
     extraPlugins = [cfg.package];
-    options = {termguicolors = true;};
+    opts.termguicolors = true;
     extraConfigLuaPre = let
       setupOptions = with cfg; {
         inherit (cfg) style transparent styles sidebars;

plugins/git/gitgutter.nix

@@ -182,7 +182,7 @@ in {
     mkIf cfg.enable {
       extraPlugins = [cfg.package];
 
-      options = mkIf cfg.recommendedSettings {
+      opts = mkIf cfg.recommendedSettings {
         updatetime = 100;
         foldtext = "gitgutter#fold#foldtext";
       };

plugins/languages/treesitter/treesitter.nix

@@ -220,7 +220,7 @@ in {
         ]
         ++ optional (cfg.gccPackage != null) cfg.gccPackage;
 
-      options = mkIf cfg.folding {
+      opts = mkIf cfg.folding {
         foldmethod = "expr";
         foldexpr = "nvim_treesitter#foldexpr()";
       };

tests/modules/files.nix

@@ -1,7 +1,7 @@
 {
   after = {
     files."after/ftplugin/python.lua" = {
-      localOptions.conceallevel = 1;
+      localOpts.conceallevel = 1;
 
       keymaps = [
         {

tests/test-sources/modules/options.nix

@@ -11,12 +11,12 @@
       mousemodel = "extend"; # Mouse right-click extends the current selection
     };
 
-    localOptions = {
+    localOpts = {
       textwidth = 80;
       sidescrolloff = 0;
     };
 
-    globalOptions = {
+    globalOpts = {
       textwidth = 110;
       sidescrolloff = 10;
     };