Commit graph

282 commits

Author SHA1 Message Date
Matt Sturgeon
33a32c9417
lib/options: move "plugin default" into defaultText
Introduce a new `helpers.pluginDefaultText` and deprecate `helpers.defaultNullOpts.mkDesc`.

Displaying the "plugin default" within `defaultText` ensures that both
defaults are grouped together in the docs.

Also take the first step towards transitioning `defaultNullOpts` from
using `default` to `pluginDefault` to mean "plugin default".
2024-06-10 15:11:21 +01:00
Matt Sturgeon
f34fda8d99
meta: extend meta.nixvimInfo support treewide
Rather than supplying a `kind` and `name` pair, we now supply a raw
path.

This path could point to any nixvim option.
2024-06-07 22:22:55 +01:00
Matt Sturgeon
b2a477260d
docs: emphasise "Plugin default" to match nixpkgs
Nixpkg's "headings" are emphasised in italics ("Default", "Example",
"Type", etc). We should match the style.
2024-06-07 17:47:33 +01:00
Matt Sturgeon
ade4539b3f
lib/options: defaultNullOpts don't require having a default
Made the `default` and `description` arguments optional for all prime
variants of `defaultNullOpts` functions.

If neither `default` nor `description` are provided, the option will
have no description.

The "Plugin default" line is only added when a `default` argument is
present (`args ? default`).
2024-06-07 17:34:46 +01:00
Matt Sturgeon
302262304e
lib/keymaps: refactor mkMapOptionSubmodule again
Allow passing in `key` and `action` as either bool or an attrset.

If `false`, the option is omitted. If `true` or an attrset, the option is included.
If an attrset is used, it will update the default `mkOption` args.
This is useful for overriding `type` or adding an `example`.
2024-06-07 15:42:54 +01:00
Matt Sturgeon
c16533b3f7
lib: add upperFirstChar
A util function to capitalize the first character of a string.
2024-06-07 09:17:29 +01:00
Matt Sturgeon
f7e009d29e
lib/options: add mkEnum' argument assertions 2024-06-02 03:18:11 +01:00
Matt Sturgeon
a2443ac0d6
lib/options: add more defaultNullOpts 'variants
All `defaultNullOpts` functions now have a prime variant.
2024-06-02 03:18:10 +01:00
Matt Sturgeon
df3aa86713
lib/keymap-helpers: refactor mkMapOptionSubmodule
Make the `key` and `action` options optional, and allow configuring
whether `action` can be a raw type.
2024-06-01 16:19:35 +01:00
Matt Sturgeon
87d6654a9f
lib/options: remove mkStr assert
If a non-string is passed in, it'll be formatted here. This is okay
because `mkDesc` will not re-format anyway.
2024-06-01 15:08:14 +01:00
Matt Sturgeon
297aa6d0a2
lib/options: make mkPackageOption use mkNullOrOption' 2024-06-01 14:33:43 +01:00
Matt Sturgeon
1bb4cb9c6c
lib/options: add mkAttrsOf' & mkListOf' (etc) 2024-06-01 14:33:43 +01:00
Matt Sturgeon
e0b60bac8b
lib/options: add mkNullableWithRaw' variant 2024-06-01 14:33:42 +01:00
Matt Sturgeon
84b2b0d90c
lib/options: add mkNullable' variant 2024-06-01 14:33:42 +01:00
Matt Sturgeon
ed56221499
lib/options: add mkNullOrStrLuaFnOr' variant 2024-06-01 14:33:42 +01:00
Matt Sturgeon
5bcb6184b0
lib/options: add mkNullOrStrLuaOr' variant 2024-06-01 14:33:41 +01:00
Matt Sturgeon
56ee982cb4
lib/options: add mkNullOrLuaFn' variant 2024-06-01 14:33:41 +01:00
Matt Sturgeon
207bfc6e69
lib/options: add mkNullOrLua' variant 2024-06-01 14:33:41 +01:00
Matt Sturgeon
3a151bbf09
lib/options: add mkNullOrStr' variant 2024-06-01 14:33:41 +01:00
Matt Sturgeon
9bf7724b98
lib/options: add mkCompositeOption' variant 2024-06-01 14:33:40 +01:00
Matt Sturgeon
fc542329cd
lib/options: add mkNullOrOption' variant 2024-06-01 14:33:40 +01:00
Matt Sturgeon
57003fea4e
lib/options: inline mkDefaultDesc into mkDesc
And add function documentation.
2024-06-01 14:33:40 +01:00
Gaetan Lepage
d15fade62b helpers/toLuaObject: fix rawKey handling 2024-05-31 23:31:11 +02:00
Gaetan Lepage
0ba2ea5416 helpers: add rawKeysAttrs 2024-05-31 21:53:40 +02:00
Gaetan Lepage
03c5f5eb74 helpers/toLuaObject: add support for raw keys 2024-05-31 21:53:40 +02:00
Matt Sturgeon
29922e13f7
modules/keymaps: fix false-positive lua warning 2024-05-31 20:38:53 +01:00
Ismaïl Senhaji
6ff3493c9b modules/keymaps: doc: add backticks around noremap
Co-authored-by: Matt Sturgeon <matt@sturgeon.me.uk>
2024-05-30 22:27:24 +02:00
Ismaïl Senhaji
6d3d3bd0c2 modules/keymaps: doc: add backticks around special arguments 2024-05-30 22:27:24 +02:00
Ismaïl Senhaji
bea8492e19 modules/keymaps: add "buffer" option to mapConfigOptions 2024-05-30 15:46:30 +02:00
Matt Sturgeon
51240cef0e
lib/options: defaultNullOpts delegate string rendering 2024-05-30 14:27:37 +01:00
Matt Sturgeon
ff1ab1700c
lib/options: mkEnum quote default if string
As there's only a handful of call-sites to fix, ensure all `mkEnum`
defaults are passed in as the correct type (tree wide) and change
`mkEnum` to now correctly render string-type defaults "quoted" (like
`mkString` does).
2024-05-30 14:27:37 +01:00
ben
ea69144d60 maintainers: add b3nb5n 2024-05-30 14:23:23 +02:00
Nate Smith
099f9f0f59 maintainers: add nwjsmith 2024-05-29 20:52:07 +01:00
Matt Sturgeon
b113bc69ea
lib/options: mkStr quote default string 2024-05-29 09:50:03 +01:00
Matt Sturgeon
cedc1e4799
lib/options: use code-block for multiline defaults
Detect whether a plugin default is multiline using `hasInfix "\n"`.

