Skip to content

Commit 7e07b97

Browse files
committed
update troubleshooting info in README
1 parent f114479 commit 7e07b97

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The configuration instructions below include code that will install Lazy-Nix-Hel
6868
+ treats `-` and `_` as identical
6969
+ add or subtracts `.nvim` from the plugin name as needed
7070

71-
in most cases setting this to true will make updating your configuration much easier. if there is a plugin name collision with these rules applied then lazy-nix-helper will thrown an error. in that case you will have to set this option to false and match plugin names exactly.
71+
if there is a plugin name collision with these rules applied then lazy-nix-helper will thrown an error. in that case you will have to set this option to false and match plugin names exactly.
7272

7373
- `auto_plugin_discovery`: when set to `true` enables the automatic plugin discovery originally included in Lazy-Nix-Helper. the automatic plugin discovery is a nix anti-pattern and only works for a subset of nix/nixos use cases and config arrangements. this option has been left in place to let early adopters of Lazy-Nix-Helper keep their original configuration, but it should be set to `false` for all new configurations
7474
- `input_plugin_table`: the plugin table mapping plugin names to plugin paths generated by your nix config. instructions for generating this table are provided in the NixOS Configuration section
@@ -400,19 +400,23 @@ Besides Lazy-Nix-Helper there are other tools and strategies you might choose to
400400

401401
Use the `:Lazy` command to open the Lazy dashboard. The source directory is listed for each plugin
402402

403-
### How do I check which path Lazy-Nix-Helper has found for a plugin?
403+
### How do I check the plugin list that was supplied to Lazy-Nix-Helper?
404404

405-
Run the `get_plugin_path` function manually: `:lua print(require("lazy-nix-helper").get_plugin_path("<plugin-name>"))`
405+
Run the `list_input_plugins` function manually: `lua require("lazy-nix-helper").list_input_plugins()`
406406

407-
### How do I check all of the plugins that Lazy-Nix-Helper has found?
407+
### How do I check which plugins were found on the system by Lazy-Nix-Helper?
408408

409409
Run the `list_discovered_plugins` function manually: `lua require("lazy-nix-helper").list_discovered_plugins()`
410410

411+
### How do I check which path Lazy-Nix-Helper has found for a plugin?
412+
413+
Run the `get_plugin_path` function manually: `:lua print(require("lazy-nix-helper").get_plugin_path("<plugin-name>"))`
414+
411415
### I don't think Lazy-Nix-Helper is correctly detecting when I'm on NixOS
412416

413417
Run the `print_environment_info` function manually to see:
414418
- if Lazy-Nix-Helper thinks you're on NixOS or not
415-
- if Lazy-Nix-Helper thinks nix-store is installed or not
419+
- if Lazy-Nix-Helper thinks nix-store is installed or not (only relevant for legacy automatic plugin discovery)
416420

417421
`lua require("lazy-nix-helper").print_environment_info()`
418422

0 commit comments

Comments
 (0)