feat: add option to override react config. #254
Conversation
btimby
changed the title
|
I added a unit test and manually verified that the sidebar is successfully removed. |
|
Kudos, SonarCloud Quality Gate passed!
|
|
This should be good to go. I checked how github renders the Markdown and I am happy with these changes. |
There was a problem hiding this comment.
@btimby Hello! Sorry for that late review 😅 I didn't notice that you created that (probably I missed this PR in notifications on Github, sometimes I get 50 a day)... really sorry.
I added some suggestions, great work btw and thanks for contribution :)
| @@ -38,6 +38,7 @@ npm install -g @asyncapi/generator | |||
| | singleFile | Set output into one html-file with styles and scripts inside | No | `false` | `true`,`false` | `true` | | |||
| | outFilename | The filename of the output file. | No | `index.html` | *Any* | `asyncapi.html` | | |||
| | pdf | Generates output HTML as PDF | No | `false` | `true,false` | `false` | | |||
| | config | Stringified JS object containing options for react | No | null | *Any* | {"show":{"sidebar":false}} | | |||
There was a problem hiding this comment.
Please add link to the React component's config shape, something like:
| | config | Stringified JS object containing options for react | No | null | *Any* | {"show":{"sidebar":false}} | | |
| | config | Stringified JS object containing [options for the React component](https://github.com/asyncapi/asyncapi-react/blob/next/docs/configuration/config-modification.md#definition) | No | null | *Any* | {"show":{"sidebar":false}} | |
| @@ -100,6 +100,11 @@ | |||
| "pdf": { | |||
| "description": "Set to `true` to get index.pdf generated next to your index.html", | |||
| "default": false | |||
| }, | |||
| "config": { | |||
| "description": "Stringified JS object containing options for react, ex: {\"show\":{\"sidebar\":false}}.", | |||
There was a problem hiding this comment.
Please fix the description from my suggestion.
| let config = { show: { sidebar: true }, sidebar: { showOperations: 'byDefault' } }; | ||
| if (params.config) { | ||
| config = {...config, ...JSON.parse(params.config) }; | ||
| } |
There was a problem hiding this comment.
I think that we should merge the show part of config with the default. In your proposition if someone pass as config:
{ "show": { "operations": false } }
Then operations will be hidden, but sidebar will also hidden, but by default should be showed - only explicit defined sidebar: false should hide the sidebar, so please change it something like (maybe you will come up with something more better):
| let config = { show: { sidebar: true }, sidebar: { showOperations: 'byDefault' } }; | |
| if (params.config) { | |
| config = {...config, ...JSON.parse(params.config) }; | |
| } | |
| let config = { show: { sidebar: true }, sidebar: { showOperations: 'byDefault' } }; | |
| if (params.config) { | |
| const parsedCustomConfig = JSON.parse(params.config); | |
| config = {...config, ...parsedCustomConfig, show: { ...config.show, ...(parsedCustomConfig.show || {}) } }; | |
| } |
| it('should allow override of config', async () => { | ||
| const params = { config: '{"show": {"sidebar":false}}' }; | ||
| const expected = '{"show":{"sidebar":false},"sidebar":{"showOperations":"byDefault"}}'; | ||
|
|
||
| const result = stringifyConfiguration(params); | ||
| expect(result).toEqual(expected); | ||
| }); |
There was a problem hiding this comment.
Please also add one test with checking my proposition with deep merging of the config prop :)
|
@btimby Hi. Would you like to continue working on this PR in near future? :) |
|
@btimby That PR is still valid? |
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
I have updated
README.md, I am testing this change locally right now. I will follow up with results shortly.Description
html-templateto define react config.Related issue(s)
#253