Skip to content

Commit e9ea2bd

Browse files
committed
Flesh out the readme files
1 parent 398d577 commit e9ea2bd

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Then configure the rules you want to use under the rules section.
4343

4444
## Supported Rules
4545

46-
* Fill in provided rules here
46+
* [jsx-no-invalid-props](docs/rules/jsx-no-invalid-props.md): Ensure that PropTypes are valid
4747

4848

4949

docs/rules/jsx-no-invalid-props.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# JSX No invalid props (jsx-no-invalid-props)
2+
3+
A quick check to see if a typo has been made on a PropType which can be at the minimum be annoying but also lead to debugging red herrings
4+
5+
## Rule Details
6+
7+
This rule checks propTypes on a class and validates the PropTypes against a static list from the React docs
8+
9+
## Rule Options
10+
11+
None yet
12+
13+
## Todo
14+
15+
Make more intelligent when determining PropTypes i.e. could have been imported as "p" which would currently fail:
16+
17+
```js
18+
propTypes: {
19+
a: p.array
20+
};
21+
```

0 commit comments

Comments
 (0)