diff --git a/.travis.yml b/.travis.yml index d887e7d4a0..a7d00fe10a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,7 +14,8 @@ before_script: - 'if [ -n "${ESLINT-}" ]; then npm install --no-save "eslint@${ESLINT}" ; fi' script: - 'if [ -n "${PRETEST-}" ]; then npm run pretest ; fi' - - 'if [ -z "${PRETEST-}" ] && [ -n "${TEST-}" ]; then npm run unit-test ; fi' + - 'if [ -n "${TEST-}" ]; then npm run unit-test ; fi' + - 'if [ -n "${README-}" ]; then npm run generate-list-of-rules:check ; fi' env: global: - TEST=true @@ -29,6 +30,8 @@ matrix: include: - node_js: 'lts/*' env: PRETEST=true + - node_js: 'lts/*' + env: README=true exclude: - node_js: '4' env: ESLINT=5 diff --git a/README.md b/README.md index eba722f89f..6faee1afbd 100644 --- a/README.md +++ b/README.md @@ -97,94 +97,100 @@ Enable the rules that you would like to use. # List of supported rules + * [react/boolean-prop-naming](docs/rules/boolean-prop-naming.md): Enforces consistent naming for boolean props * [react/button-has-type](docs/rules/button-has-type.md): Forbid "button" element without an explicit "type" attribute -* [react/default-props-match-prop-types](docs/rules/default-props-match-prop-types.md): Prevent extraneous defaultProps on components -* [react/destructuring-assignment](docs/rules/destructuring-assignment.md): Rule enforces consistent usage of destructuring assignment in component -* [react/display-name](docs/rules/display-name.md): Prevent missing `displayName` in a React component definition -* [react/forbid-component-props](docs/rules/forbid-component-props.md): Forbid certain props on Components +* [react/default-props-match-prop-types](docs/rules/default-props-match-prop-types.md): Enforce all defaultProps are defined and not "required" in propTypes. +* [react/destructuring-assignment](docs/rules/destructuring-assignment.md): Enforce consistent usage of destructuring assignment of props, state, and context +* [react/display-name](docs/rules/display-name.md): Prevent missing displayName in a React component definition +* [react/forbid-component-props](docs/rules/forbid-component-props.md): Forbid certain props on components * [react/forbid-dom-props](docs/rules/forbid-dom-props.md): Forbid certain props on DOM Nodes * [react/forbid-elements](docs/rules/forbid-elements.md): Forbid certain elements +* [react/forbid-foreign-prop-types](docs/rules/forbid-foreign-prop-types.md): Forbid using another component's propTypes * [react/forbid-prop-types](docs/rules/forbid-prop-types.md): Forbid certain propTypes -* [react/forbid-foreign-prop-types](docs/rules/forbid-foreign-prop-types.md): Forbid foreign propTypes -* [react/no-access-state-in-setstate](docs/rules/no-access-state-in-setstate.md): Prevent using this.state inside this.setState -* [react/no-array-index-key](docs/rules/no-array-index-key.md): Prevent using Array index in `key` props -* [react/no-children-prop](docs/rules/no-children-prop.md): Prevent passing children as props -* [react/no-danger](docs/rules/no-danger.md): Prevent usage of dangerous JSX properties -* [react/no-danger-with-children](docs/rules/no-danger-with-children.md): Prevent problem with children and props.dangerouslySetInnerHTML -* [react/no-deprecated](docs/rules/no-deprecated.md): Prevent usage of deprecated methods, including component lifecycle methods -* [react/no-did-mount-set-state](docs/rules/no-did-mount-set-state.md): Prevent usage of `setState` in `componentDidMount` -* [react/no-did-update-set-state](docs/rules/no-did-update-set-state.md): Prevent usage of `setState` in `componentDidUpdate` -* [react/no-direct-mutation-state](docs/rules/no-direct-mutation-state.md): Prevent direct mutation of `this.state` -* [react/no-find-dom-node](docs/rules/no-find-dom-node.md): Prevent usage of `findDOMNode` -* [react/no-is-mounted](docs/rules/no-is-mounted.md): Prevent usage of `isMounted` +* [react/function-component-definition](docs/rules/function-component-definition.md): Standardize the way function component get defined (fixable) +* [react/no-access-state-in-setstate](docs/rules/no-access-state-in-setstate.md): Reports when this.state is accessed within setState +* [react/no-adjacent-inline-elements](docs/rules/no-adjacent-inline-elements.md): Prevent adjacent inline elements not separated by whitespace. +* [react/no-array-index-key](docs/rules/no-array-index-key.md): Prevent usage of Array index in keys +* [react/no-children-prop](docs/rules/no-children-prop.md): Prevent passing of children as props. +* [react/no-danger](docs/rules/no-danger.md): Prevent usage of dangerous JSX props +* [react/no-danger-with-children](docs/rules/no-danger-with-children.md): Report when a DOM element is using both children and dangerouslySetInnerHTML +* [react/no-deprecated](docs/rules/no-deprecated.md): Prevent usage of deprecated methods +* [react/no-did-mount-set-state](docs/rules/no-did-mount-set-state.md): Prevent usage of setState in componentDidMount +* [react/no-did-update-set-state](docs/rules/no-did-update-set-state.md): Prevent usage of setState in componentDidUpdate +* [react/no-direct-mutation-state](docs/rules/no-direct-mutation-state.md): Prevent direct mutation of this.state +* [react/no-find-dom-node](docs/rules/no-find-dom-node.md): Prevent usage of findDOMNode +* [react/no-is-mounted](docs/rules/no-is-mounted.md): Prevent usage of isMounted * [react/no-multi-comp](docs/rules/no-multi-comp.md): Prevent multiple component definition per file -* [react/no-redundant-should-component-update](docs/rules/no-redundant-should-component-update.md): Prevent usage of `shouldComponentUpdate` when extending React.PureComponent -* [react/no-render-return-value](docs/rules/no-render-return-value.md): Prevent usage of the return value of `React.render` -* [react/no-set-state](docs/rules/no-set-state.md): Prevent usage of `setState` -* [react/no-typos](docs/rules/no-typos.md): Prevent common casing typos -* [react/no-string-refs](docs/rules/no-string-refs.md): Prevent using string references in `ref` attribute. -* [react/no-this-in-sfc](docs/rules/no-this-in-sfc.md): Prevent using `this` in stateless functional components -* [react/no-unescaped-entities](docs/rules/no-unescaped-entities.md): Prevent invalid characters from appearing in markup +* [react/no-redundant-should-component-update](docs/rules/no-redundant-should-component-update.md): Flag shouldComponentUpdate when extending PureComponent +* [react/no-render-return-value](docs/rules/no-render-return-value.md): Prevent usage of the return value of React.render +* [react/no-set-state](docs/rules/no-set-state.md): Prevent usage of setState +* [react/no-string-refs](docs/rules/no-string-refs.md): Prevent string definitions for references and prevent referencing this.refs +* [react/no-this-in-sfc](docs/rules/no-this-in-sfc.md): Report "this" being used in stateless components +* [react/no-typos](docs/rules/no-typos.md): Prevent common typos +* [react/no-unescaped-entities](docs/rules/no-unescaped-entities.md): Detect unescaped HTML entities, which might represent malformed tags * [react/no-unknown-property](docs/rules/no-unknown-property.md): Prevent usage of unknown DOM property (fixable) * [react/no-unsafe](docs/rules/no-unsafe.md): Prevent usage of unsafe lifecycle methods * [react/no-unused-prop-types](docs/rules/no-unused-prop-types.md): Prevent definitions of unused prop types -* [react/no-unused-state](docs/rules/no-unused-state.md): Prevent definitions of unused state properties -* [react/no-will-update-set-state](docs/rules/no-will-update-set-state.md): Prevent usage of `setState` in `componentWillUpdate` +* [react/no-unused-state](docs/rules/no-unused-state.md): Prevent definition of unused state fields +* [react/no-will-update-set-state](docs/rules/no-will-update-set-state.md): Prevent usage of setState in componentWillUpdate * [react/prefer-es6-class](docs/rules/prefer-es6-class.md): Enforce ES5 or ES6 class for React Components -* [react/prefer-read-only-props](docs/rules/prefer-read-only-props.md): Enforce that props are read-only -* [react/prefer-stateless-function](docs/rules/prefer-stateless-function.md): Enforce stateless React Components to be written as a pure function +* [react/prefer-read-only-props](docs/rules/prefer-read-only-props.md): Require read-only props. (fixable) +* [react/prefer-stateless-function](docs/rules/prefer-stateless-function.md): Enforce stateless components to be written as a pure function * [react/prop-types](docs/rules/prop-types.md): Prevent missing props validation in a React component definition -* [react/react-in-jsx-scope](docs/rules/react-in-jsx-scope.md): Prevent missing `React` when using JSX -* [react/require-default-props](docs/rules/require-default-props.md): Enforce a defaultProps definition for every prop that is not a required prop -* [react/require-optimization](docs/rules/require-optimization.md): Enforce React components to have a `shouldComponentUpdate` method +* [react/react-in-jsx-scope](docs/rules/react-in-jsx-scope.md): Prevent missing React when using JSX +* [react/require-default-props](docs/rules/require-default-props.md): Enforce a defaultProps definition for every prop that is not a required prop. +* [react/require-optimization](docs/rules/require-optimization.md): Enforce React components to have a shouldComponentUpdate method * [react/require-render-return](docs/rules/require-render-return.md): Enforce ES5 or ES6 class for returning value in render function * [react/self-closing-comp](docs/rules/self-closing-comp.md): Prevent extra closing tags for components without children (fixable) -* [react/sort-comp](docs/rules/sort-comp.md): Enforce component methods order (fixable) +* [react/sort-comp](docs/rules/sort-comp.md): Enforce component methods order * [react/sort-prop-types](docs/rules/sort-prop-types.md): Enforce propTypes declarations alphabetical sorting -* [react/state-in-constructor](docs/rules/state-in-constructor.md): Enforce the state initialization style to be either in a constructor or with a class property -* [react/static-property-placement](docs/rules/static-property-placement.md): Enforces where React component static properties should be positioned. -* [react/style-prop-object](docs/rules/style-prop-object.md): Enforce style prop value being an object -* [react/void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md): Prevent void DOM elements (e.g. ``, `
`) from receiving children +* [react/state-in-constructor](docs/rules/state-in-constructor.md): State initialization in an ES6 class component should be in a constructor +* [react/static-property-placement](docs/rules/static-property-placement.md): Defines where React component static properties should be positioned. +* [react/style-prop-object](docs/rules/style-prop-object.md): Enforce style prop value is an object +* [react/void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md): Prevent passing of children to void DOM elements (e.g. `
`). + ## JSX-specific rules + * [react/jsx-boolean-value](docs/rules/jsx-boolean-value.md): Enforce boolean attributes notation in JSX (fixable) -* [react/jsx-child-element-spacing](docs/rules/jsx-child-element-spacing.md): Enforce or disallow spaces inside of curly braces in JSX attributes and expressions. +* [react/jsx-child-element-spacing](docs/rules/jsx-child-element-spacing.md): Ensures inline tags are not rendered without spaces between them * [react/jsx-closing-bracket-location](docs/rules/jsx-closing-bracket-location.md): Validate closing bracket location in JSX (fixable) -* [react/jsx-closing-tag-location](docs/rules/jsx-closing-tag-location.md): Validate closing tag location in JSX (fixable) -* [react/jsx-curly-newline](docs/rules/jsx-curly-newline.md): Enforce or disallow newlines inside of curly braces in JSX attributes and expressions (fixable) -* [react/jsx-curly-spacing](docs/rules/jsx-curly-spacing.md): Enforce or disallow spaces inside of curly braces in JSX attributes and expressions (fixable) -* [react/jsx-equals-spacing](docs/rules/jsx-equals-spacing.md): Enforce or disallow spaces around equal signs in JSX attributes (fixable) +* [react/jsx-closing-tag-location](docs/rules/jsx-closing-tag-location.md): Validate closing tag location for multiline JSX (fixable) +* [react/jsx-curly-brace-presence](docs/rules/jsx-curly-brace-presence.md): Disallow unnecessary JSX expressions when literals alone are sufficient or enfore JSX expressions on literals in JSX children or attributes (fixable) +* [react/jsx-curly-newline](docs/rules/jsx-curly-newline.md): enforce consistent line breaks inside jsx curly (fixable) +* [react/jsx-curly-spacing](docs/rules/jsx-curly-spacing.md): Enforce or disallow spaces inside of curly braces in JSX attributes (fixable) +* [react/jsx-equals-spacing](docs/rules/jsx-equals-spacing.md): Disallow or enforce spaces around equal signs in JSX attributes (fixable) * [react/jsx-filename-extension](docs/rules/jsx-filename-extension.md): Restrict file extensions that may contain JSX -* [react/jsx-first-prop-new-line](docs/rules/jsx-first-prop-new-line.md): Enforce position of the first prop in JSX (fixable) +* [react/jsx-first-prop-new-line](docs/rules/jsx-first-prop-new-line.md): Ensure proper position of the first property in JSX (fixable) +* [react/jsx-fragments](docs/rules/jsx-fragments.md): Enforce shorthand or standard form for React fragments (fixable) * [react/jsx-handler-names](docs/rules/jsx-handler-names.md): Enforce event handler naming conventions in JSX * [react/jsx-indent](docs/rules/jsx-indent.md): Validate JSX indentation (fixable) * [react/jsx-indent-props](docs/rules/jsx-indent-props.md): Validate props indentation in JSX (fixable) -* [react/jsx-key](docs/rules/jsx-key.md): Validate JSX has key prop when in array or iterator +* [react/jsx-key](docs/rules/jsx-key.md): Report missing `key` props in iterators/collection literals * [react/jsx-max-depth](docs/rules/jsx-max-depth.md): Validate JSX maximum depth * [react/jsx-max-props-per-line](docs/rules/jsx-max-props-per-line.md): Limit maximum of props on a single line in JSX (fixable) -* [react/jsx-no-bind](docs/rules/jsx-no-bind.md): Prevent usage of `.bind()` and arrow functions in JSX props -* [react/jsx-no-comment-textnodes](docs/rules/jsx-no-comment-textnodes.md): Prevent comments from being inserted as text nodes -* [react/jsx-no-duplicate-props](docs/rules/jsx-no-duplicate-props.md): Prevent duplicate props in JSX -* [react/jsx-no-literals](docs/rules/jsx-no-literals.md): Prevent usage of unwrapped JSX strings -* [react/jsx-no-script-url](docs/rules/jsx-no-script-url.md): Prevent usage of `javascript:` URLs -* [react/jsx-no-target-blank](docs/rules/jsx-no-target-blank.md): Prevent usage of unsafe `target='_blank'` +* [react/jsx-no-bind](docs/rules/jsx-no-bind.md): Prevents usage of Function.prototype.bind and arrow functions in React component props +* [react/jsx-no-comment-textnodes](docs/rules/jsx-no-comment-textnodes.md): Comments inside children section of tag should be placed inside braces +* [react/jsx-no-duplicate-props](docs/rules/jsx-no-duplicate-props.md): Enforce no duplicate props +* [react/jsx-no-literals](docs/rules/jsx-no-literals.md): Prevent using string literals in React component definition +* [react/jsx-no-script-url](docs/rules/jsx-no-script-url.md): Forbid `javascript:` URLs +* [react/jsx-no-target-blank](docs/rules/jsx-no-target-blank.md): Forbid target="_blank" attribute without rel="noopener noreferrer" * [react/jsx-no-undef](docs/rules/jsx-no-undef.md): Disallow undeclared variables in JSX * [react/jsx-no-useless-fragment](docs/rules/jsx-no-useless-fragment.md): Disallow unnecessary fragments (fixable) -* [react/jsx-one-expression-per-line](docs/rules/jsx-one-expression-per-line.md): Limit to one expression per line in JSX -* [react/jsx-curly-brace-presence](docs/rules/jsx-curly-brace-presence.md): Enforce curly braces or disallow unnecessary curly braces in JSX -* [react/jsx-fragments](docs/rules/jsx-fragments.md): Enforce shorthand or standard form for React fragments +* [react/jsx-one-expression-per-line](docs/rules/jsx-one-expression-per-line.md): Limit to one expression per line in JSX (fixable) * [react/jsx-pascal-case](docs/rules/jsx-pascal-case.md): Enforce PascalCase for user-defined JSX components * [react/jsx-props-no-multi-spaces](docs/rules/jsx-props-no-multi-spaces.md): Disallow multiple spaces between inline JSX props (fixable) -* [react/jsx-props-no-spreading](docs/rules/jsx-props-no-spreading.md): Disallow JSX props spreading +* [react/jsx-props-no-spreading](docs/rules/jsx-props-no-spreading.md): Prevent JSX prop spreading * [react/jsx-sort-default-props](docs/rules/jsx-sort-default-props.md): Enforce default props alphabetical sorting * [react/jsx-sort-props](docs/rules/jsx-sort-props.md): Enforce props alphabetical sorting (fixable) * [react/jsx-space-before-closing](docs/rules/jsx-space-before-closing.md): Validate spacing before closing bracket in JSX (fixable) * [react/jsx-tag-spacing](docs/rules/jsx-tag-spacing.md): Validate whitespace in and around the JSX opening and closing brackets (fixable) -* [react/jsx-uses-react](docs/rules/jsx-uses-react.md): Prevent React to be incorrectly marked as unused -* [react/jsx-uses-vars](docs/rules/jsx-uses-vars.md): Prevent variables used in JSX to be incorrectly marked as unused +* [react/jsx-uses-react](docs/rules/jsx-uses-react.md): Prevent React to be marked as unused +* [react/jsx-uses-vars](docs/rules/jsx-uses-vars.md): Prevent variables used in JSX to be marked as unused * [react/jsx-wrap-multilines](docs/rules/jsx-wrap-multilines.md): Prevent missing parentheses around multilines JSX (fixable) + ## Other useful plugins diff --git a/lib/rules/void-dom-elements-no-children.js b/lib/rules/void-dom-elements-no-children.js index e4e1ce6643..d25cc49dde 100644 --- a/lib/rules/void-dom-elements-no-children.js +++ b/lib/rules/void-dom-elements-no-children.js @@ -51,7 +51,7 @@ function errorMessage(elementName) { module.exports = { meta: { docs: { - description: 'Prevent passing of children to void DOM elements (e.g.
).', + description: 'Prevent passing of children to void DOM elements (e.g. `
`).', category: 'Best Practices', recommended: false, url: docsUrl('void-dom-elements-no-children') diff --git a/markdown.config.js b/markdown.config.js new file mode 100644 index 0000000000..1dae91db15 --- /dev/null +++ b/markdown.config.js @@ -0,0 +1,25 @@ +'use strict'; + +const {rules} = require('./index'); + +const ruleListItems = Object.keys(rules) + .sort() + .map((id) => { + const {meta} = rules[id]; + const {fixable, docs} = meta; + return `* [react/${id}](docs/rules/${id}.md): ${docs.description}${fixable ? ' (fixable)' : ''}`; + }); + +const BASIC_RULES = () => ruleListItems.filter(rule => !rule.includes('react/jsx-')).join('\n'); +const JSX_RULES = () => ruleListItems.filter(rule => rule.includes('react/jsx-')).join('\n'); + +module.exports = { + transforms: { + BASIC_RULES, + JSX_RULES + }, + callback: () => { + // eslint-disable-next-line no-console + console.log('The auto-generating of rules finished!'); + } +}; diff --git a/package.json b/package.json index 0ca6791999..b314901aba 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,9 @@ "pretest": "npm run lint", "test": "npm run unit-test", "type-check": "tsc", - "unit-test": "istanbul cover node_modules/mocha/bin/_mocha tests/lib/**/*.js tests/util/**/*.js tests/index.js" + "unit-test": "istanbul cover node_modules/mocha/bin/_mocha tests/lib/**/*.js tests/util/**/*.js tests/index.js", + "generate-list-of-rules": "md-magic --path README.md", + "generate-list-of-rules:check": "npm run generate-list-of-rules && git diff --exit-code README.md" }, "files": [ "LICENSE", @@ -47,6 +49,7 @@ "eslint-plugin-eslint-plugin": "^2.1.0", "eslint-plugin-import": "^2.18.2", "istanbul": "^0.4.5", + "markdown-magic": "^1.0.0", "mocha": "^5.2.0", "sinon": "^7.5.0", "typescript": "^3.7.2",