Skip to content

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

Merged
merged 3 commits into from
Jun 12, 2025

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Dec 10, 2024

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

  1. Make some mistakes in formatting design tokens (JSON files)
  2. Run npm run lint - linter errors will be displayed at the terminal
  3. Run npm run lint:fix - linter errors will be fixed automatically

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 10, 2024
@PKulkoRaccoonGang PKulkoRaccoonGang self-assigned this Dec 10, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 10, 2024

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/paragon-working-group.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link

netlify bot commented Dec 10, 2024

Deploy Preview for paragon-openedx ready!

Name Link
🔨 Latest commit 4a55c6f
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/67580a2b6a322000093dc600
😎 Deploy Preview https://deploy-preview-3330--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.50%. Comparing base (b8d4341) to head (bd4dbeb).
Report is 3 commits behind head on release-23.x.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a 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!

@PKulkoRaccoonGang
Copy link
Contributor Author

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 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.

@brian-smith-tcril brian-smith-tcril changed the base branch from alpha to release-23.x December 13, 2024 17:57
Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for paragon-openedx-v23 ready!

Name Link
🔨 Latest commit bd4dbeb
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/684a9645570188000802e181
😎 Deploy Preview https://deploy-preview-3330--paragon-openedx-v23.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@mphilbrick211
Copy link

Bumping this, @adamstankiewicz

Copy link

@Copilot Copilot AI left a 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

@PKulkoRaccoonGang PKulkoRaccoonGang merged commit 2cb6dc2 into release-23.x Jun 12, 2025
10 checks passed
@PKulkoRaccoonGang PKulkoRaccoonGang deleted the Peter_Kulko/json-linter branch June 12, 2025 09:21
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jun 12, 2025
@openedx-semantic-release-bot

🎉 This PR is included in version 23.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U released
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants