feat: support config file #95
Merged
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
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.
This adds support for config files, which can be used for specifying ignores in a way that can be tracked e.g. in version control.
Right now the only valid config option is
ignorewhich takes an array of OSV ids to be ignored (matching the--ignoreflag), since that's the flag we have that makes sense to configure per-project, but I think this could be useful in future for supporting custom databases.Config is merged with any flags, meaning if you specify ignores in both the config & as flags they'll all be taken (rather than just the ignores from flags or the config). You can use
--no-configto tell the detector to not load any config files.The config must be in YAML format, and the default config file is
.osv-detector.yaml&.osv-detector.yml.