Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Task]: Add linting checks for JSON configs to avoid parsing errors #34969

Closed
NilanshBansal opened this issue Jul 16, 2024 · 2 comments · Fixed by #35395 or #35447
Closed

[Task]: Add linting checks for JSON configs to avoid parsing errors #34969

NilanshBansal opened this issue Jul 16, 2024 · 2 comments · Fixed by #35395 or #35447
Assignees
@NilanshBansal
Labels
Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration Query & JS Pod Issues related to the query & JS Pod Task A simple Todo

Comments

@NilanshBansal
Copy link
Contributor

SubTasks

Recently we observed that due to an error in the setting JSON, the smart JSON substitution toggle was removed from the UI.
Ref: https://theappsmith.slack.com/archives/C040LHZN03V/p1721124893238579
@NilanshBansal NilanshBansal added Task A simple Todo Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. labels Jul 16, 2024
@github-actions github-actions bot added the Integrations Product Issues related to a specific integration label Jul 16, 2024
@raza001
Copy link
Contributor

raza001 commented Jul 16, 2024

pls provide access of slack if possible

@NilanshBansal NilanshBansal self-assigned this Jul 29, 2024
@NilanshBansal
Copy link
Contributor Author

Moved to in progress now, as this is getting prioritised now.

This was referenced Aug 2, 2024
Closed
Closed
Merged
@NilanshBansal NilanshBansal mentioned this issue Aug 6, 2024
Merged
2 tasks
@Nikhil-Nandagopal Nikhil-Nandagopal added the Query & JS Pod Issues related to the query & JS Pod label Aug 6, 2024
NilanshBansal added a commit that referenced this issue Aug 8, 2024
@NilanshBansal
chore: added prettier spotless plugin for json files (#35447)
fe7ca6b 
## Description
This PR adds the spotless formatter and validator for the JSON files
present in the project. If there is any invalid JSON file, the formatter
fails and logs the file and the error LOC to be fixed.
It uses the `prettier JSON` formatted in spotless for the same.
Since Spotless is already added to the pre-commit hook it also makes it
necessary to fix the JSON and then commit the changes.

- The prettier JSON formattor preserves the order of the keys.
- Indendation of 2 spaces has been added in the config

Screenshot of the errors displayed for Invalid JSONs
<img width="1427" alt="image"
src="https://github.com/user-attachments/assets/00bbd61c-7414-4787-b9ac-2f0d392f6f33">

### Last attempt to resolve this issue
The formatted used was `simple JSON` which led to change in order of
JSON keys.
PR: #35395
Ref:
https://theappsmith.slack.com/archives/CGBPVEJ5C/p1722929754593669?thread_ts=1722916121.682699&cid=CGBPVEJ5C


Fixes #34969 

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10264348935>
> Commit: 4957b64
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10264348935&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Tue, 06 Aug 2024 12:40:47 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NilanshBansal NilanshBansal

Labels
Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration Query & JS Pod Issues related to the query & JS Pod Task A simple Todo
Projects
None yet
Milestone
No milestone
3 participants
@Nikhil-Nandagopal @NilanshBansal @raza001