DRAFT: reordered design tokens structure

[PKulkoRaccoonGang]

Description

This PR provides a draft version of the key sorter for Design tokens and adds a linter for JSON files.

• added the key sorter for Design tokens

const DESIGN_TOKEN_KEY_ORDER = [
  '$type',
  '$value',
  '$description',
  'outputReferences',
  'modify',
  'source',
];

• added linter for JSON files

Screen.Recording.2024-11-13.at.09.59.35.mov

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]

Thanks for the pull request, @PKulkoRaccoonGang!

What's next?

Please work through the following steps to get your changes 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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/paragon-working-group. Tag them in a comment and let them know that your changes are ready for review.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[PKulkoRaccoonGang]

[inform]: If we are satisfied with this functionality, it will be moved to Paragon CLI

[PKulkoRaccoonGang]

I researched popular tools for linting JSON files, including:

• Prettier
• eslint-plugin-json-format and eslint-plugin-json-files
• eslint-plugin-jsonc
• jsonlint

Currently, eslint-plugin-jsonc is used for formatting and syntax checking. For custom sorting of key order in design tokens, a custom Node.js script is utilized, as these tools only support alphabetical sorting or shallow sorting that doesn’t account for deep nesting.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.76%. Comparing base (b4d560b) to head (4b065a6).

Additional details and impacted files

@@                       Coverage Diff                        @@
##           Peter_Kulko/style-dictionary-v4    #3285   +/-   ##
================================================================
  Coverage                            93.76%   93.76%           
================================================================
  Files                                  229      229           
  Lines                                 3784     3784           
  Branches                               906      879   -27     
================================================================
  Hits                                  3548     3548           
  Misses                                 232      232           
  Partials                                 4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.