From 244002975700ec494548c48502520517dc2ef008 Mon Sep 17 00:00:00 2001 From: matt1432 Date: Mon, 20 Jan 2025 11:40:34 -0500 Subject: [PATCH] docs: add descriptions to devShells --- devShells/flake/default.nix | 4 ++++ devShells/neovim-shells/default.nix | 12 +++++++++--- devShells/netdaemon/default.nix | 4 ++++ devShells/node/default.nix | 4 ++++ devShells/subtitle-dev/default.nix | 4 ++++ 5 files changed, 25 insertions(+), 3 deletions(-) diff --git a/devShells/flake/default.nix b/devShells/flake/default.nix index 56336eb4..bb71d3ea 100644 --- a/devShells/flake/default.nix +++ b/devShells/flake/default.nix @@ -43,4 +43,8 @@ mkShell { ''; }) ]; + + meta.description = '' + Shell providing some utility scripts concerning the main flake. + ''; } diff --git a/devShells/neovim-shells/default.nix b/devShells/neovim-shells/default.nix index e55e44ea..295a5bb1 100644 --- a/devShells/neovim-shells/default.nix +++ b/devShells/neovim-shells/default.nix @@ -5,9 +5,15 @@ }: let inherit (pkgs.lib) listToAttrs nameValuePair; mkLangsShells = langs: - listToAttrs (map (l: - nameValuePair l (pkgs.callPackage "${self}/homeManagerModules/neovim/langs/${l}/shell.nix" {inherit self;})) - langs); + listToAttrs (map ( + l: + nameValuePair + l + ((pkgs.callPackage "${self}/homeManagerModules/neovim/langs/${l}/shell.nix" {inherit self;}).overrideAttrs (o: { + meta.description = "${l} shell to be loaded by my Neovim config dynamically."; + })) + ) + langs); in mkLangsShells [ "csharp" diff --git a/devShells/netdaemon/default.nix b/devShells/netdaemon/default.nix index 7575abfa..75c41de6 100644 --- a/devShells/netdaemon/default.nix +++ b/devShells/netdaemon/default.nix @@ -7,4 +7,8 @@ mkShell { packages = [ dotnetCorePackages.sdk_9_0 ]; + + meta.description = '' + Shell that makes sure we have the right dotnet-sdk version for NetDaemon development. + ''; } diff --git a/devShells/node/default.nix b/devShells/node/default.nix index 5a3e705a..f9a22ec5 100644 --- a/devShells/node/default.nix +++ b/devShells/node/default.nix @@ -11,4 +11,8 @@ mkShell { nodejs_latest typescript ]; + + meta.description = '' + Shell that provides `bumpNpmDeps`, node and typescript. + ''; } diff --git a/devShells/subtitle-dev/default.nix b/devShells/subtitle-dev/default.nix index 3365ba8c..92678278 100644 --- a/devShells/subtitle-dev/default.nix +++ b/devShells/subtitle-dev/default.nix @@ -16,4 +16,8 @@ mkShell { bumpNpmDeps ]; + + meta.description = '' + Shell that provides the dependencies for my subtitle management scripts. + ''; }