feat(module): add meta.maintainers attribute (#205)

The larger the list of formatters, the harder it is for the treefmt-nix
maintainers to have domain-knowledge for all of them.

This change was prompted by #201 where a nixpkgs bump broke
swift-format.

This gives us information on who is responsible for a specific
maintainer and that we can ping.

Author: zimbatm

README.md

@@ -336,8 +336,9 @@ PRs to add new formatters are welcome!
 In order to add a new formatter do the following things:
 
 1. Create a new entry in the `./programs/` folder.
-2. Run `./examples.sh` to update the `./examples` folder.
-3. To test the program:
+2. Consider adding yourself as the `meta.maintainer` (see below).
+3. Run `./examples.sh` to update the `./examples` folder.
+4. To test the program:
    1. Extend the project's `./treefmt.nix` file (temporarily) to enable the new
       formatter and configure it in whatever manner is appropriate.
    2. Add a bunch of pertinent sources in this repo -- for instance, if the new
@@ -348,7 +349,17 @@ In order to add a new formatter do the following things:
       badly-formatted files are flagged as such. Re-run `nix fmt` and confirm
       that no additional changes were made.
    4. Once this is good, revert those changes.
-4. Submit the PR!
+5. Submit the PR!
+
+### Definition of a `meta.maintainer`
+
+You can register your desire to help with a specific formatter by adding your
+GitHub handle to the module's `meta.maintainers` list.
+
+That mostly means, for the given formatter:
+
+- You get precedence if any decisions need to be made.
+- Getting pinged if any issue is being found.
 
 ## Commercial support
 

module-options.nix

@@ -117,6 +117,21 @@ in
       default = true;
     };
 
