investigate improving plugin display names in the lazy dashboard. update the TODOs and README to reflect that this isn't possible

Author: b-src

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
 
+## [Unreleased]
+
+### Docs
+
+- Add note about plugin display names in the Lazy dashboard
+
+
 ## [0.2.0] - 2023-12-26
 
 ### Features

README.md

@@ -193,6 +193,17 @@ Don't forget to update each plugin's dependencies as well
 }
 ```
 
+**Note on Plugin Names in Lazy Dashboard**
+
+When you open the lazy dashboard with `:Lazy`, each plugin's display name is determined by its directory path. Using nix store paths, this becomes difficult to read because each plugin name is prepended with it's hash. As far as I'm aware there's no way to fix this.
+
+Lazy provides the `name` option for plugin config which sets a custom display name for the plugin, but this also:
+ - sets a custom directory path for the plugin
+ - uses the custom name to try to find the plugins `setup()` function
+
+Even with a `dir` configured, setting `name` will break plugin setup.
+
+
 ### Mason
 
 Mason is a package manager for LSP servers, DAP servers, linters, and formatters. Just like plugin management with Lazy, this conflicts with Nix. The easiest way to keep mason in your config on non-Nix platforms while disabling it on NixOS is to use the provided `mason_enabled` function to conditionally enable Mason.

TODO.md

@@ -11,7 +11,8 @@
         can we let the user supply "my-plugin" while also checking the store for
         e.g. "My-Plugin", "my_plugin", "my-plugin.nvim"...
 - [x] figure out how to play nicely with mason
-- [ ] see if there's a way to improve plugin name display in the lazy dashboard (i.e. plugin name, not full nix store path)
+- [x] see if there's a way to improve plugin name display in the lazy dashboard (i.e. plugin name, not full nix store path)
+        there is not. see the `Configuration of Other Plugins` section in the README for more details
 
 ## Configuration