Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

.config instead of config #34

Open
Zamiell opened this issue Dec 17, 2023 · 1 comment
Open

.config instead of config #34

Zamiell opened this issue Dec 17, 2023 · 1 comment

Comments

@Zamiell
Copy link

Zamiell commented Dec 17, 2023 •
edited
Loading

Hello,

I've noticed movement in the ecosystem recently to consolidate around a convention to have configs inside of a directory.

See:

But this consolidation is specifically around a directory named ".config".
From the README, proload seems to only support config.

Should that be reconsidered?
@pi0
Copy link

pi0 commented Feb 14, 2024

Hi @natemoo-re! We also started a new effort for .config/ dir support (https://github.com/pi0/config-dir) are you interested to adopt it as an alternative as well?

aljazerzen added a commit to aljazerzen/lintrunner that referenced this issue Mar 25, 2024
@aljazerzen
feat!: default to config at .config/lintrunner.toml
d6ced1d 
Adds `.config/lintrunner.toml` and `.config/lintrunner.private.toml`
to the end of default config paths.

Idea here is that having too much dot files in the repo root is a mess.
Alternative is a `.config/`, which alieviates the problem a lot.
See https://dot-config.github.io/ and natemoo-re/proload#34.

This is potentially a breaking change, since project that currenty
default to `.lintrunner.toml` but also has `.config/lintrunner.toml`
will now have root config overridden with the `.config`.

The chance of this happening are very low, so I don't think this will cause
any problems.

---

Alternative is to put the new default in the front of the list, but then
we would have to change the full default to:
```
.config/lintrunner.toml, .config/lintrunner.private.toml, ../.lintrunner.toml, ../.lintrunner.private.toml
```
... since this the last two paths must be relative to `.config`, which is confusing.
@aljazerzen aljazerzen mentioned this issue Mar 25, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pi0 @Zamiell