Also remove `multiline=false` from the `toPretty` call.
2024-05-29 09:25:55 +01:00
Gaetan Lepage
ef63d3477f colorschemes: set the colorscheme as mkDefault to allow for overriding 2024-05-28 21:30:43 +02:00
Matt Sturgeon
daa6b0f5cf
lib/options: defaultNullOpts support non-string defaults 2024-05-28 20:16:17 +01:00
Matt Sturgeon
8212bf1cd2 modules/keymaps: deprecate lua option 2024-05-26 15:26:06 +01:00
Gaetan Lepage
7c4fe30f81 lib/options: introduce new mkPackageOption for dependencies 2024-05-17 22:15:47 +02:00
Gaetan Lepage
26367692da lib/options: rename mkPackageOption to mkPluginPackageOption 2024-05-17 22:15:47 +02:00
Gaetan Lepage
3766e36335 lib/options: change "default: ..." to "Plugin default: ..." 2024-05-17 15:03:21 +02:00
Gaetan Lepage
7697a1cc5a lib/options: refactor 2024-05-17 15:03:21 +02:00
Gaetan Lepage
72ff1489c7 lib/options: make use of previously unused mkNullableWithRaw internally 2024-05-16 22:36:51 +02:00
traxys
62f32bfc71 treewide: Reformat with nixfmt 2024-05-05 22:00:40 +02:00
svl
8f9e35481f helpers/maintainers: add svl 2024-04-28 17:57:35 +02:00
theabm
b4a30dd1d6 lib/maintainers: add AndresBermeoMarinelli 2024-04-28 15:51:40 +02:00
Matt Sturgeon
21c233919d
output: format init.lua 2024-04-13 12:46:25 +01:00
Kareem-Medhat
3a4de0bb2f
plugins/coq-nvim: fix settings not being set when lsp is not enabled (#1408) 2024-04-13 13:36:45 +02:00
Gaetan Lepage
776cc84ad1 helpers/types: allow highlight.ctypes to accept a string 2024-04-13 11:00:19 +02:00
Gaetan Lepage
d348bb3e03 lib/types: factor out logLevel enum for standalone use 2024-04-07 11:30:24 +02:00