Rename options to avoid confusion with module options

[MattSturgeon]

As discussed on matrix, the options option conflicts with the module system's options attribute.

We can rename to opts, but we probably shouldn't remove the old name as it is likely one of the most used parts of nixvim.

• Rename options, localOptions, globalOptions
• Deprecate the old names
• Migrate internal usage

[MattSturgeon]

I think I've migrated the existing uses of config.options (etc), however it's not easy to grep for so I may have missed some.

Other than some low hanging fruit, I listed files that contain both config and options and then manually checked them all...

Details

# fish shell

$ rg -l '\\boptions\\b' (rg -l '\\bconfig\\b') | wc -l
204

$ rg -l '\\boptions\\b' (rg -l '\\bconfig\\b')
plugins/utils/wilder.nix
plugins/utils/toggleterm.nix
plugins/utils/spider.nix
plugins/utils/notify.nix
plugins/utils/neorg.nix
plugins/utils/nix-develop.nix
plugins/utils/leap.nix
plugins/git/gitmessenger.nix
plugins/utils/rest.nix
plugins/git/gitgutter.nix
plugins/utils/neogen.nix
plugins/utils/startup.nix
plugins/lsp/inc-rename.nix
plugins/git/git-worktree.nix
plugins/colorschemes/kanagawa.nix
plugins/utils/navbuddy.nix
plugins/git/gitsigns/default.nix
plugins/utils/nvim-ufo.nix
plugins/utils/oil.nix
plugins/lsp/nvim-lightbulb.nix
plugins/utils/autoclose.nix
plugins/utils/neocord.nix
plugins/git/diffview.nix
plugins/utils/project-nvim.nix
plugins/colorschemes/dracula.nix
plugins/colorschemes/tokyonight.nix
plugins/utils/nvim-autopairs.nix
plugins/utils/vim-matchup.nix
tests/test-sources/plugins/completion/cmp.nix
plugins/utils/illuminate.nix
plugins/dap/dap-python.nix
tests/test-sources/plugins/filetrees/neo-tree.nix
plugins/utils/endwise.nix
plugins/utils/which-key.nix
plugins/colorschemes/melange.nix
plugins/lsp/lsp-lines.nix
plugins/TEMPLATE.nix
plugins/none-ls/prettier.nix
plugins/utils/nvim-colorizer.nix
plugins/colorschemes/poimandres.nix
plugins/utils/dashboard.nix
plugins/languages/treesitter/rainbow-delimiters.nix
plugins/utils/clipboard-image.nix
plugins/utils/vim-bbye.nix
plugins/completion/codeium-vim.nix
plugins/dap/dapHelpers.nix
plugins/completion/lspkind.nix
plugins/languages/markdown-preview.nix
plugins/utils/cursorline.nix
plugins/utils/presence-nvim.nix
plugins/languages/sniprun.nix
plugins/telescope/fzf-native.nix
plugins/utils/coverage.nix
plugins/utils/auto-save.nix
plugins/utils/harpoon.nix
plugins/languages/treesitter/treesitter-refactor.nix
plugins/languages/plantuml-syntax.nix
plugins/utils/floaterm.nix
plugins/languages/rust-tools.nix
plugins/utils/conjure.nix
plugins/completion/cmp/sources/codeium-nvim.nix
plugins/utils/alpha.nix
plugins/completion/cmp/sources/cmp-tabnine.nix
plugins/languages/julia/julia-cell.nix
plugins/languages/treesitter/hmts.nix
plugins/utils/zk.nix
plugins/utils/commentary.nix
plugins/languages/ledger.nix
plugins/filetrees/chadtree.nix
plugins/telescope/ui-select.nix
plugins/git/gitblame.nix
plugins/utils/marks.nix
wrappers/hm.nix
plugins/lsp/helpers.nix
plugins/git/fugitive.nix
modules/filetype.nix
modules/options.nix
plugins/utils/specs.nix
plugins/utils/mkdnflow.nix
plugins/statuslines/lualine.nix
plugins/utils/startify/default.nix
plugins/languages/typescript-tools.nix
modules/autocmd.nix
plugins/utils/nvim-osc52.nix
plugins/lsp/lspsaga.nix
plugins/lsp/language-servers/update_ra.md
plugins/git/gitsigns/options.nix
docs/user-guide/install.md
plugins/utils/obsidian/default.nix
plugins/utils/magma-nvim.nix
plugins/colorschemes/catppuccin.nix
plugins/utils/auto-session.nix
docs/man/default.nix
plugins/lsp/language-servers/vls.nix
modules/editorconfig.nix
plugins/git/neogit/default.nix
plugins/colorschemes/rose-pine.nix
plugins/git/gitlinker.nix
plugins/utils/yanky.nix
plugins/bufferlines/navic.nix
lib/vim-plugin.nix
plugins/utils/hardtime.nix
plugins/neotest/adapters.nix
plugins/utils/flash.nix
plugins/utils/better-escape.nix
wrappers/modules/output.nix
plugins/utils/comment.nix
plugins/lsp/conform-nvim.nix
plugins/bufferlines/barbecue.nix
plugins/utils/persistence.nix
plugins/utils/refactoring.nix
plugins/lsp/language-servers/ccls.nix
plugins/lsp/wtf.nix
modules/commands.nix
plugins/utils/lastplace.nix
wrappers/modules/files.nix
plugins/none-ls/default.nix
plugins/utils/fzf-lua.nix
plugins/languages/debugprint.nix
plugins/utils/nvim-bqf.nix
plugins/languages/openscad.nix
plugins/colorschemes/palette.nix
plugins/dap/dap-go.nix
wrappers/darwin.nix
plugins/utils/mark-radar.nix
plugins/ui/noice.nix
plugins/colorschemes/base16/default.nix
plugins/pluginmanagers/packer.nix
tests/test-sources/plugins/neotest/playwright.nix
plugins/completion/copilot-lua.nix
plugins/languages/nvim-jdtls.nix
plugins/utils/quickmath.nix
plugins/dap/default.nix
plugins/utils/netman.nix
plugins/telescope/file-browser.nix
plugins/languages/treesitter/ts-context-commentstring.nix
plugins/telescope/media-files.nix
plugins/utils/todo-comments.nix
modules/highlights.nix
plugins/completion/cmp/sources/cmp-tabby.nix
lib/neovim-plugin.nix
plugins/lsp/fidget.nix
plugins/none-ls/servers.nix
plugins/ui/image.nix
plugins/languages/treesitter/treesitter-context.nix
docs/default.nix
plugins/utils/multicursors.nix
plugins/languages/vim-slime.nix
plugins/telescope/undo.nix
CONTRIBUTING.md
modules/colorscheme.nix
plugins/dap/dap-ui.nix
plugins/utils/ollama.nix
plugins/lsp/language-servers/rust-analyzer.nix
plugins/completion/cmp/sources/crates-nvim.nix
tests/test-sources/plugins/filetrees/nvim-tree.nix
plugins/neotest/default.nix
plugins/filetrees/nvim-tree.nix
plugins/statuslines/lightline.nix
plugins/languages/treesitter/treesitter-textobjects.nix
plugins/utils/mini.nix
plugins/lsp/default.nix
modules/clipboard.nix
plugins/snippets/friendly-snippets.nix
plugins/languages/typst/typst-vim.nix
plugins/utils/obsidian/options.nix
plugins/languages/lint.nix
plugins/languages/lean.nix
plugins/languages/helm.nix
plugins/lsp/language-servers/efmls-configs.nix
plugins/utils/easyescape.nix
modules/output.nix
modules/keymaps.nix
plugins/pluginmanagers/lazy.nix
tests/fetch-tests.nix
plugins/filetrees/neo-tree.nix
plugins/languages/treesitter/ts-autotag.nix
README.md
plugins/telescope/default.nix
wrappers/nixos.nix
plugins/snippets/luasnip/default.nix
plugins/dap/dap-virtual-text.nix
plugins/colorschemes/oxocarbon.nix
plugins/languages/rustaceanvim.nix
plugins/utils/intellitab.nix
plugins/languages/treesitter/treesitter.nix
plugins/telescope/fzy-native.nix
plugins/completion/cmp/sources/copilot-cmp.nix
plugins/lsp/language-servers/svelte.nix
plugins/bufferlines/barbar.nix
plugins/completion/coq-thirdparty.nix
plugins/bufferlines/bufferline.nix
plugins/lsp/language-servers/nixd.nix
modules/lua-loader.nix
plugins/telescope/frecency.nix
plugins/languages/clangd-extensions.nix
plugins/colorschemes/one.nix
plugins/lsp/lsp-format.nix
plugins/completion/cmp/default.nix
docs/mdbook/default.nix
flake-modules/modules.nix
plugins/completion/cmp/options/default.nix
tests/test-sources/plugins/lsp/svelte.nix
plugins/lsp/language-servers/pylsp.nix

[MattSturgeon]

Should modules/options.nix be renamed modules/opts.nix?

[traxys]

Should modules/options.nix be renamed modules/opts.nix?

I'm not sure its necessary

[MattSturgeon]

Should modules/options.nix be renamed modules/opts.nix?

I'm not sure its necessary

Just a question of preference. It'd further indicate the file relates to vim option rather than module options... 🤷

A small change if you want it. No big deal if not 😄

[traxys]

Should modules/options.nix be renamed modules/opts.nix?

I'm not sure its necessary

Just a question of preference. It'd further indicate the file relates to vim option rather than module options... 🤷

A small change if you want it. No big deal if not 😄

I have no opinion on which is the correct name, so you can do what you think is best!

[GaetanLepage]

I have no opinion on which is the correct name, so you can do what you think is best!

I would rename it.