[compiler] Script to produce markdown of lint rule docs (facebook#34260)

The docs site is in a separate repo, but this gives us a semi-automated
way to update the docs about our lint rules. The script generates
markdown files from the rule definitions which we can then manually
copy/paste into the docs site somewhere. In the future we can automate
this fully.

DiffTrain build for [425ba0a](facebook@425ba0a)

Author: pull[bot]

compiled/eslint-plugin-react-hooks/index.js

@@ -18001,14 +18001,20 @@ var ErrorCategory;
     ErrorCategory["Fire"] = "Fire";
     ErrorCategory["FBT"] = "FBT";
 })(ErrorCategory || (ErrorCategory = {}));
+const RULE_NAME_PATTERN = /^[a-z]+(-[a-z]+)*$/;
 function getRuleForCategory(category) {
+    const rule = getRuleForCategoryImpl(category);
+    invariant(RULE_NAME_PATTERN.test(rule.name), `Invalid rule name, got '${rule.name}' but rules must match ${RULE_NAME_PATTERN.toString()}`);
+    return rule;
+}
+function getRuleForCategoryImpl(category) {
     switch (category) {
         case ErrorCategory.AutomaticEffectDependencies: {
             return {
                 category,
                 name: 'automatic-effect-dependencies',
                 description: 'Verifies that automatic effect dependencies are compiled if opted-in',
-                recommended: true,
+                recommended: false,
             };
         }
         case ErrorCategory.CapitalizedCalls: {
@@ -18023,7 +18029,7 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'config',
-                description: 'Validates the configuration',
+                description: 'Validates the compiler configuration options',
                 recommended: true,
             };
         }
@@ -18047,15 +18053,15 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'set-state-in-effect',
-                description: 'Validates against calling setState synchronously in an effect',
+                description: 'Validates against calling setState synchronously in an effect, which can lead to re-renders that degrade performance',
                 recommended: true,
             };
         }
         case ErrorCategory.ErrorBoundaries: {
             return {
                 category,
                 name: 'error-boundaries',
-                description: 'Validates usage of error boundaries instead of try/catch for errors in JSX',
+                description: 'Validates usage of error boundaries instead of try/catch for errors in child components',
                 recommended: true,
             };
         }
@@ -18079,15 +18085,16 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'gating',
-                description: 'Validates configuration of gating mode',
+                description: 'Validates configuration of [gating mode](https://react.dev/reference/react-compiler/gating)',
                 recommended: true,
             };
         }
         case ErrorCategory.Globals: {
             return {
                 category,
                 name: 'globals',
-                description: 'Validates against assignment/mutation of globals during render',
+                description: 'Validates against assignment/mutation of globals during render, part of ensuring that ' +
+                    '[side effects must render outside of render](https://react.dev/reference/rules/components-and-hooks-must-be-pure#side-effects-must-run-outside-of-render)',
                 recommended: true,
             };
         }
@@ -18103,7 +18110,7 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'immutability',
-                description: 'Validates that immutable values (props, state, etc) are not mutated',
+                description: 'Validates against mutating props, state, and other values that [are immutable](https://react.dev/reference/rules/components-and-hooks-must-be-pure#props-and-state-are-immutable)',
                 recommended: true,
             };
         }
@@ -18119,39 +18126,41 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'preserve-manual-memoization',
-                description: 'Validates that existing manual memoized is preserved by the compiler',
+                description: 'Validates that existing manual memoized is preserved by the compiler. ' +
+                    'React Compiler will only compile components and hooks if its inference ' +
+                    '[matches or exceeds the existing manual memoization](https://react.dev/learn/react-compiler/introduction#what-should-i-do-about-usememo-usecallback-and-reactmemo)',
                 recommended: true,
             };
         }
         case ErrorCategory.Purity: {
             return {
                 category,
                 name: 'purity',
-                description: 'Validates that the component/hook is pure, and does not call known-impure functions',
+                description: 'Validates that [components/hooks are pure](https://react.dev/reference/rules/components-and-hooks-must-be-pure) by checking that they do not call known-impure functions',
                 recommended: true,
             };
         }
         case ErrorCategory.Refs: {
             return {
                 category,
                 name: 'refs',
-                description: 'Validates correct usage of refs, not reading/writing during render',
+                description: 'Validates correct usage of refs, not reading/writing during render. See the "pitfalls" section in [`useRef()` usage](https://react.dev/reference/react/useRef#usage)',
                 recommended: true,
             };
         }
         case ErrorCategory.RenderSetState: {
             return {
                 category,
                 name: 'set-state-in-render',
-                description: 'Validates against setting state during render',
+                description: 'Validates against setting state during render, which can trigger additional renders and potential infinite render loops',
                 recommended: true,
             };
         }
         case ErrorCategory.StaticComponents: {
             return {
                 category,
                 name: 'static-components',
-                description: 'Validates that components are static, not recreated every render',
+                description: 'Validates that components are static, not recreated every render. Components that are recreated dynamically can reset state and trigger excessive re-rendering',
                 recommended: true,
             };
         }
