feat!: default to config at .config/lintrunner.toml #69
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
.config/lintrunner.tomland.config/lintrunner.private.tomlto 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.tomlbut also has.config/lintrunner.tomlwill 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:
... since this the last two paths must be relative to
.config, which is confusing.