feat: More config file options #383
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
Previously, the config service would mutate the default config object if a config file could not be found. This caused a test to pass since the given argument then mutated the default config object.
Robdel12
reviewed
Oct 1, 2019
| @@ -43,9 +43,6 @@ jobs: | |||
| - run: | |||
| name: Upload command test | |||
| command: yarn test-upload-command | |||
| - run: | |||
| name: Setup integration test .percy.yml | |||
| command: mv .ci.percy.yml .percy.yml | |||
wwilsman
changed the title
Robdel12
approved these changes
Oct 1, 2019
| config: flags.string({ | ||
| char: 'c', | ||
| description: 'Path to percy config file', | ||
| }), |
djones
pushed a commit
that referenced
this pull request
Oct 1, 2019
# [0.17.0](v0.16.2...v0.17.0) (2019-10-01) ### Features * ✨ More config file options ([#383](#383)) ([b9875a1](b9875a1))
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.
Purpose
In part of making the configuration experience better by auto-loading
.envfiles in percy-client, we can also expand.percy.ymlsupport in agent to encompass more file types and use hierarchical priority!Approach
Uses cosmiconfig to search for various
.percy.*config files and auto-loads said configuration. The library will start its search for the filenames in the current working directory and recurse upwards until a match is found.There is also an option to load a specific config file by passing in a filename to the
loadSyncmethod. So targeted configs can become possible by allowing a flag to provide a filepath. I added this option under a--configflag and removed the Circle step to manually rename the.ci.percy.ymlfile.I noticed the previous configurations service mutated the
DEFAULT_CONFIGURATIONobject which causes a false positive test. I took this as an opportunity to improve how configuration is handled, and made it into a pure functional util. For flags and args parsing: instead of a multitude ofifstatements, a map is used and undefined values are filtered out.percy-clientwas updated to include.envsupport. Also of note is cosmiconfig was already a subdependency, so there was no overhead adding it as our own dependency.