-
Notifications
You must be signed in to change notification settings - Fork 83
chore: added linter for JSON files #3330
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.
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
Conversation
Thanks for the pull request, @PKulkoRaccoonGang! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
✅ Deploy Preview for paragon-openedx ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
15406d6
to
8d3f434
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-23.x #3330 +/- ##
================================================
- Coverage 93.79% 93.50% -0.30%
================================================
Files 234 232 -2
Lines 4209 4016 -193
Branches 957 958 +1
================================================
- Hits 3948 3755 -193
+ Misses 257 253 -4
- Partials 4 8 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
8d3f434
to
4a55c6f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this LGTM! I am curious as to if we want to go the "lint everthing unless we ignore it" route or if we'd rather update the files: ['**/*.json'],
in .eslintrc.js
to be more specific.
I'm happy with this as-is though!
I think that the "lint everthing unless we ignore it" approach suits us. We have some files in JSON format that do not belong to the tokens folder and now they are also subject to the linter rules. |
4a55c6f
to
48ed59d
Compare
✅ Deploy Preview for paragon-openedx-v23 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Bumping this, @adamstankiewicz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR extends the existing linter configuration to include JSON files, primarily to support design tokens by ensuring consistent formatting and avoiding duplicate keys.
- Updated linting scripts in package.json to include JSON files
- Added JSON-specific ESLint overrides in .eslintrc.js
- Updated .eslintignore to omit generated or irrelevant JSON files
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
File | Description |
---|---|
tsconfig.build.json | Minor formatting change to JSON configuration |
package.json | Enhanced linting scripts and added ESLint dependencies for JSON support |
.eslintrc.js | Introduced JSON override rules with jsonc-eslint-parser and recommended settings |
.eslintignore | Expanded ignore list for additional JSON-related files |
🎉 This PR is included in version 23.11.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
With the advent of design tokens, a large number of new JSON files have appeared in Paragon. This PR provides an extended configuration of the JSON file linter, including formatting, checking for duplicate keys, etc.
How to test
npm run lint
- linter errors will be displayed at the terminalnpm run lint:fix
- linter errors will be fixed automaticallyMerge Checklist
example
app?Post-merge Checklist