Check deprecate configuration variables #119
Conversation
|
I'm really sorry for having lost track of this one, it's bound to have taken a lot of time to write and would have been really useful right after the breaking change to configuration. Unfortunatly it's been a crazy year and I haven't had much time for side projects :/ |
|
@brujoand Thank you for your reply. Now, I'm actually not sure if this is worth merging because it has been a long time since the incompatible change to the configuration variables was made on 2020-07-07..2020-10-12 (3c9b999 3e2eba8 b3b3c0b f5d0b29). So, this PR can be regarded as a technical demonstration of how we can detect the old configurations, notify them to users, and reflect them into the new configurations. Nevertheless, if you would like to still consider it, I am willing to adjust the code to the latest version for review. I made this PR the least invasive so that the change to the main code becomes just a few lines, so this doesn't affect the complexity of the codebase. Edit: Maybe this framework will be useful when we change the configuration variables in the future. If you would like to change the configurations again, we can add the variable names in this framework and do not have to worry about errors and unexpected behaviors. |
|
Yeah I think the approach is super useful, and if there was to be some new overhaul of the settings it would be neat to reuse this to make the transition smooth. At that point though I think it would be best to refactor it into a standalone script, which can be announsed through a log message if settings name are rewritten. Let's keep it for later, these things tend to happen more often than expected 👍 |
@brujoand Thank you for reviewing and merging #117 and #118! Based on these PRs, I here create a new PR that solves #100. In this PR, I add a framework to detect the uses of older variable names and then added a list of older variable names that I found in the git history. This framework can also be used for future changes.
When the uses of old variable names are detected, the values are reflected in corresponding new variables. With this change, the old configuration file for 2019-12
sbpcan be loaded and works as expected, but produces the warning messages, which includes the information on how we can update the configuration file.P.S. This PR also includes trivial fixes 91f0edf and 61d7f1f.
Example:
settings.conf
colors.conf
Warning messages containing the instruction for updating configuration files