broot: use upstream defaults, allow all config options

[dermetfan]

Description

The module did not allow to set all possible config options. It is now a freeform module in addition to the typed options that were already declared.

Default verbs were hard-coded and out of date (closes #2395) and therefore a maintenance burden. The default config from upstream is now used. Unfortunately this requires IFD.

I also changed the shell functions to be generated using IFD while I was at it so they won't have to be manually updated in the future. I do realize this may not be desired because they probably do not change often. I am fully happy removing that commit if anyone wishes.

Checklist

• Change is backwards compatible.
  Partly: The Nix options interface is, but the resulting config file will be based on upstream's defaults now.

• Code formatted with ./format.

• Code tested through nix-shell --pure tests -A run.all.

• Test cases updated/added. See example.

• Commit messages are formatted like

  {component}: {description}
  
  {long description}
  

  See CONTRIBUTING for more information and recent commit messages for examples.

• If this PR adds a new module It does not, but the original author is not using broot anymore.

  • Added myself as module maintainer. See example.

  • Added myself and the module files to .github/CODEOWNERS.

[berbiche]

Thanks for the contribution!

[stale]

Thank you for your contribution! I marked this pull request as stale due to inactivity. Please read the relevant sections below before commenting.

If you are the original author of the PR

• GitHub sometimes doesn't notify people who commented / reviewed a PR previously when you (force) push commits. If you have addressed the reviews you can officially ask for a review from those who commented to you or anyone else.
• If it is unfinished but you plan to finish it, please mark it as a draft.
• If you don't expect to work on it any time soon, please consider closing it with a short comment encouraging someone else to pick up your work.
• To get things rolling again, rebase the PR against the target branch and address valid comments.

If you are not the original author of the PR

• If you want to pick up the work on this PR, please create a new PR and indicate that it supercedes and closes this PR.

[dermetfan]

@rycee Sorry to ping you again. We need a decision to continue this: Is IFD allowed in home-manager? If so, which restrictions apply?

[rycee]

Oh, about IFD. I have nothing against it and use it all the time. The main concern would be performance and clarity. So in HM I would avoid using it in excess and with slow to build derivations. I would also avoid using them when a non-IFD solution exists of comparable code clarity.

So in this particular case I think we could try avoiding it by letting Bash source the generated file since it would be equally clear (arguably even more so).

[dermetfan]

Thanks for your guidance! This could also help future decisions.

With this said, I think this PR is ready.

[stale]

Thank you for your contribution! I marked this pull request as stale due to inactivity. Please read the relevant sections below before commenting.

If you are the original author of the PR

• GitHub sometimes doesn't notify people who commented / reviewed a PR previously when you (force) push commits. If you have addressed the reviews you can officially ask for a review from those who commented to you or anyone else.
• If it is unfinished but you plan to finish it, please mark it as a draft.
• If you don't expect to work on it any time soon, please consider closing it with a short comment encouraging someone else to pick up your work.
• To get things rolling again, rebase the PR against the target branch and address valid comments.

If you are not the original author of the PR

• If you want to pick up the work on this PR, please create a new PR and indicate that it supercedes and closes this PR.

[dermetfan]

I'm merging this on my own to avoid bothering others.

All expressed concerns have been addressed and a decision about IFD was made.
I've been using this since I opened the PR without issue.
There have been no further comments until the bot marked the PR stale.

[rycee]

Yep, good work!

Btw, does the test build for you? I seem to get an error

FileNotFoundError: [Errno 2] No such file or directory: '/nix/store/dikbik0phcq4lf7al6s1g6imcx2grfqs-broot-1.15.0.tar.gz/resources/default-conf.hjson'

[K900]

The latest broot update moved the configuration file to $src/resources/default-conf/conf.hjson

[dermetfan]

Sorry, I should have run the tests again given the age of this PR. Thankfully #3273 fixes this.