+    # Meta attributes
+    meta = {
+      maintainers = lib.mkOption {
+        type = lib.types.listOf lib.types.str;
+        internal = true;
+        default = [ ];
+        example = lib.literalExpression ''[ "zimbatm" ]'';
+        description = ''
+          List of github users responsible for a formatter.
+
+          This option should be defined at most once per module.
+        '';
+      };
+    };
+
     # Outputs
     build = {
       devShell = mkOption {

programs/actionlint.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.actionlint;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.actionlint = {
     enable = lib.mkEnableOption "actionlint";
     package = lib.mkPackageOption pkgs "actionlint" { };

programs/alejandra.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.alejandra;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.alejandra = {
     enable = lib.mkEnableOption "alejandra";
     package = lib.mkPackageOption pkgs "alejandra" { };

programs/asmfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.asmfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.asmfmt = {
     enable = lib.mkEnableOption "asmfmt";
     package = lib.mkPackageOption pkgs "asmfmt" { };

programs/beautysh.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.beautysh;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.beautysh = {
     enable = lib.mkEnableOption "beautysh";
     package = lib.mkPackageOption pkgs "beautysh" { };

programs/dhall.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.dhall;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.dhall = {
     enable = lib.mkEnableOption "Dhall";
     lint = lib.mkOption {

programs/dos2unix.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.dos2unix;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.dos2unix = {
     enable = lib.mkEnableOption "dos2unix";
     package = lib.mkPackageOption pkgs "dos2unix" { };

programs/dprint.nix

@@ -96,6 +96,8 @@ let
       null;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.dprint = {
     enable = mkEnableOption "dprint";
     package = mkPackageOption pkgs "dprint" { };

programs/elm-format.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.elm-format;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.elm-format = {
     enable = lib.mkEnableOption "elm-format";
 

programs/erlfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.erlfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.erlfmt = {
     enable = lib.mkEnableOption "erlfmt";
     package = lib.mkPackageOption pkgs "erlfmt" { };

programs/fantomas.nix

@@ -1,6 +1,8 @@
 { lib, pkgs, config, ... }:
 let cfg = config.programs.fantomas;
 in {
+  meta.maintainers = [ ];
+
   options.programs.fantomas = {
     enable = lib.mkEnableOption "fantomas";
     package = lib.mkPackageOption pkgs "fantomas" { };

programs/fnlfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.fnlfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.fnlfmt = {
     enable = lib.mkEnableOption "fnlfmt";
     package = lib.mkPackageOption pkgs "fnlfmt" { };

programs/formatjson5.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.formatjson5;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.formatjson5 = {
     enable = lib.mkEnableOption "formatjson5";
     package = lib.mkPackageOption pkgs "formatjson5" { };

programs/fourmolu.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.fourmolu;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.fourmolu = {
     enable = lib.mkEnableOption "fourmolu";
     package = lib.mkOption {

programs/fprettify.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.fprettify;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.fprettify = {
     enable = lib.mkEnableOption "fprettify";
     package = lib.mkPackageOption pkgs "fprettify" { };

programs/gdformat.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.gdformat;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.gdformat = {
     enable = lib.mkEnableOption "gdformat";
     package = lib.mkPackageOption pkgs "gdtoolkit_4" { };

programs/gofmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.gofmt;
 in
 {
+  meta.maintainers = [ "zimbatm" ];
+
   options.programs.gofmt = {
     enable = lib.mkEnableOption "gofmt";
     package = lib.mkPackageOption pkgs "go" { };

programs/gofumpt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.gofumpt;
 in
 {
+  meta.maintainers = [ "zimbatm" ];
+
   options.programs.gofumpt = {
     enable = lib.mkEnableOption "gofumpt";
     package = lib.mkPackageOption pkgs "gofumpt" { };

programs/google-java-format.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.google-java-format;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.google-java-format = {
     enable = lib.mkEnableOption "google-java-format";
     package = lib.mkPackageOption pkgs "google-java-format" { };

programs/hclfmt.nix

@@ -4,6 +4,8 @@ let
   cfg = config.programs.hclfmt;
 in
 {
+  meta.maintainers = [ "zimbatm" ];
+
   options.programs.hclfmt = {
     enable = lib.mkEnableOption "hclfmt";
     package = lib.mkPackageOption pkgs "hclfmt" { };

programs/hlint.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.hlint;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.hlint = {
     enable = lib.mkEnableOption "hlint";
     package = lib.mkPackageOption pkgs "hlint" { };

programs/isort.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.isort;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.isort = {
     enable = lib.mkEnableOption "isort";
     package = lib.mkPackageOption pkgs "isort" { };

programs/jsonfmt.nix

@@ -1,6 +1,8 @@
 { lib, pkgs, config, ... }:
 let cfg = config.programs.jsonfmt;
 in {
+  meta.maintainers = [ ];
+
   options.programs.jsonfmt = {
     enable = lib.mkEnableOption "jsonfmt";
     package = lib.mkPackageOption pkgs "jsonfmt" { };

programs/jsonnet-lint.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.jsonnet-lint;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.jsonnet-lint = {
     enable = lib.mkEnableOption "jsonnet";
     package = lib.mkPackageOption pkgs "go-jsonnet" { };

programs/jsonnetfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.jsonnetfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.jsonnetfmt = {
     enable = lib.mkEnableOption "jsonnet";
     package = lib.mkPackageOption pkgs "go-jsonnet" { };

programs/just.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.just;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.just = {
     enable = lib.mkEnableOption "just";
     package = lib.mkPackageOption pkgs "just" { };

programs/keep-sorted.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.keep-sorted;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.keep-sorted = {
     enable = lib.mkEnableOption "keep-sorted";
     package = lib.mkPackageOption pkgs "keep-sorted" { };

programs/ktfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.ktfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.ktfmt = {
     enable = lib.mkEnableOption "ktfmt";
     package = lib.mkPackageOption pkgs "ktfmt" { };

programs/ktlint.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.ktlint;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.ktlint = {
     enable = lib.mkEnableOption "ktlint";
     package = lib.mkPackageOption pkgs "ktlint" { };

programs/leptosfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.leptosfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.leptosfmt = {
     enable = lib.mkEnableOption "leptosfmt";
     package = lib.mkPackageOption pkgs "leptosfmt" { };

programs/mdformat.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.mdformat;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.mdformat = {
     enable = lib.mkEnableOption "mdformat";
     package = lib.mkPackageOption pkgs [ "python3Packages" "mdformat" ] { };

programs/mdsh.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.mdsh;
 in
 {
+  meta.maintainers = [ "zimbatm" ];
+
   options.programs.mdsh = {
     enable = lib.mkEnableOption "mdsh";
     package = lib.mkPackageOption pkgs "mdsh" { };

programs/mix-format.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.mix-format;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.mix-format = {
     enable = lib.mkEnableOption "mix-format";
     package = lib.mkPackageOption pkgs "elixir" { };

programs/muon.nix

@@ -7,6 +7,8 @@ let
   cfg = config.programs.muon;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.muon = {
     enable = lib.mkEnableOption "muon";
     package = lib.mkPackageOption pkgs "muon" { };

programs/mypy.nix

@@ -1,5 +1,7 @@
 { lib, pkgs, config, ... }:
 {
+  meta.maintainers = [ ];
+
   options.programs.mypy = {
     enable = lib.mkEnableOption "mypy";
     package = lib.mkPackageOption pkgs "mypy" { };

programs/nickel.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.nickel;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.nickel = {
     enable = lib.mkEnableOption "nickel";
     package = lib.mkPackageOption pkgs "nickel" { };

programs/nimpretty.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.nimpretty;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.nimpretty = {
     enable = lib.mkEnableOption "nimpretty";
     package = lib.mkPackageOption pkgs "nim" { };

programs/nixfmt-rfc-style.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.nixfmt-rfc-style;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.nixfmt-rfc-style = {
     enable = lib.mkEnableOption "nixfmt-rfc-style";
     package = lib.mkPackageOption pkgs "nixfmt-rfc-style" { };

programs/nixfmt.nix

@@ -3,6 +3,8 @@ let
   cfg = config.programs.nixfmt;
 in
 {
+  meta.maintainers = [ ];
+
   options.programs.nixfmt = {
     enable = lib.mkEnableOption "nixfmt";
     package = lib.mkPackageOption pkgs "nixfmt-rfc-style" { };