@@ -18183,15 +18192,15 @@ function getRuleForCategory(category) {
             return {
                 category,
                 name: 'unsupported-syntax',
-                description: 'Validates against syntax that we do not plan to support',
+                description: 'Validates against syntax that we do not plan to support in React Compiler',
                 recommended: true,
             };
         }
         case ErrorCategory.UseMemo: {
             return {
                 category,
                 name: 'use-memo',
-                description: 'Validates usage of the useMemo() hook',
+                description: 'Validates usage of the useMemo() hook against common mistakes. See [`useMemo()` docs](https://react.dev/reference/react/useMemo) for more information.',
                 recommended: true,
             };
         }

compiled/facebook-www/REVISION

@@ -1 +1 @@
-11d7bcf88cf13fa8fe6e091d2199c3905f5bb274
+425ba0ad6d3ebd1779f6a658dcbf5c666d054948

compiled/facebook-www/REVISION_TRANSFORMS

@@ -1 +1 @@
-11d7bcf88cf13fa8fe6e091d2199c3905f5bb274
+425ba0ad6d3ebd1779f6a658dcbf5c666d054948

compiled/facebook-www/React-dev.classic.js

@@ -1409,7 +1409,7 @@ __DEV__ &&
     exports.useTransition = function () {
       return resolveDispatcher().useTransition();
     };
-    exports.version = "19.2.0-www-classic-11d7bcf8-20250822";
+    exports.version = "19.2.0-www-classic-425ba0ad-20250822";
     "undefined" !== typeof __REACT_DEVTOOLS_GLOBAL_HOOK__ &&
       "function" ===
         typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStop &&

compiled/facebook-www/React-dev.modern.js

@@ -1409,7 +1409,7 @@ __DEV__ &&
     exports.useTransition = function () {
       return resolveDispatcher().useTransition();
     };
-    exports.version = "19.2.0-www-modern-11d7bcf8-20250822";
+    exports.version = "19.2.0-www-modern-425ba0ad-20250822";
     "undefined" !== typeof __REACT_DEVTOOLS_GLOBAL_HOOK__ &&
       "function" ===
         typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStop &&

compiled/facebook-www/React-prod.classic.js

@@ -600,4 +600,4 @@ exports.useSyncExternalStore = function (
 exports.useTransition = function () {
   return ReactSharedInternals.H.useTransition();
 };
-exports.version = "19.2.0-www-classic-11d7bcf8-20250822";
+exports.version = "19.2.0-www-classic-425ba0ad-20250822";

compiled/facebook-www/React-prod.modern.js

@@ -600,4 +600,4 @@ exports.useSyncExternalStore = function (
 exports.useTransition = function () {
   return ReactSharedInternals.H.useTransition();
 };
-exports.version = "19.2.0-www-modern-11d7bcf8-20250822";
+exports.version = "19.2.0-www-modern-425ba0ad-20250822";

compiled/facebook-www/React-profiling.classic.js

@@ -604,7 +604,7 @@ exports.useSyncExternalStore = function (
 exports.useTransition = function () {
   return ReactSharedInternals.H.useTransition();
 };
-exports.version = "19.2.0-www-classic-11d7bcf8-20250822";
+exports.version = "19.2.0-www-classic-425ba0ad-20250822";
 "undefined" !== typeof __REACT_DEVTOOLS_GLOBAL_HOOK__ &&
   "function" ===
     typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStop &&

compiled/facebook-www/React-profiling.modern.js

@@ -604,7 +604,7 @@ exports.useSyncExternalStore = function (
 exports.useTransition = function () {
   return ReactSharedInternals.H.useTransition();
 };
-exports.version = "19.2.0-www-modern-11d7bcf8-20250822";
+exports.version = "19.2.0-www-modern-425ba0ad-20250822";
 "undefined" !== typeof __REACT_DEVTOOLS_GLOBAL_HOOK__ &&
   "function" ===
     typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStop &&

compiled/facebook-www/ReactART-dev.classic.js

@@ -19588,10 +19588,10 @@ __DEV__ &&
     (function () {
       var internals = {
         bundleType: 1,
-        version: "19.2.0-www-classic-11d7bcf8-20250822",
+        version: "19.2.0-www-classic-425ba0ad-20250822",
         rendererPackageName: "react-art",
         currentDispatcherRef: ReactSharedInternals,
-        reconcilerVersion: "19.2.0-www-classic-11d7bcf8-20250822"
+        reconcilerVersion: "19.2.0-www-classic-425ba0ad-20250822"
       };
       internals.overrideHookState = overrideHookState;
       internals.overrideHookStateDeletePath = overrideHookStateDeletePath;
@@ -19625,7 +19625,7 @@ __DEV__ &&
     exports.Shape = Shape;
     exports.Surface = Surface;
     exports.Text = Text;
-    exports.version = "19.2.0-www-classic-11d7bcf8-20250822";
+    exports.version = "19.2.0-www-classic-425ba0ad-20250822";
     "undefined" !== typeof __REACT_DEVTOOLS_GLOBAL_HOOK__ &&
       "function" ===
         typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStop &&