standardize program options with mkFormatterModule

[zimbatm]

A common complaint / observation is that treefmt-nix config tend to be a mix between enabled programs, and treefmt settings to override includes/excludes/priority. Some programs have those options available directly, but not all of them.

In order to fix that, this commit introduces mkFormatterModule, a function that generates a regular module structure based on a few parameters. And that support the includes / excludes / priority out of the box.

A few of the programs are already converted to that format. Ideally all of them are getting converted soon.

[zimbatm]

Ok this is ready. I was able to convert all the formatters except mypy that does some funky stuff.

Looking for feedback from all the maintainers since this changes all the modules. /cc @anntnzrb @sebaszv @haruki7049 @gabyx @SigmaSquadron @adam-gaia @RossSmyth @JakobLichterfeld

[phaer]

Very nice! Seems to work, much less boilerplate code but same features and a cleaner interface.

Just curious if you did use any tooling for the module changes or did that all "by hand"?

[sebaszv]

This was something I did pick up on as being an annoyance. Glad this is standardised now. LGTM 👍

[SigmaSquadron]

Sorry for missing this. Looks superb; it makes a lot of sense to abstract all of the simpler module definitions. Thanks!

[anntnzrb]

✔️ Great refactor, contributions should be even easier now.

[mcsimw]

These two commits broke the flake-parts module.

[phaer]

Bug reports are more useful if they contain info on what breaks and how that breakage might be reproducible. :)

It seems to be broken indeed, runs into infinite recursion while evaluating the module arg

       … while evaluating the module argument `mkFormatterModule' in "/nix/store/qa
r0bxqnnbl6j6i3yh34h73xafah1bi5-source/programs/actionlint.nix":

       (stack trace truncated; use '--show-trace' to show the full, detailed trace)

       error: infinite recursion encountered
       at /nix/store/j0jlb33bm31w347w43051hbffgh616jr-source/lib/modules.nix:506:28
:
          505|         builtins.addErrorContext (context name)
          506|           (args.${name} or config._module.args.${name})
             |                            ^
          507|       ) (lib.functionArgs f);

Can be reproduced by i.e. nix flake update treefmt-nix in https://github.com/nix-community/buildbot-nix or most probably any other repo using treefmt-nix and flake.parts

[roberth]

Missing specialArgs tend to cause infinite recursions.
The flake-parts module doesn't use this entrypoint.
You could add the specialArgs to this submoduleWith call

treefmt-nix/flake-module.nix

Line 35 in 3b0afa7

type = types.submoduleWith {

Alternatively, you could perhaps go through the main entrypoint and get the type returned by that evalModules call. It should be equivalent to the aforementioned submoduleWith call's return value.

[JakobLichterfeld]

Nice refactoring, checked the dart-format part. lgtm beside of the flake-parts issue, see #288 (comment)

[gabyx]

@zimbatm : Right this change does not change user facing treefmt.nix code?

[gabyx]

@zimbatm : great improvement.