Feat: allow dynamic visual configuration via JS files #534
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.
Problem
My team wants to be able to configure visual parameters (e.g. authorship data) dynamically, based on factors such as environment variables.
Furthermore, we don't want to have to manually overwrite JSON files in order to do this.
Proposed Solution
Many other JavaScript projects (e.g. Webpack) support configuration files written in both JSON and JavaScript.
Writing config files in raw JavaScript allows end-users of a package to specify parameters that can change at runtime.
This PR adds JavaScript config support to this repo.
Notes
JS preference
This PR is written to silently prefer JavaScript configuration files over JSON ones. If both types of configuration file exist, the JSON one will be ignored.
Please let me know if I should change this!
Testing
These changes were tested on top of #533, and have been confirmed to pass.