doc: align module capitalization (#1115)

Closes: https://github.com/danth/stylix/issues/1084 Link: https://github.com/danth/stylix/pull/1115 Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com> Reviewed-by: Daniel Thwaites <danth@danth.me> Reviewed-by: awwpotato <153149335+awwpotato@users.noreply.github.com>
2025-04-10 02:45:51 -04:00 · 2025-04-10 02:45:51 -04:00 · 82f67a36eb
commit 82f67a36eb
parent 31fdf60634
90 changed files with 127 additions and 20 deletions
--- a/docs/default.nix
+++ b/docs/default.nix
@ -134,18 +134,34 @@ let
                path = "${inputs.self}/modules/${module}/README.md";

                # This doesn't count as IFD because ${inputs.self} is a flake input
+                #
+                # In addition, this checks that the README.md starts with an
+                # appropriate title
                mainText =
+                  let
+                    name = lib.throwIfNot (
+                      metadata ? ${module}.name
+                    ) "stylix: ${module} is missing `meta.name`" metadata.${module}.name;
+                  in
                  if builtins.pathExists path then
-                    builtins.readFile path
+                    let
+                      text = builtins.readFile path;
+                    in
+                    lib.throwIfNot (
+                      (builtins.head (lib.splitString "\n" text)) == "# ${name}"
+                    ) "README.md of ${name} must have a title which matches its `meta.name`" text
                  else
                    ''
-                      # ${module}
+                      # ${name}
                      > [!NOTE]
                      > This module doesn't include any additional documentation.
                      > You can browse the options it provides below.
                    '';

-                inherit (metadata.${module}) maintainers;
+                maintainers =
+                  lib.throwIfNot (metadata ? ${module}.maintainers)
+                    "stylix: ${module} is missing `meta.maintainers`"
+                    metadata.${module}.maintainers;

                # Render a maintainer's name and a link to the best contact
                # information we have for them.
--- a/docs/src/modules.md
+++ b/docs/src/modules.md
@ -145,10 +145,17 @@ slow and should be avoided.
 For everything else, like fonts and wallpapers, you can just take option values
 directly from `config`. See the reference pages for a list of options.

-## Maintainers
+## Metadata

-New modules must have at least one maintainer defined in
-`/modules/«module»/meta.nix`.
+Metadata is stored in `/modules/«module»/meta.nix`. The following attributes are
+available under `meta`:
+
+- `maintainers`: required list of maintainers. See [Maintainers](#maintainers) section.
+- `name`: required human-readable string name.
+
+### Maintainers
+
+New modules must have at least one maintainer.

 If you are not already listed in the Nixpkgs `/maintainers/maintainer-list.nix`
 maintainer list, add yourself to `/stylix/maintainers.nix`.
--- a/modules/alacritty/meta.nix
+++ b/modules/alacritty/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Alacritty";
 }
--- a/modules/avizo/meta.nix
+++ b/modules/avizo/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Avizo";
 }
--- a/modules/bat/meta.nix
+++ b/modules/bat/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "bat";
 }
--- a/modules/bemenu/meta.nix
+++ b/modules/bemenu/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "bemenu";
 }
--- a/modules/bspwm/meta.nix
+++ b/modules/bspwm/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "bspwm";
 }
--- a/modules/btop/meta.nix
+++ b/modules/btop/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "btop";
 }
--- a/modules/cava/meta.nix
+++ b/modules/cava/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Cava";
 }
--- a/modules/cavalier/meta.nix
+++ b/modules/cavalier/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Cavalier";
 }
--- a/modules/chromium/meta.nix
+++ b/modules/chromium/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Chromium";
 }
--- a/modules/console/meta.nix
+++ b/modules/console/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "kernel console";
 }
--- a/modules/discord/meta.nix
+++ b/modules/discord/meta.nix
@ -1,4 +1,5 @@
 { lib, ... }:
 {
  maintainers = [ lib.maintainers.Flameopathic ];
+  name = "Discord";
 }
--- a/modules/dunst/meta.nix
+++ b/modules/dunst/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Dunst";
 }
--- a/modules/emacs/meta.nix
+++ b/modules/emacs/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Emacs";
 }
--- a/modules/eog/meta.nix
+++ b/modules/eog/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Eye of GNOME";
 }
--- a/modules/fcitx5/meta.nix
+++ b/modules/fcitx5/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Fcitx 5";
 }
--- a/modules/feh/meta.nix
+++ b/modules/feh/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "feh";
 }
--- a/modules/firefox/meta.nix
+++ b/modules/firefox/meta.nix
@ -1,4 +1,5 @@
 { lib, ... }:
 {
  maintainers = [ lib.maintainers.Flameopathic ];
+  name = "Firefox and its derivatives";
 }
--- a/modules/fish/meta.nix
+++ b/modules/fish/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "fish";
 }
--- a/modules/fnott/meta.nix
+++ b/modules/fnott/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Fnott";
 }
--- a/modules/foot/meta.nix
+++ b/modules/foot/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "foot";
 }
--- a/modules/forge/meta.nix
+++ b/modules/forge/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Forge";
 }
--- a/modules/fuzzel/meta.nix
+++ b/modules/fuzzel/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Fuzzel";
 }
--- a/modules/fzf/meta.nix
+++ b/modules/fzf/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "fzf";
 }
--- a/modules/gedit/meta.nix
+++ b/modules/gedit/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "gedit";
 }
--- a/modules/ghostty/meta.nix
+++ b/modules/ghostty/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Ghostty";
 }
--- a/modules/gitui/meta.nix
+++ b/modules/gitui/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "GitUI";
 }
--- a/modules/glance/meta.nix
+++ b/modules/glance/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Glance";
 }
--- a/modules/gnome-text-editor/meta.nix
+++ b/modules/gnome-text-editor/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "GNOME Text Editor";
 }
--- a/modules/gnome/meta.nix
+++ b/modules/gnome/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "GNOME";
 }
--- a/modules/grub/meta.nix
+++ b/modules/grub/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "GRUB";
 }
--- a/modules/gtk/meta.nix
+++ b/modules/gtk/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "GTK";
 }
--- a/modules/halloy/meta.nix
+++ b/modules/halloy/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Halloy";
 }
--- a/modules/helix/meta.nix
+++ b/modules/helix/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Helix";
 }
--- a/modules/hyprland/meta.nix
+++ b/modules/hyprland/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Hyprland";
 }
--- a/modules/hyprlock/meta.nix
+++ b/modules/hyprlock/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "hyprlock";
 }
--- a/modules/hyprpaper/meta.nix
+++ b/modules/hyprpaper/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "hyprpaper";
 }
--- a/modules/i3/meta.nix
+++ b/modules/i3/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "i3";
 }
--- a/modules/i3status-rust/meta.nix
+++ b/modules/i3status-rust/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "i3status-rust";
 }
--- a/modules/k9s/meta.nix
+++ b/modules/k9s/meta.nix
@ -1,4 +1,5 @@
 { lib, ... }:
 {
  maintainers = [ lib.maintainers.cluther ];
+  name = "K9s";
 }
--- a/modules/kde/meta.nix
+++ b/modules/kde/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "KDE";
 }
--- a/modules/kitty/meta.nix
+++ b/modules/kitty/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "kitty";
 }
--- a/modules/kmscon/meta.nix
+++ b/modules/kmscon/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Kmscon";
 }
--- a/modules/kubecolor/meta.nix
+++ b/modules/kubecolor/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Kubecolor";
 }
--- a/modules/lazygit/meta.nix
+++ b/modules/lazygit/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Lazygit";
 }
--- a/modules/lightdm/meta.nix
+++ b/modules/lightdm/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "LightDM";
 }
--- a/modules/mako/meta.nix
+++ b/modules/mako/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "mako";
 }
