Commit graph

296 commits

Author SHA1 Message Date
Gaetan Lepage
a70f580340 helpers/vim-plugin/mkVimPlugin: make use of helpers.mkSettingsOption 2024-02-12 18:46:13 +01:00
Gaetan Lepage
100876b7a3 helpers/neovim-plugin: make use of helpers.mkSettingsOption 2024-02-12 18:46:13 +01:00
Gaetan Lepage
e3e14dbe1d helpers/options: add mkSettingsOption 2024-02-12 18:46:13 +01:00
Gaetan Lepage
54da635d45 helpers/vim-plugin/mkVimPlugin: rename extraConfig to settings (RFC 42) 2024-02-12 13:12:43 +01:00
Gabriel Arazas
0b5800a2a2
docs: clean up descriptions (#1061) 2024-02-11 13:51:34 +01:00
Gaetan Lepage
304c62516d helpers/autocmd-helpers: do not import helpers.nix directly 2024-02-11 11:50:35 +01:00
Gaetan Lepage
ba818894b4 helpers/keymap-helpers: do not import helpers.nix directly 2024-02-11 11:50:35 +01:00
Gaetan Lepage
3c174e874c helpers/vim-plugin/mkVimPlugin: refactor 2024-02-10 17:53:41 +01:00
Gaetan Lepage
2e18333dd2 helpers/neovim-plugin/mkSettingsOption: fix typo 2024-02-07 14:23:58 +01:00
traxys
507ff5b142
docs: Use a nixpkgs patch instead of copy/pasting nixpkgs functions (#1011)
This makes the code more maintainable, as it only depends on our small
patch, instead of a large number of internals of nixpkgs.
2024-02-03 19:04:09 +01:00
Gaetan Lepage
06e4a4e0c8 helpers/options: allow raw values for border options 2024-02-03 12:45:36 +01:00
Gaetan Lepage
97eed79568 modules/keymaps: allow action.__raw 2024-02-03 12:42:05 +01:00
Gaetan Lepage
89cac08ac7 helpers: add toSnakeCase converter 2024-02-02 10:50:35 +01:00
Gaetan Lepage
ac0ef61339 helpers/neovim-plugin: mkSetupOptionsOption -> mkSettingsOption 2024-02-02 10:42:38 +01:00
Gaetan Lepage
43f3cb7ab2 lib/helpers: init neovim-plugin.mkSetupOptionsOption 2024-01-28 23:39:14 +01:00
Gaetan Lepage
e2c3459d1d lib/helpers: extraOptionsOptions -> neovim-plugin.extraOptionsOptions 2024-01-28 23:39:14 +01:00
Gaetan Lepage
7164a89f72 lib/helpers: factor out nixvimUtils 2024-01-25 17:05:03 +01:00
Gaetan Lepage
98dbe8a89b lib/helpers: internal refactoring 2024-01-25 16:38:59 +01:00
Gaetan Lepage
598ac0465f helpers: remove unused toVimDict 2024-01-25 16:38:59 +01:00
Gaetan Lepage
a68ee73947 helpers/vim-plugin: mkPlugin -> mkVimPlugin 2024-01-25 15:19:26 +01:00
Gaetan Lepage
8f90372ee5 helpers: move mkPlugin and mkDefaultOpt to helpers.vim-plugin 2024-01-25 15:19:26 +01:00
Gaetan Lepage
8104e24adc helpers: remove useless comments for certain options 2024-01-17 15:03:54 +01:00
Gaetan Lepage
5ae4714e80 helpers/highlight: Add rawType support for string options in the highlight type 2024-01-17 15:03:54 +01:00
Gaetan Lepage
6e39178dd3 helpers/mkDefaultOpt: make 'global' parameter optional 2024-01-14 22:35:27 +01:00
Gaetan Lepage
f1c8f9a8d2 helpers/mkPlugin: remove useless 'value' parameter 2024-01-14 22:35:27 +01:00
Gaetan Lepage
22fb5df657 helpers/mkPlugin: remove useless bool conversion 2024-01-14 22:35:27 +01:00
Gaetan Lepage
e3ef5dae2b helpers/mkPlugin: add default value for description (use name) 2024-01-14 22:35:27 +01:00
Gaetan Lepage
97fb6d6a29 helpers/mkPlugin: add extraConfig option 2024-01-14 22:35:27 +01:00
Gaetan Lepage
a40a0c679c helpers: add mkNullOrStr 2024-01-06 18:33:39 +01:00
Gaetan Lepage
f0b487a10c helpers: expose maybeRaw for wider use 2024-01-06 16:45:17 +01:00
traxys
8aa4b7e4ce
helpers: Add option helpers for types that are either a lua str or a value (#876)
Those types needed the following code in apply:

if builtins.isString value
then mkRaw value
else value

This commit avoids this boilerplate, and clarifies that the `str` is lua
code in the documentation.
2024-01-02 00:30:10 +01:00
traxys
8b8a1c0f4b
fix: Remove missed mentions of rawType (#875) 2024-01-02 00:26:41 +01:00
traxys
4d14c098b6 helpers: Add types for lua function & lua code
This allows to display `lua function string` and `lua code string` in
the documentation for related options.
2024-01-02 00:15:30 +01:00
Gaetan Lepage
f88ff0a82e helpers: borderType -> nixvimTypes.border 2024-01-01 23:55:27 +01:00
Gaetan Lepage
d88a30fba6 helpers: highlightType -> nixvimTypes.highlight 2024-01-01 23:55:27 +01:00
traxys
af41ea2d80
helpers: move rawType to helpers.nixvimTypes (#871)
This is done in preparation of adding new (lua) types to help the
documentation.
2024-01-01 23:33:53 +01:00
Gaetan Lepage
99ebb5f074 helpers: fix typo 2024-01-01 21:49:35 +01:00
traxys
abd1c4007a
helpers: Add mkLua,mkLuaFn (defaultNullOpts or not) (#866)
This makes it such that defaultNullOpts.mkStr never represents a lua
string, easing documenting where a string is a lua string vs lua code.
2024-01-01 20:28:55 +01:00
traxys
1d8e7906c9
plugins: Introduce helpers.defaultNullOpts.mkLuaFn (#855)
This allows to avoid calling `mkRaw` on lua functions, as they will get
applied automatically.

This could also help in the future to refactor the use of Lua code to
make it more user-friendly.
2023-12-29 15:24:42 +01:00
traxys
e0521dde87
helpers: Allow to set raw lua code in more places (#837)
With this change a user should be able to set raw lua code in more
places than before.

The `mkStr` helper was _not_ changed as a large number of places in
nixvim are using this helper to directly implement raw lua code.

Also note that types of the form `oneOf [submodule <something else>` are
not well rendered in the documentation, and should be avoided (this
includes `listOf [submodule <something else>`, so the helpers should be
avoided in this case)
2023-12-22 16:55:50 +01:00
traxys
2871dc94b4
Allow to add meta options like maintainers (#836) 2023-12-22 15:59:41 +01:00
Gaetan Lepage
a70947a563 lib/helpers: add defaultNullOpts.mkLogLevel 2023-12-22 14:48:15 +01:00
Gaetan Lepage
e49bec3901 lib/helpers: add defaultNullOpts.mkSeverity 2023-12-22 14:48:15 +01:00
Gaetan Lepage
b3fb1c4c81 helpers/keymaps: add mkMapOptionsSubmodule 2023-12-15 16:19:28 +01:00
Gaetan Lepage
48dd8d28cf modules/keymaps: deprecate maps option 2023-12-02 20:29:07 +01:00
Gaetan Lepage
3ff4976eba lib/helpers: mkRaw should output null for empty strings 2023-11-28 14:08:27 +01:00
Gaetan Lepage
8cf2d943d2 lib/helpers: mkRaw now behaves like mkRawIfNonNull 2023-11-23 11:39:41 +01:00
Gaetan Lepage
707054bf23 helpers: factor out borderType 2023-11-16 22:22:18 +01:00
Gaetan Lepage
bbbbfa2774 modules/autocmd: factor out autocmd-helpers 2023-11-14 23:23:30 +01:00
traxys
0b87e5b70c
plugin/persistence: init + tests (#645) 2023-10-16 23:54:41 +02:00