Skip to content

Commit 81bd8ab

Browse files
committed
docs: update readme with rule screenshots
1 parent f13547e commit 81bd8ab

File tree

4 files changed

+19
-4
lines changed

4 files changed

+19
-4
lines changed

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1-
# eslint-plugin-exception-handling
2-
3-
10kB possibly unhandled exceptions linter.
1+
<p align="center">
2+
<img width="350" src="https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/43524856-1de6-4dac-982f-47323ea82ee4">
3+
</p>
4+
<h1 align="center">
5+
<sup>eslint-plugin-exception-handling</sup>
6+
<br>
7+
<a href="https://npm.im/eslint-plugin-exception-handling"><img src="https://badgen.net/npm/v/eslint-plugin-exception-handling"></a> <a href="https://npm.im/eslint-plugin-exception-handling"><img src="https://badgen.net/npm/dm/eslint-plugin-exception-handling"></a>
8+
</h1>
49

510
![image](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/f77dd81a-09c5-4f41-a3f1-d017df1bb1b9)
611

12+
| no-unhandled | might-throw | use-error-cause |
13+
| --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
14+
| ![no-unhandled](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/a5a1e70a-15f6-4e2b-b585-54846e9dc3ef) | ![might-throw](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/26ee8fb8-bd0e-4b72-bb3f-624635db9b0d) | ![cause](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/f813c112-2f6a-49e7-954c-cace2819d5e8) |
15+
716
# Installation
817

918
```bash

docs/rules/might-throw.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Warns about function calls that might throw exceptions (`exception-handling/might-throw`)
22

33
<!-- end auto-generated rule header -->
4+
5+
![might-throw](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/26ee8fb8-bd0e-4b72-bb3f-624635db9b0d)

docs/rules/no-unhandled.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Warns about function calls that might throw exceptions and are not handled at all further up the stack (`exception-handling/no-unhandled`)
22

33
<!-- end auto-generated rule header -->
4+
5+
![no-unhandled](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/a5a1e70a-15f6-4e2b-b585-54846e9dc3ef)

docs/rules/use-error-cause.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
# On `Error` re-thrown, forces the use of `cause` property in order to preserve stack traces.
1+
# On `Error` re-thrown, forces the use of `cause` property in order to preserve stack traces (`exception-handling/use-error-cause`)
22

33
<!-- end auto-generated rule header -->
44

5+
![cause](https://github.com/Akronae/eslint-plugin-exception-handling/assets/17302866/f813c112-2f6a-49e7-954c-cace2819d5e8)
6+
57
[See `ErrorOptions.cause` on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)

0 commit comments

Comments
 (0)