Correctly handle array config values and expand flat objects within them. #12662
Conversation
| @@ -4,7 +4,7 @@ test('flat object', () => { | |||
| const obj = { | |||
| 'foo.a': 1, | |||
| 'foo.b': 2 | |||
| } | |||
| }; | |||
There was a problem hiding this comment.
I just added semi-colons where my IDE wasn't happy enough :) But do you think we should re-think where we put them and where we don't?
There was a problem hiding this comment.
I just haven't put my IDE into rant-mode with TypeScript yet ;) We should definitely be consistent with adding them. Hopefully we'll add Prettier soon, which handles it for us
| return obj.map((item) => ensureDeepObject(item)); | ||
| } | ||
|
|
||
| return Object.keys(obj).reduce((fullObject, propertyKey) => { |
There was a problem hiding this comment.
I was thinking about Array.from(Object.entries()) here instead of Object.keys, but it requires additional lib for Typescript (es2017.object) and not sure we want it.
There was a problem hiding this comment.
👍 Just add es2017.object and use Object.entries()
platform/config/ensureDeepObject.ts
Outdated
| * Recursively traverses through the object's properties and expands ones with | ||
| * dot-separated names into nested objects (eg. { a.b: 'c'} -> { a: { b: 'c' }). | ||
| * @param {*} obj Object to traverse through | ||
| * @returns {Object} Same object instance with expanded properties. |
There was a problem hiding this comment.
Not sure we should include types in these, or just rely on TypeScript and have e.g.
* @param obj Object to traverse through
* @returns Same object instance with expanded properties.
(The type isn't required in jsdoc)
There was a problem hiding this comment.
Yeah, I'm not sure too. In this case it's actually even useless. It's just a habit from the past when I used Google Closure compiler to generate docs (for public API) :) But with Typescript I believe we'll have better tools that will be able to detect all types (hopefully, I'll need to check what is out there).
There was a problem hiding this comment.
I think we can remove the types from jsdoc for now, then look deeper into it later. Should be easy to add back based on the TS types.
| * @param obj Object to traverse through. | ||
| * @returns Same object instance with expanded properties. | ||
| */ | ||
| export function ensureDeepObject(obj: any): any { |
There was a problem hiding this comment.
Just noticed that compiler is complaining about implicit return any type, so defined it explicitly.
There was a problem hiding this comment.
Ah, yeah, it's because of the map.
|
Just merge this when you feel ready :) |
Per
yamldocs arrays can also include objects, like this:is parsed to: