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.

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

Disable the "prefer-default-export" rule and "no-restricted-syntax" #164

Merged

Conversation

bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Oct 7, 2024

I'm proposing two changes to our eslint config:

  1. Disable the import/prefer-default-export rule.
    • This article has a good summary of the reasons why many developers (like myself) avoid default exports entirely.
    • Another reason not mentioned in the article is that default exports require this weird syntax to mock with Jest and it's a frequent source of confusion and mistakes when mocking components out for testing.
    • Note that the Authoring MFE currently disables this rule in over 100 files using /* eslint-disable directives, and there are many more such instances in our codebases.
    • I would love to replace it with the no-default-export rule, but that would be too disruptive.
  2. The no-restricted-syntax prevents use of some modern syntax like iterators, but this rule is not needed anymore now that browsers support all that native syntax already. It's not a performance problem anymore like the rule used to be for.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 7, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

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.

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

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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

@PKulkoRaccoonGang PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great idea! @bradenmacdonald , thank you for making this PR! 💯

@mphilbrick211
Copy link

@brian-smith-tcril are you able to merge this?

@bradenmacdonald bradenmacdonald force-pushed the braden/prefer-no-default-export branch from c5016e6 to e9f470b Compare November 4, 2024 21:34
@bradenmacdonald bradenmacdonald merged commit 3f17bb7 into openedx:master Nov 4, 2024
4 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/prefer-no-default-export branch November 4, 2024 21:35
@edx-semantic-release
Copy link

🎉 This PR is included in version 4.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally. Approved.

arbrandes added a commit to arbrandes/frontend-build that referenced this pull request Nov 8, 2024
Bump eslint so that we get the new rules that were merged in
openedx/eslint-config#164.
@arbrandes
Copy link

Corresponding PR to frontend-build that actually pulls this in:

openedx/frontend-build#609

arbrandes added a commit to arbrandes/frontend-build that referenced this pull request Nov 8, 2024
Bump eslint so that we get the new rules that were merged in
openedx/eslint-config#164.
arbrandes added a commit to openedx/frontend-build that referenced this pull request Nov 8, 2024
Bump eslint so that we get the new rules that were merged in
openedx/eslint-config#164.
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.

7 participants