diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 0000000000..8a2cb35709
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,6 @@
+{
+ "line-length": false,
+ "no-inline-html": false,
+ "no-hard-tabs": { "spaces_per_tab": 2 },
+ "ul-style": { "style": "dash" }
+}
diff --git a/.markdownlintignore b/.markdownlintignore
new file mode 100644
index 0000000000..bdaede90d0
--- /dev/null
+++ b/.markdownlintignore
@@ -0,0 +1,3 @@
+CHANGELOG.md
+LICENSE
+node_modules
diff --git a/README.md b/README.md
index 49416de595..a7c98e5739 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# `eslint-plugin-react` [![Version Badge][npm-version-svg]][package-url]
+
===================
[![github actions][actions-image]][actions-url]
@@ -8,16 +9,15 @@
React specific linting rules for `eslint`
-# Installation
+## Installation
```sh
-$ npm install eslint eslint-plugin-react --save-dev
+npm install eslint eslint-plugin-react --save-dev
```
It is also possible to install ESLint globally rather than locally (using npm install eslint --global). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.
-# Configuration
-
+## Configuration
Use [our preset](#recommended) to get reasonable defaults:
@@ -109,7 +109,7 @@ Enable the rules that you would like to use.
}
```
-# List of supported rules
+## List of supported rules
✔: Enabled in the [`recommended`](#recommended) configuration.\
🔧: Fixable with [`eslint --fix`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).\
@@ -179,7 +179,7 @@ Enable the rules that you would like to use.
| | | | [react/void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md) | Disallow void DOM elements (e.g. ``, `
`) from receiving children |
-## JSX-specific rules
+### JSX-specific rules
| ✔ | 🔧 | 💡 | Rule | Description |
@@ -225,15 +225,15 @@ Enable the rules that you would like to use.
| | 🔧 | | [react/jsx-wrap-multilines](docs/rules/jsx-wrap-multilines.md) | Disallow missing parentheses around multiline JSX |
-## Other useful plugins
+### Other useful plugins
- Rules of Hooks: [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks)
- JSX accessibility: [eslint-plugin-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)
- React Native: [eslint-plugin-react-native](https://github.com/Intellicode/eslint-plugin-react-native)
-# Shareable configurations
+## Shareable configurations
-## Recommended
+### Recommended
This plugin exports a `recommended` configuration that enforces React good practices.
@@ -247,7 +247,7 @@ To enable this configuration use the `extends` property in your `.eslintrc` conf
See [`eslint` documentation](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files) for more information about extending configuration files.
-## All
+### All
This plugin also exports an `all` configuration that includes every available rule.
This pairs well with the `eslint:all` rule.
@@ -263,11 +263,10 @@ This pairs well with the `eslint:all` rule.
**Note**: These configurations will import `eslint-plugin-react` and enable JSX in [parser options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options).
-# License
+## License
`eslint-plugin-react` is licensed under the [MIT License](https://opensource.org/licenses/mit-license.php).
-
[npm-url]: https://npmjs.org/package/eslint-plugin-react
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-react.svg
diff --git a/SECURITY.md b/SECURITY.md
index 8ea2512832..5f02cd3af8 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -9,7 +9,6 @@ This is the list of versions of `eslint-plugin-react` which are currently being
| 7.x | :white_check_mark: |
| < 7.x | :x: |
-
## Reporting a Vulnerability
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
diff --git a/docs/rules/boolean-prop-naming.md b/docs/rules/boolean-prop-naming.md
index 3c043ca9c0..ff642f7abc 100644
--- a/docs/rules/boolean-prop-naming.md
+++ b/docs/rules/boolean-prop-naming.md
@@ -36,6 +36,7 @@ var Hello = createReactClass({
render: function() { return