This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Use & enforce snake_case naming convention on config.json settings #8062
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
turt2live
force-pushed
the
travis/sssssssnake_case_config
branch
from
317adcb
to
f4b71d2
Compare
turt2live
added
the
T-Task
turt2live
force-pushed
the
travis/sssssssnake_case_config
branch
from
f4b71d2
to
6a94b31
Compare
This change: * Rename `ConfigOptions` to `IConfigOptions` to match code convention/style, plus move it to a dedicated file * Update comments and surrounding documentation * Define every single documented option (from element-web's config.md) * Enable a linter to enforce the convention * Invent a translation layer for a different change to use * No attempt to fix build errors from doing this (at this stage)
turt2live
force-pushed
the
travis/sssssssnake_case_config
branch
from
6a94b31
to
0109e34
Compare
|
da217d2 demonstrates the lint rule working:
|
This was referenced Mar 16, 2022
turt2live
force-pushed
the
travis/sssssssnake_case_config
branch
from
bb327f7
to
4b320d0
Compare
Codecov Report
@@ Coverage Diff @@
## develop #8062 +/- ##
========================================
Coverage 27.12% 27.13%
========================================
Files 868 869 +1
Lines 52097 52137 +40
Branches 13199 13211 +12
========================================
+ Hits 14130 14145 +15
- Misses 37967 37992 +25
|
germain-gg
approved these changes
Mar 18, 2022
| { | ||
| ... | ||
| "settingDefaults": { | ||
| "setting_defaults": { | ||
| "settingName": true |
There was a problem hiding this comment.
Suggested change
| "settingName": true | |
| "setting_name": true |
There was a problem hiding this comment.
The settings can still be camel case, and most are, unfortunately.
3 tasks
benbz
added a commit
to element-hq/element-web
that referenced
this pull request
Jul 17, 2023
As of matrix-org/matrix-react-sdk#8062 / #21429 this should have been snake case rather than camelCase
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Per internal vote.
Review with element-hq/element-web#21429
This change does:
ConfigOptionstoIConfigOptionsto match code convention/styleIConfigOptions(and directly related interfaces) to a dedicated file so the linter rules can be appliedSnakedObject)This change is marked as an internal change (Task), so will not be included in the changelog.
Preview: https://pr8062--matrix-react-sdk.netlify.app
⚠️ Do you trust the author of this PR? Maybe this build will steal your keys or give you malware. Exercise caution. Use test accounts.