Use & enforce snake_case naming convention on config.json settings (#8062)
* Document and support the established naming convention for config opts 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) * Add demo of lint rule in action * Fix all obvious instances of SdkConfig case conflicts * Fix tests to use SdkConfig directly * Add docs to make unset() calling safer * Appease the linter * Update documentation to match snake_case_config * Fix more instances of square brackets off SdkConfig
This commit is contained in:
parent
09c57b228e
commit
d8a939df5d
56 changed files with 605 additions and 259 deletions
36
src/utils/SnakedObject.ts
Normal file
36
src/utils/SnakedObject.ts
Normal file
|
@ -0,0 +1,36 @@
|
|||
/*
|
||||
Copyright 2022 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
export function snakeToCamel(s: string): string {
|
||||
return s.replace(/._./g, v => `${v[0]}${v[2].toUpperCase()}`);
|
||||
}
|
||||
|
||||
export class SnakedObject<T = Record<string, any>> {
|
||||
public constructor(private obj: T) {
|
||||
}
|
||||
|
||||
public get<K extends string & keyof T>(key: K, altCaseName?: string): T[K] {
|
||||
const val = this.obj[key];
|
||||
if (val !== undefined) return val;
|
||||
|
||||
return this.obj[altCaseName ?? snakeToCamel(key)];
|
||||
}
|
||||
|
||||
// Make JSON.stringify() pretend that everything is fine
|
||||
public toJSON() {
|
||||
return this.obj;
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue