Skip to content

feat!: default to config at .config/lintrunner.toml#69

Open
aljazerzen wants to merge 1 commit intosuo:mainfrom
aljazerzen:config-in-dot-config
Open

feat!: default to config at .config/lintrunner.toml#69
aljazerzen wants to merge 1 commit intosuo:mainfrom
aljazerzen:config-in-dot-config

Conversation

@aljazerzen
Copy link

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.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant