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

adds documentation for eslint plugin react #2882

Merged
merged 4 commits into from Sep 13, 2022
Merged

Conversation

chrisweb
Copy link
Contributor

@chrisweb chrisweb commented Sep 4, 2022

What:

adds documentation for eslint plugin react

Why:

To help users that use both emotion and eslint with the react plugin (> 7.31.1) to fix the linting problem they will encounter, more about it in this ticket: #2878 (comment)

How:

After filling a ticket #2878 (comment) to demonstrate and discuss the problem, I created the different eslint configuration files locally and tested them in my project to verify the described solution works, then I wrote the documentation based on them

Checklist:

  • Documentation
  • Tests
  • Code complete
  • Changeset

@changeset-bot
Copy link

changeset-bot bot commented Sep 4, 2022

⚠️ No Changeset found

Latest commit: 90ca4cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Sep 4, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 90ca4cd:

Sandbox Source
Emotion Configuration

@srmagura srmagura self-requested a review September 4, 2022 23:32
@srmagura
Copy link
Member

Thanks @chrisweb. I improved the writing some / removed 2 of the ESLint config examples since I felt they were redundant.

@srmagura srmagura enabled auto-merge (squash) September 10, 2022 21:54
@chrisweb
Copy link
Contributor Author

chrisweb commented Sep 12, 2022

@srmagura ok thank you for checking it out

personally I would have kept the yaml example, because I sometimes find it hard to find the correct way of converting a rule into yaml when all you have is the json version (if maybe you are not super experienced with yaml object / array notations but your team used yaml for all configuration files), this is why I added that example to ensure it is really a no brainer for anyone to get this issue fixed quickly... but it is your project, I can see why you removed it and won't be angry if you keep it out ;)

@Andarist Andarist merged commit 5fa2d54 into emotion-js:main Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants