Enable beautiful json for dashboard metadata editor #9474
Closed
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
ktmud
commented
Apr 6, 2020
| @@ -111,6 +111,7 @@ | |||
| "interweave": "^11.2.0", | |||
| "jquery": "^3.4.1", | |||
| "json-bigint": "^0.3.0", | |||
| "json-stringify-pretty-compact": "^2.0.0", | |||
There was a problem hiding this comment.
There's no change to package-lock.json because this package is already included by vega-lite (run npm ls json-stringify-pretty-compact):
├─┬ @superset-ui/preset-chart-xy@0.11.16
│ └─┬ vega-lite@4.1.1
│ └── json-stringify-pretty-compact@2.0.0 deduped
└── json-stringify-pretty-compact@2.0.0
ktmud
commented
Apr 6, 2020
| @@ -99,7 +108,8 @@ class PropertiesModal extends React.PureComponent { | |||
| ...state.values, | |||
| dashboard_title: dashboard.dashboard_title || '', | |||
| slug: dashboard.slug || '', | |||
| json_metadata: dashboard.json_metadata || '', | |||
| // always reformat to pretty json at initial opening | |||
| json_metadata: prettyJSON(dashboard.json_metadata) || '', | |||
There was a problem hiding this comment.
Only reformat the initial value so not to interfere users' typing.
ktmud
commented
Apr 6, 2020
| @@ -281,7 +291,6 @@ class PropertiesModal extends React.PureComponent { | |||
| <AceEditor | |||
| mode="json" | |||
| name="json_metadata" | |||
| defaultValue={this.defaultMetadataValue} | |||
There was a problem hiding this comment.
defaultMetadataValue was not found anywhere. Seems to be uncleaned old code.
ktmud
force-pushed
the
dashboard-meta-beautify-json
branch
from
dad3c64 to
472e7d1
Compare
|
Close to trigger CI |
nytai
reviewed
Apr 7, 2020
| @@ -24,6 +24,7 @@ import Select from 'react-select'; | |||
| import AceEditor from 'react-ace'; | |||
| import { t } from '@superset-ui/translation'; | |||
| import { SupersetClient } from '@superset-ui/connection'; | |||
| import stringify from 'json-stringify-pretty-compact'; | |||
There was a problem hiding this comment.
what are the advantages to using this module over the native JSON.stringify function with formatting (3rd arg)?
There was a problem hiding this comment.
This generates more compact strings.
E.g.
{
"short array": [1, 2, 3],
"long array": [
{"x": 1, "y": 2},
{"x": 2, "y": 1},
{"x": 1, "y": 1},
{"x": 2, "y": 2}
]
}vs
{
"short array": [
1,
2,
3
],
"long array": [
{
"x": 1,
"y": 2
},
{
"x": 2,
"y": 1
},
{
"x": 1,
"y": 1
},
{
"x": 2,
"y": 2
}
]
}
12 tasks
This was referenced Apr 28, 2020
6 tasks
This was referenced Mar 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CATEGORY
SUMMARY
Reformat JSON strings in the dashboard metadata modal input so it's easier to edit.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before
After
TEST PLAN
The JSON string in the code editor should be formatted.
ADDITIONAL INFORMATION
REVIEWERS
@graceguo-supercat @etr2460