plugins/navbuddy: init + tests

[hmajid2301]

PR to add support for the [nvim-navbuddy](https://github.com/SmiteshP/nvim-navbuddy plugin

[hmajid2301]

How do I set the typing for key maps ?
For example we have:

 mappings = {
        ["<esc>"] = actions.close(),        -- Close and cursor to original location
        ["q"] = actions.close(),

        ["j"] = actions.next_sibling(),     -- down
}

[GaetanLepage]

You would map the keys to some actions (i.e. strings: close; next_sibling) and then you create the mappings from that yourself.
See

nixvim/plugins/utils/spider.nix

Lines 54 to 65 in 32a64af

	mappings =
	mapAttrs'
	(motion: key: {
	name = key;
	value = {
	action = "function() require('spider').motion('${motion}') end";
	lua = true;
	inherit (cfg.keymaps) silent;
	desc = "Spider-${motion}";
	};
	})
	cfg.keymaps.motions;

for inspiration.

[GaetanLepage]

Ok, I actually took the time to look at the plugin.
Actually, mappings is a plugin option itself.
We should not create the mappings using the nixvim maps option.
We should only provide the given mappings in the setupOptions attrs.

As for the option declaration, I would go for:

mappings =
  helpers.defaultNullOpts.mkNullable
  (with types;
    attrsOf
      (either
        str
        helpers.rawTypes
      )
    )
    ''
      {
        "<esc>" = "close";
        q = "close";
        ...
      }
    ''
    ''
      <Description>
      Mention that it can take either a `rawType` (for user liberty) or an action name.
    ''

Then, in the implementation,

setupOptions = with cfg; {
  ...
  mappings = ifNonNull' mappings
    (mapAttrs
      (key: action:
        if isString action
        then helpers.mkRaw "actions.${action}()"
        else action
    )
    mappings
  ...
} // cfg.extraOptions;

And, in extraConfigLua, add local actions = require("nvim-navbuddy.actions") before the call to setup().

Of course, you can get rid of the keymapsSilent option.

[hmajid2301]

Ok, I actually took the time to look at the plugin. Actually, mappings is a plugin option itself. We should not create the mappings using the nixvim maps option. We should only provide the given mappings in the setupOptions attrs.

As for the option declaration, I would go for:

mappings =
  helpers.defaultNullOpts.mkNullable
  (with types;
    attrsOf
      (either
        str
        helpers.rawTypes
      )
    )
    ''
      {
        "<esc>" = "close";
        q = "close";
        ...
      }
    ''
    ''
      <Description>
      Mention that it can take either a `rawType` (for user liberty) or an action name.
    ''

Then, in the implementation,

setupOptions = with cfg; {
  ...
  mappings = ifNonNull' mappings
    (mapAttrs
      (key: action:
        if isString action
        then helpers.mkRaw "actions.${action}()"
        else action
    )
    mappings
  ...
} // cfg.extraOptions;

And, in extraConfigLua, add local actions = require("nvim-navbuddy.actions") before the call to setup().

Of course, you can get rid of the keymapsSilent option.

Sorry for you needing to do that, im still trying to get my head around nix 😓.

[GaetanLepage]

No worry !

And, in extraConfigLua, add local actions = require("nvim-navbuddy.actions") before the call to setup().

Don't forget this :)

[GaetanLepage]

Suggested change

	enabled = helpers.defaultNullOpts.mkBool true;
	icons = {
	leaf = helpers.defaultNullOpts.mkStr " " ''
	The icon to use for leaf nodes.
	'';
	leaf_selected = helpers.defaultNullOpts.mkStr " → " ''
	The icon to use for selected leaf node.
	'';
	branch = helpers.defaultNullOpts.mkStr "  " ''
	The icon to use for branch nodes.
	'';
	};
	enabled = helpers.defaultNullOpts.mkBool true "Enable node markers.";
	icons = {
	leaf = helpers.defaultNullOpts.mkStr " " ''
	The icon to use for leaf nodes.
	'';
	leaf_selected = helpers.defaultNullOpts.mkStr " → " ''
	The icon to use for selected leaf node.
	'';
	branch = helpers.defaultNullOpts.mkStr "  " ''
	The icon to use for branch nodes.
	'';
	};

[GaetanLepage]

Also, leaf_selected -> leafSelected. We use camelCase for all of our options.
Don't forget to write leaf_selected = leafSelected in the config section below.

[hmajid2301]

ahh yes ofc course will add this change then update in setup options

[GaetanLepage]

And don't forget to change it in the test.

[GaetanLepage]

mkBorder is wrongly called here and elsewhere as well.
It expects the default value for the option, the name of what the borders are for and an optional description for this option (you can simply provide "" if you don't want to provide it).

Function declaration:

nixvim/lib/helpers.nix

Line 140 in 05b7773

mkBorder = default: name: desc:

Examples of how it is properly used: https://github.com/search?q=repo%3Anix-community%2Fnixvim%20mkBorder&type=code

[hmajid2301]

hahah yeh I just saw this error running the nix flake check locally.

Ahh I see I though it was like an enum, not sure why! Fixing now.

[GaetanLepage]

Be careful, there are two icons options. The one with leafSelected is inside nodeMarkers.

[GaetanLepage]

A few last formatting changes.

[hmajid2301]

Thanks for all the help with this pR. I hope the next few I will be able to do mostly on my own!!! (ROI)

[GaetanLepage]

Thanks for all the help with this pR. I hope the next few I will be able to do mostly on my own!!! (ROI)

Thank you for your contribution ! It is really welcomed.
I am sure that it will get easier and easier for you now :)