feat(config): look up from .config subdir by default, too

[scop]

Closes # (issue)

⚡ Summary

Look up configs from .config subdirs too, to help unclutter project top level dirs, https://github.com/pi0/config-dir (and other similar proposals)

pi0/config-dir support discussion item: pi0/config-dir#6 (comment)

This is a draft for discussion purposes, to be still done at least

• tests
• the .config/lefthook and .config/lefthook-local source dirs should work out of the box, too
• decide how relative paths should work and make sure they do that way, e.g. should they always be from the "top level dir" no matter if the config is in .config, or relative to that dir (I think I'd propose the former)
• remove with uninstall

☑️ Checklist

• Check locally
• Add tests
• Add documentation

[mrexox]

Hey! This sounds good! Could you also add the paths to uninstall?

I don't think moving scripts to .config/ is a good idea, since scripts are not configs actually, they must belong to repo root.

Regarding the paths I think it's better consider lefthook as being run from git project root always, for simplicity. So moving a file from repo root to .config/ doesn't make you change the config adding ../ to the root option, etc.

[mrexox]

Hey @scop! Do you want to continue on this PR? If not, can I apply the fixes myself and merge it?

[ThomasSanson]

Hello @mrexox,

I'm following up on this pull request. It would be excellent for us if the configuration could also be placed in a subdirectory of .config, such as .config/lefthook/lefthook.yml. More generally, I am thinking of something like .config/**/lefthook.yml.

Additionally, would a --config option for lefthook, allowing the explicit specification of the configuration file's location, be a more generic and straightforward solution ?

If there's a need for contributions to the pull request, I’d be happy to volunteer.

[mrexox]

Hey @ThomasSanson! This PR adds support for .config/lefthook{.yml,.toml,.json}, not exactly what you wanted. Does it work for you? If it does I can make an effort on finishing this PR

[scop]

Thanks for considering. I can try to find time sometime to work on this, but I don't know when that might be, so it's very much appreciated if you @mrexox can chime in with the implementation here.

Just one remark to @ThomasSanson's message

Additionally, would a --config option for lefthook, allowing the explicit specification of the configuration file's location, be a more generic and straightforward solution ?

No objections here if someone wants to add that, but the whole point of my request is to have .config be a location that is looked up by default, without having to specify any configuration or command line options. See the paragraph starting with "Some tools offer command line ..." at https://github.com/pi0/config-dir#motivation for the rationale.

[ThomasSanson]

Hello @scop,

Apologies for the additional comments I made on this pull request. I intended to benefit from the ongoing work without being too intrusive. I'll wait for this PR to be merged and then submit a separate one for my specific needs. 😇

[scop]

No problem, I just wanted to clarify my own intent with this, as I did not make it that clear in writing here but just pointed to external resources.