Skip to content

Commit fbc96dd

Browse files
committed
docs(readme): add badges
1 parent be07c62 commit fbc96dd

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@
99
<p>ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library</p>
1010
</div>
1111

12+
<hr>
13+
14+
[![Build status][build-badge]][https://travis-ci.org/belco90/eslint-plugin-testing-library]
15+
[![Package version][version-badge]][https://www.npmjs.com/package/eslint-plugin-testing-library]
16+
[![MIT License][license-badge]][https://github.com/belco90/eslint-plugin-testing-library/blob/master/license]
17+
<br>
18+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
19+
[![PRs Welcome][pr-badge]][http://makeapullrequest.com]
20+
<br>
21+
[![Watch on Github][gh-watchers-badge]][https://github.com/belco90/eslint-plugin-testing-library/watchers]
22+
[![Star on Github][gh-watchers-badge]][https://github.com/belco90/eslint-plugin-testing-library/stargazers]
23+
[![Tweet][tweet-badge]][https://twitter.com/intent/tweet?url=https%3a%2f%2fgithub.com%2fbelco90%2feslint-plugin-testing-library&text=check%20out%20eslint-plugin-testing-library%20by%20@belcodev]
24+
1225
## Installation
1326

1427
You'll first need to install [ESLint](http://eslint.org):
@@ -115,16 +128,23 @@ To enable this configuration use the `extends` property in your
115128

116129
## Supported Rules
117130

118-
| Rule | Description | Configurations | Fixable |
119-
| -------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------- | ------------ |
120-
| [await-async-query](docs/rules/await-async-query.md) | Enforce async queries to have proper `await` | ![recommended][] ![angular][] ![react][] ![vue][] | |
121-
| [await-fire-event](docs/rules/await-fire-event.md) | Enforce async fire event methods to be awaited | ![vue][] | |
122-
| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended][] ![angular][] ![react][] ![vue][] | |
123-
| [no-debug](docs/rules/no-debug.md) | Disallow the use of `debug` | ![angular][] ![react][] ![vue][] | |
124-
| [no-dom-import](docs/rules/no-dom-import.md) | Disallow importing from DOM Testing Library | ![angular][] ![react][] ![vue][] | ![fixable][] |
125-
126-
[recommended]: https://img.shields.io/badge/recommended-lightgrey?style=flat-square
127-
[fixable]: https://img.shields.io/badge/fixable-success?style=flat-square
128-
[angular]: https://img.shields.io/badge/-Angular-black?style=flat-square&logo=angular&logoColor=white&labelColor=DD0031&color=black
129-
[react]: https://img.shields.io/badge/-React-black?style=flat-square&logo=react&logoColor=white&labelColor=61DAFB&color=black
130-
[vue]: https://img.shields.io/badge/-Vue-black?style=flat-square&logo=vue.js&logoColor=white&labelColor=4FC08D&color=black
131+
| Rule | Description | Configurations | Fixable |
132+
| -------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------- | ------------------ |
133+
| [await-async-query](docs/rules/await-async-query.md) | Enforce async queries to have proper `await` | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
134+
| [await-fire-event](docs/rules/await-fire-event.md) | Enforce async fire event methods to be awaited | ![vue-badge][] | |
135+
| [no-await-sync-query](docs/rules/no-await-sync-query.md) | Disallow unnecessary `await` for sync queries | ![recommended-badge][] ![angular-badge][] ![react-badge][] ![vue-badge][] | |
136+
| [no-debug](docs/rules/no-debug.md) | Disallow the use of `debug` | ![angular-badge][] ![react-badge][] ![vue-badge][] | |
137+
| [no-dom-import](docs/rules/no-dom-import.md) | Disallow importing from DOM Testing Library | ![angular-badge][] ![react-badge][] ![vue-badge][] | ![fixable-badge][] |
138+
139+
[build-badge]: https://img.shields.io/travis/Belco90/eslint-plugin-testing-library?style=flat-square
140+
[version-badge]: https://img.shields.io/npm/v/eslint-plugin-testing-library?style=flat-square
141+
[license-badge]: https://img.shields.io/npm/l/eslint-plugin-testing-library?style=flat-square
142+
[pr-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
143+
[gh-watchers-badge]: https://img.shields.io/github/watchers/Belco90/eslint-plugin-testing-library?style=social
144+
[gh-stars-badge]: https://img.shields.io/github/stars/Belco90/eslint-plugin-testing-library?style=social
145+
[tweet-badge]: https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2FBelco90%2Feslint-plugin-testing-library
146+
[recommended-badge]: https://img.shields.io/badge/recommended-lightgrey?style=flat-square
147+
[fixable-badge]: https://img.shields.io/badge/fixable-success?style=flat-square
148+
[angular-badge]: https://img.shields.io/badge/-Angular-black?style=flat-square&logo=angular&logoColor=white&labelColor=DD0031&color=black
149+
[react-badge]: https://img.shields.io/badge/-React-black?style=flat-square&logo=react&logoColor=white&labelColor=61DAFB&color=black
150+
[vue-badge]: https://img.shields.io/badge/-Vue-black?style=flat-square&logo=vue.js&logoColor=white&labelColor=4FC08D&color=black

0 commit comments

Comments
 (0)