--- a/modules/mangohud/meta.nix
+++ b/modules/mangohud/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "MangoHud";
 }
--- a/modules/micro/meta.nix
+++ b/modules/micro/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "micro";
 }
--- a/modules/mpv/meta.nix
+++ b/modules/mpv/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "mpv";
 }
--- a/modules/ncspot/meta.nix
+++ b/modules/ncspot/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "ncspot";
 }
--- a/modules/neovim/README.md
+++ b/modules/neovim/README.md
@ -8,8 +8,8 @@ This module themes [Neovim] using the standard Home Manager options.

 - [Vim](vim.md): themes Vim using the standard Home Manager options.
 - [Nixvim](nixvim.md): themes Neovim using the options provided by [Nixvim].
- [NVF](nvf.md): themes Neovim using the options provided by [NVF].
+- [nvf](nvf.md): themes Neovim using the options provided by [nvf].

 [Neovim]: https://neovim.io
 [Nixvim]: https://github.com/nix-community/nixvim#readme
-[NVF]: https://github.com/NotAShelf/nvf#readme
+[nvf]: https://github.com/NotAShelf/nvf#readme
--- a/modules/neovim/meta.nix
+++ b/modules/neovim/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Neovim";
 }
--- a/modules/nixos-icons/meta.nix
+++ b/modules/nixos-icons/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "NixOS Icons";
 }
--- a/modules/nixvim/README.md
+++ b/modules/nixvim/README.md
@ -1,6 +1,6 @@
-# Nixvim
+# NixVim

-This module themes [Neovim] using the options provided by [Nixvim].
+This module themes [Neovim] using the options provided by [NixVim].

 > [!IMPORTANT]
 > This module will have no effect unless the desired Nixvim module is properly
@ -18,8 +18,8 @@ This module themes [Neovim] using the options provided by [Nixvim].

 - [Vim](vim.md): themes Vim using the standard Home Manager options.
 - [Neovim](neovim.md): themes Neovim using the standard Home Manager options.
- [NVF](nvf.md): themes Neovim using the options provided by [NVF].
+- [nvf](nvf.md): themes Neovim using the options provided by [nvf].

 [Neovim]: https://neovim.io
-[Nixvim]: https://github.com/nix-community/nixvim#readme
-[NVF]: https://github.com/NotAShelf/nvf#readme
+[NixVim]: https://github.com/nix-community/nixvim#readme
+[nvf]: https://github.com/NotAShelf/nvf#readme
--- a/modules/nixvim/meta.nix
+++ b/modules/nixvim/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "NixVim";
 }
--- a/modules/nushell/meta.nix
+++ b/modules/nushell/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Nushell";
 }
--- a/modules/nvf/README.md
+++ b/modules/nvf/README.md
@ -1,16 +1,16 @@
-# NVF
+# nvf

-This module themes [Neovim] using the options provided by [NVF].
+This module themes [Neovim] using the options provided by [nvf].

 > [!IMPORTANT]
-> This module will have no effect unless the desired NVF module is properly
+> This module will have no effect unless the desired nvf module is properly
 > [installed](https://notashelf.github.io/nvf/index.xhtml#ch-installation)
 > and
 > [imported](https://notashelf.github.io/nvf/index.xhtml#ch-module-installation)
 > into your configuration.
 >
 > Ensure you are configuring this module on the same platform (NixOS, Home
-> Manager, Darwin) as where you installed NVF.
+> Manager, Darwin) as where you installed nvf.

 ## Related modules

@ -22,4 +22,4 @@ This module themes [Neovim] using the options provided by [NVF].

 [Neovim]: https://neovim.io
 [Nixvim]: https://github.com/nix-community/nixvim#readme
-[NVF]: https://github.com/NotAShelf/nvf#readme
+[nvf]: https://github.com/NotAShelf/nvf#readme
--- a/modules/nvf/meta.nix
+++ b/modules/nvf/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "nvf";
 }
--- a/modules/plymouth/meta.nix
+++ b/modules/plymouth/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Plymouth";
 }
--- a/modules/qt/meta.nix
+++ b/modules/qt/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Qt";
 }
--- a/modules/qutebrowser/meta.nix
+++ b/modules/qutebrowser/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "qutebrowser";
 }
--- a/modules/regreet/meta.nix
+++ b/modules/regreet/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "ReGreet";
 }
--- a/modules/rio/meta.nix
+++ b/modules/rio/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Rio";
 }
--- a/modules/river/meta.nix
+++ b/modules/river/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "river";
 }
--- a/modules/rofi/meta.nix
+++ b/modules/rofi/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Rofi";
 }
--- a/modules/spicetify/meta.nix
+++ b/modules/spicetify/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Spicetify";
 }
--- a/modules/starship/meta.nix
+++ b/modules/starship/meta.nix
@ -1,4 +1,5 @@
 { lib, ... }:
 {
  maintainers = [ lib.maintainers.cluther ];
+  name = "starship";
 }
--- a/modules/sway/meta.nix
+++ b/modules/sway/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Sway";
 }
--- a/modules/swaylock/meta.nix
+++ b/modules/swaylock/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "swaylock";
 }
--- a/modules/swaync/meta.nix
+++ b/modules/swaync/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "SwayNotificationCenter";
 }
--- a/modules/sxiv/meta.nix
+++ b/modules/sxiv/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "sxiv";
 }
--- a/modules/tmux/meta.nix
+++ b/modules/tmux/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "tmux";
 }
--- a/modules/tofi/meta.nix
+++ b/modules/tofi/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Tofi";
 }
--- a/modules/vim/README.md
+++ b/modules/vim/README.md
@ -8,8 +8,8 @@ This module themes [Vim] using the standard Home Manager options.

 - [Neovim](neovim.md): themes Neovim using the standard Home Manager options.
 - [Nixvim](nixvim.md): themes Neovim using the options provided by [Nixvim].
- [NVF](nvf.md): themes Neovim using the options provided by [NVF].
+- [nvf](nvf.md): themes Neovim using the options provided by [nvf].

 [Vim]: https://www.vim.org
 [Nixvim]: https://github.com/nix-community/nixvim#readme
-[NVF]: https://github.com/NotAShelf/nvf#readme
+[nvf]: https://github.com/NotAShelf/nvf#readme
--- a/modules/vim/meta.nix
+++ b/modules/vim/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Vim";
 }
--- a/modules/vscode/meta.nix
+++ b/modules/vscode/meta.nix
@ -1,4 +1,5 @@
 { lib, ... }:
 {
  maintainers = [ lib.maintainers.Flameopathic ];
+  name = "VSCode";
 }
--- a/modules/waybar/meta.nix
+++ b/modules/waybar/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Waybar";
 }
--- a/modules/wayfire/meta.nix
+++ b/modules/wayfire/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Wayfire";
 }
--- a/modules/wezterm/meta.nix
+++ b/modules/wezterm/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "WezTerm";
 }
--- a/modules/wob/meta.nix
+++ b/modules/wob/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "wob";
 }
--- a/modules/wofi/meta.nix
+++ b/modules/wofi/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Wofi";
 }
--- a/modules/wpaperd/meta.nix
+++ b/modules/wpaperd/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "wpaperd";
 }
--- a/modules/xfce/meta.nix
+++ b/modules/xfce/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Xfce";
 }
--- a/modules/xresources/meta.nix
+++ b/modules/xresources/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Xresources file";
 }
--- a/modules/yazi/meta.nix
+++ b/modules/yazi/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Yazi";
 }
--- a/modules/zathura/meta.nix
+++ b/modules/zathura/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "zathura";
 }
--- a/modules/zed/meta.nix
+++ b/modules/zed/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Zed";
 }
--- a/modules/zellij/meta.nix
+++ b/modules/zellij/meta.nix
@ -1,3 +1,4 @@
 {
  maintainers = [ ];
+  name = "Zellij";
 }