docs: automate docs with eslint-doc-generator

Author: bmish

.github/workflows/readme.yml

@@ -1,6 +1,6 @@
-# Enforces consistent naming for boolean props (react/boolean-prop-naming)
+# Enforces consistent naming for boolean props (`react/boolean-prop-naming`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 Allows you to enforce a consistent naming pattern for props which expect a boolean value.
 

README.md

@@ -1,6 +1,6 @@
-# Disallow usage of `button` elements without an explicit `type` attribute (react/button-has-type)
+# Disallow usage of `button` elements without an explicit `type` attribute (`react/button-has-type`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 The default value of `type` attribute for `button` HTML element is `"submit"` which is often not the desired behavior and may lead to unexpected page reloads.
 This rules enforces an explicit `type` attribute for all the `button` elements and checks that its value is valid per spec (i.e., is one of `"button"`, `"submit"`, and `"reset"`).

docs/rules/boolean-prop-naming.md

@@ -1,6 +1,6 @@
-# Enforce all defaultProps have a corresponding non-required PropType (react/default-props-match-prop-types)
+# Enforce all defaultProps have a corresponding non-required PropType (`react/default-props-match-prop-types`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 This rule aims to ensure that any prop in `defaultProps` has a non-required type
 definition.

docs/rules/button-has-type.md

@@ -1,8 +1,8 @@
-# Enforce consistent usage of destructuring assignment of props, state, and context (react/destructuring-assignment)
+# Enforce consistent usage of destructuring assignment of props, state, and context (`react/destructuring-assignment`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-🔧 This rule is automatically fixable using the `--fix` [flag](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) on the command line.
+<!-- end rule header -->
 
 Rule can be set to either of `always` or `never`;
 

docs/rules/default-props-match-prop-types.md

@@ -1,6 +1,8 @@
-# Disallow missing displayName in a React component definition (react/display-name)
+# Disallow missing displayName in a React component definition (`react/display-name`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`, `recommended`.
+✅ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/README.md#shareable-configs).
+
+<!-- end rule header -->
 
 DisplayName allows you to name your component. This name is used by React in debugging messages.
 

docs/rules/destructuring-assignment.md

@@ -1,6 +1,6 @@
-# Disallow certain props on components (react/forbid-component-props)
+# Disallow certain props on components (`react/forbid-component-props`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 By default this rule prevents passing of [props that add lots of complexity](https://medium.com/brigade-engineering/don-t-pass-css-classes-between-components-e9f7ab192785) (`className`, `style`) to Components. This rule only applies to Components (e.g. `<Foo />`) and not DOM nodes (e.g. `<div />`). The list of forbidden props can be customized with the `forbid` option.
 

docs/rules/display-name.md

@@ -1,6 +1,6 @@
-# Disallow certain props on DOM Nodes (react/forbid-dom-props)
+# Disallow certain props on DOM Nodes (`react/forbid-dom-props`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 This rule prevents passing of props to elements. This rule only applies to DOM Nodes (e.g. `<div />`) and not Components (e.g. `<Component />`).
 The list of forbidden props can be customized with the `forbid` option.

docs/rules/forbid-component-props.md

@@ -1,6 +1,6 @@
-# Disallow certain elements (react/forbid-elements)
+# Disallow certain elements (`react/forbid-elements`)
 
-💼 This rule is enabled in the following [configs](https://github.com/jsx-eslint/eslint-plugin-react#shareable-configurations): `all`.
+<!-- end rule header -->
 
 You may want to forbid usage of certain elements in favor of others, (e.g. forbid all `<div />` and use `<Box />` instead). This rule allows you to configure a list of forbidden elements and to specify their desired replacements.