chore: added JSON files linting check #35395
Merged
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
NilanshBansal
requested review from
sharat87,
nidhi-nair,
sondermanish and
a team
as code owners
|
Important Review skippedAuto reviews are limited to specific labels. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
github-actions
bot
added
skip-changelog
NilanshBansal
requested review from
rishabhrathod01
and removed request for
a team,
sharat87 and
sondermanish
2 tasks
Failed server tests
|
1 similar comment
Failed server tests
|
1 task
rahulbarwal
added a commit
that referenced
this pull request
Aug 6, 2024
This reverts commit 486662a.
NilanshBansal
added a commit
that referenced
this pull request
Aug 6, 2024
This reverts commit 486662a.
abhvsn
pushed a commit
that referenced
this pull request
Aug 6, 2024
Reverts #35395 Reverting this PR as the formatter changes the sorting order of the keys of our JSONs which affects our UI. Ref: https://theappsmith.slack.com/archives/CGBPVEJ5C/p1722929754593669?thread_ts=1722916121.682699&cid=CGBPVEJ5C
2 tasks
NilanshBansal
added a commit
that referenced
this pull request
Aug 8, 2024
## 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
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.
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.
Since Spotless is already added to the pre-commit hook it also makes it necessary to fix the JSON and then commit the changes.
Screenshot of the errors displayed for Invalid JSONs
Why is this Important?
All of our datasource forms appear on the UI from the JSON configuration files in the plugins. If an Invalid JSON is added, it can break the datasource usage experience for the users.
One such instance happened in the past, where due to a JSON formatting error, the users could not use Smart Substitution feature on production.
Reference
Fixes #34969
Automation
/ok-to-test tags="@tag.Sanity"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10243164292
Commit: 08bc87a
Cypress dashboard.
Tags:
@tag.SanitySpec:
Mon, 05 Aug 2024 05:50:07 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?