JS.REACT.NO.MULTI.COMP

Prevent multiple component definition per file

Declaring only one component per file improves readability and reusability of components.

Rule Details

Examples of incorrect code for this rule:

Copy
var Hello = createReactClass({
  render: function() {
    return <div>Hello {this.props.name}</div>;
  }
});

var HelloJohn = createReactClass({
  render: function() {
    return <Hello name="John" />;
  }
});

Examples of correct code for this rule:

Copy
var Hello = require('./components/Hello');

var HelloJohn = createReactClass({
  render: function() {
    return <Hello name="John" />;
  }
});

Rule Options

Copy
...
"react/no-multi-comp": [<enabled>, { "ignoreStateless": <boolean> }]
...

ignoreStateless

When true the rule will ignore stateless components and will allow you to have multiple stateless components, or one stateful component and some stateless components in the same file.

Examples of correct code for this rule:

Copy
function Hello(props) {
  return <div>Hello {props.name}</div>;
}
function HelloAgain(props) {
  return <div>Hello again {props.name}</div>;
}
Copy
function Hello(props) {
  return <div>Hello {props.name}</div>;
}
class HelloJohn extends React.Component {
  render() {
    return <Hello name="John" />;
  }
}
module.exports = HelloJohn;

When Not To Use It

If you prefer to declare multiple components per file you can disable this rule.

The content on this page is adapted from the ESLint User Guide. Copyright © OpenJS Foundation and other contributors, www.openjsf.org. All rights reserved. https://eslint.org/docs/rules/