@@ -329,13 +329,6 @@ module.exports = {
329329 * Prevent missing props validation in a React component definition.
330330 *
331331 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md
332- *
333- * @example
334- * ["error", {
335- * ignore: [],
336- * customValidators: [],
337- * skipUndeclared: true,
338- * }]
339332 */
340333 "react/prop-types" : [ "error" , {
341334 ignore : [ ] ,
@@ -347,9 +340,6 @@ module.exports = {
347340 * Prevent missing React when using JSX.
348341 *
349342 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md
350- *
351- * @example
352- * "error"
353343 */
354344 "react/react-in-jsx-scope" : "error" ,
355345
@@ -358,11 +348,6 @@ module.exports = {
358348 * prop.
359349 *
360350 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
361- *
362- * @example
363- * ["error", {
364- * forbidDefaultForRequired: true,
365- * }]
366351 */
367352 "react/require-default-props" : [ "error" , {
368353 forbidDefaultForRequired : true ,
@@ -372,32 +357,20 @@ module.exports = {
372357 * Enforce React components to have a shouldComponentUpdate method.
373358 *
374359 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-optimization.md
375- *
376- * @example
377- * "off"
378360 */
379361 "react/require-optimization" : "off" ,
380362
381363 /**
382364 * Enforce ES5 or ES6 class for returning value in render function.
383365 *
384366 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md
385- *
386- * @example
387- * "error"
388367 */
389368 "react/require-render-return" : "error" ,
390369
391370 /**
392371 * Prevent extra closing tags for components without children. (fixable)
393372 *
394373 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
395- *
396- * @example
397- * ["error", {
398- * component: true,
399- * html: true,
400- * }]
401374 */
402375 "react/self-closing-comp" : [ "error" , {
403376 component : true ,
@@ -408,55 +381,6 @@ module.exports = {
408381 * Enforce component methods order.
409382 *
410383 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
411- *
412- * @example
413- * ["error", {
414- * order: [
415- * "static-methods",
416- * "instance-variables",
417- * "lifecycle",
418- * "/^on.+$/",
419- * "getters",
420- * "setters",
421- * "/^(get|set)(?!(InitialState$|DefaultProps$|ChildContext$)).+$/",
422- * "instance-methods",
423- * "everything-else",
424- * "rendering",
425- * ],
426- * groups: {
427- * "lifecycle": [
428- * 'displayName',
429- * 'propTypes',
430- * 'contextTypes',
431- * 'childContextTypes',
432- * 'mixins',
433- * 'statics',
434- * 'defaultProps',
435- * 'constructor',
436- * 'getDefaultProps',
437- * 'getInitialState',
438- * 'state',
439- * 'getChildContext',
440- * 'getDerivedStateFromProps',
441- * 'componentWillMount',
442- * 'UNSAFE_componentWillMount',
443- * 'componentDidMount',
444- * 'componentWillReceiveProps',
445- * 'UNSAFE_componentWillReceiveProps',
446- * 'shouldComponentUpdate',
447- * 'componentWillUpdate',
448- * 'UNSAFE_componentWillUpdate',
449- * 'getSnapshotBeforeUpdate',
450- * 'componentDidUpdate',
451- * 'componentDidCatch',
452- * 'componentWillUnmount'
453- * ],
454- * rendering: [
455- * "/^render.+$/",
456- * "render"
457- * ]
458- * }
459- * }]
460384 */
461385 "react/sort-comp" : [ "error" , {
462386 order : [
@@ -515,15 +439,6 @@ module.exports = {
515439 * Enforce propTypes declarations alphabetical sorting.
516440 *
517441 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md
518- *
519- * @example
520- * ["off", {
521- * callbacksLast: true,
522- * ignoreCase: false,
523- * requiredFirst: true,
524- * sortShapeProp: true,
525- * noSortAlphabetically: false,
526- * }]
527442 */
528443 "react/sort-prop-types" : [ "off" , {
529444 callbacksLast : true ,
@@ -538,39 +453,27 @@ module.exports = {
538453 * with a class property.
539454 *
540455 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/state-in-constructor.md
541- *
542- * @example
543- * ["error", "never"]
544456 */
545457 "react/state-in-constructor" : [ "error" , "never" ] ,
546458
547459 /**
548460 * Enforces where React component static properties should be positioned.
549461 *
550462 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/static-property-placement.md
551- *
552- * @example
553- * ["error", "static public field"]
554463 */
555464 "react/static-property-placement" : [ "error" , "static public field" ] ,
556465
557466 /**
558467 * Enforce style prop value being an object.
559468 *
560469 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/style-prop-object.md
561- *
562- * @example
563- * "error"
564470 */
565471 "react/style-prop-object" : "error" ,
566472
567473 /**
568474 * Prevent void DOM elements (e.g. <img />, <br />) from receiving children.
569475 *
570476 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/void-dom-elements-no-children.md
571- *
572- * @example
573- * "error"
574477 */
575478 "react/void-dom-elements-no-children" : "error" ,
576479
@@ -794,31 +697,20 @@ module.exports = {
794697 * Disallow multiple spaces between inline JSX props. (fixable)
795698 *
796699 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-multi-spaces.md
797- *
798- * @example
799- * "error"
800700 */
801701 "react/jsx-props-no-multi-spaces" : "error" ,
802702
803703 /**
804704 * Disallow JSX props spreading.
805705 *
806706 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-spreading.md
807- *
808- * @example
809- * "off"
810707 */
811708 "react/jsx-props-no-spreading" : "off" ,
812709
813710 /**
814711 * Enforce default props alphabetical sorting.
815712 *
816713 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-default-props.md
817- *
818- * @example
819- * ["off", {
820- * ignoreCase: true,
821- * }]
822714 */
823715 "react/jsx-sort-default-props" : [ "off" , {
824716 ignoreCase : true ,
@@ -828,16 +720,6 @@ module.exports = {
828720 * Enforce props alphabetical sorting. (fixable)
829721 *
830722 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md
831- *
832- * @example
833- * ["off", {
834- * callbacksLast: true,
835- * shorthandFirst: true,
836- * shorthandLast: false,
837- * ignoreCase: true,
838- * noSortAlphabetically: true,
839- * reservedFirst: true,
840- * }]
841723 */
842724 "react/jsx-sort-props" : [ "off" , {
843725 callbacksLast : true ,
@@ -852,14 +734,6 @@ module.exports = {
852734 * Validate whitespace in and around the JSX opening and closing brackets.
853735 *
854736 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-tag-spacing.md
855- *
856- * @example
857- * ["error", {
858- * closingSlash: "never",
859- * beforeSelfClosing: "always",
860- * afterOpening: "never",
861- * beforeClosing: "never",
862- * }]
863737 */
864738 "react/jsx-tag-spacing" : [ "error" , {
865739 closingSlash : "never" ,
@@ -872,37 +746,20 @@ module.exports = {
872746 * Prevent React to be incorrectly marked as unused.
873747 *
874748 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-react.md
875- *
876- * @example
877- * "error"
878749 */
879750 "react/jsx-uses-react" : "error" ,
880751
881752 /**
882753 * Prevent variables used in JSX to be incorrectly marked as unused.
883754 *
884755 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-vars.md
885- *
886- * @example
887- * "error"
888756 */
889757 "react/jsx-uses-vars" : "error" ,
890758
891759 /**
892760 * Prevent missing parentheses around multilines JSX. (fixable)
893761 *
894762 * https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-wrap-multilines.md
895- *
896- * @example
897- * ["error", {
898- * declaration: "parens-new-line",
899- * assignment: "parens-new-line",
900- * return: "parens-new-line",
901- * arrow: "parens-new-line",
902- * condition: "parens-new-line",
903- * logical: "parens-new-line",
904- * prop: "parens-new-line",
905- * }]
906763 */
907764 "react/jsx-wrap-multilines" : [ "error" , {
908765 declaration : "parens-new-line" ,
0 commit comments