Skip to content

docs: include new page for eslint plugin within ecosystem section #275

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

Belco90
Copy link
Member

@Belco90 Belco90 commented Oct 2, 2019

Updating doc to include new ecosystem section with eslint-plugin-testing-library.

After the original idea about writing an ESLint plugin for Testing Library I'm really excited for releasing v1 and update the proper ecosystem doc here!

I don't know if I would need to specify more things on this section, all the info is actually on Github page.

Copy link
Member

@afontcu afontcu left a comment

Choose a reason for hiding this comment

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

Looks fine and enough for me (for now)! I'll let this unmerged so other maintainers can give their two cents :)

👍 thanks for your hard work on this, it's a great addition to the ecosystem.

Copy link
Member

@kentcdodds kentcdodds 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 fantastic! Two changes please. Thank you!

that helps users to follow best practices and anticipate common mistakes when
writing tests.

![eslint-plugin-testing-library example showing an error](https://i.imgur.com/UKr9jVk.png)
Copy link
Member

Choose a reason for hiding this comment

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

Could we store this image within the repository rather than on imgur? I believe some countries/companies block imgur.

Copy link
Member Author

Choose a reason for hiding this comment

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

sure! I did that at first but wasn't sure if it was the right decision. Included at the repo now.

title: eslint-plugin-testing-library
---

[`eslint-plugin-testing-library`][gh] is an ESLint plugin for `Testing Library`
Copy link
Member

Choose a reason for hiding this comment

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

Testing Library does not need to be in backticks I think.

Copy link
Member Author

Choose a reason for hiding this comment

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

done too


This plugin includes:

- several rules for linting `Testing Library` specific code
Copy link
Member

Choose a reason for hiding this comment

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

No backticks here either.


This plugin includes:

- several rules for linting Testing Library specific code
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- several rules for linting Testing Library specific code
- Several rules for linting Testing Library specific code.

same thing in the other ones 😇 sry for the nitpicking.

Copy link
Member Author

Choose a reason for hiding this comment

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

No problem! done too

Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

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

Fantastic 💯 Thank you!

@kentcdodds kentcdodds merged commit 5504d43 into testing-library:master Oct 2, 2019
@kentcdodds
Copy link
Member

@all-contributors please add @Belco90 for docs

@allcontributors
Copy link
Contributor

@kentcdodds

I've put up a pull request to add @Belco90! 🎉

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.

3 participants