Support Removed warning on configs #3874
Conversation
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #3874 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 179 179
Lines 13782 13800 +18
=========================================
+ Hits 13782 13800 +18
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
src/sqlfluff/core/config.py
Outdated
| if k in DEPRECATED_CONFIGS: | ||
| formatted_key = ":".join(k) | ||
| raise SQLFluffUserError( | ||
| f"Config file {file_path} set deprecated config " |
There was a problem hiding this comment.
The typical pattern I've seen for deprecation is to warn the user, then in a future release to remove it or raise an error. Wondering if we want to consider changing the behavior and/or use a term other than "deprecate".
There was a problem hiding this comment.
Hmmmm - good idea. I'm going to change the wording. I think the more "brutal" approach is good because otherwise users may get strange linting results which they look at before any raised warnings.
alanmcruickshank
changed the title
This is a fairly separable part of #3847, and can be merged separately. It will also simplify the review of that PR to take these changes out of it.
This allows particular config values to be marked as deprecated, prompting the user to remove them if they are set in a config. Optionally it also allows a configurable message to be set, informing the user how to update their config accordingly.