eslint-plugin-reblend
Version:
Reblend specific linting rules for ESLint
805 lines (671 loc) ā¢ 11.5 kB
Markdown
# Disallow missing parentheses around multiline JSX (`reblend/jsx-wrap-multilines`)
š§ This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
<!-- end auto-generated rule header -->
Wrapping multiline JSX in parentheses can improve readability and/or convenience.
## Rule Details
This rule optionally takes a second parameter in the form of an object, containing places to apply the rule. By default, all the syntax listed below will be checked except the conditions out of declaration or assignment, logical expressions and JSX attributes, but these can be explicitly disabled. Any syntax type missing in the object will follow the default behavior displayed below.
```json
{
"declaration": "parens",
"assignment": "parens",
"return": "parens",
"arrow": "parens",
"condition": "ignore",
"logical": "ignore",
"prop": "ignore"
}
```
Note: conditions are checked by default in declarations or assignments.
## Rule Options
Examples of **incorrect** code for this rule, when configured with `parens` or `parens-new-line`:
```jsx
var Hello = createReblendClass({
render: function () {
return (
<div>
<p>Hello {this.props.name}</p>
</div>
);
},
});
```
Examples of **incorrect** code for this rule, when configured with `parens-new-line`:
```jsx
var Hello = createReblendClass({
render: function () {
return (
<div>
<p>Hello {this.props.name}</p>
</div>
);
},
});
```
Examples of **correct** code for this rule, when configured with either `parens` or `parens-new-line`:
```jsx
var singleLineJSX = <p>Hello</p>;
var Hello = createReblendClass({
render: function () {
return (
<div>
<p>Hello {this.props.name}</p>
</div>
);
},
});
```
Examples of **incorrect** code for this rule, when configured with `never`:
```jsx
var singleLineJSX = <p>Hello</p>;
var Hello = createReblendClass({
render: function () {
return (
<div>
<p>Hello {this.props.name}</p>
</div>
);
},
});
```
Examples of **correct** code for this rule, when configured with `never`:
```jsx
var singleLineJSX = <p>Hello</p>;
var Hello = createReblendClass({
render: function () {
return (
<div>
<p>Hello {this.props.name}</p>
</div>
);
},
});
```
### `declaration`
Examples of **incorrect** code for this rule, when configured with `{ declaration: "parens" }`:
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ declaration: "parens" }`:
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ declaration: "parens-new-line" }`:
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ declaration: "parens-new-line" }`.
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ declaration: "never" }`:
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ declaration: "never" }`.
```jsx
var hello = (
<div>
<p>Hello</p>
</div>
);
```
### `assignment`
Examples of **incorrect** code for this rule, when configured with `{ assignment: "parens" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ assignment: "parens" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ assignment: "parens-new-line" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ assignment: "parens-new-line" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ assignment: "never" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ assignment: "never" }`.
```jsx
var hello;
hello = (
<div>
<p>Hello</p>
</div>
);
```
### `return`
Examples of **incorrect** code for this rule, when configured with `{ return: "parens" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
Examples of **correct** code for this rule, when configured with `{ return: "parens" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
Examples of **incorrect** code for this rule, when configured with `{ return: "parens-new-line" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
Examples of **correct** code for this rule, when configured with `{ return: "parens-new-line" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
Examples of **incorrect** code for this rule, when configured with `{ return: "never" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
Examples of **correct** code for this rule, when configured with `{ return: "never" }`.
```jsx
function hello() {
return (
<div>
<p>Hello</p>
</div>
);
}
```
### `arrow`
Examples of **incorrect** code for this rule, when configured with `{ arrow: "parens" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
Examples of **correct** code for this rule, when configured `{ arrow: "parens" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ arrow: "parens-new-line" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ arrow: "parens-new-line" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
Examples of **incorrect** code for this rule, when configured with `{ arrow: "never" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
Examples of **correct** code for this rule, when configured with `{ arrow: "never" }`.
```jsx
var hello = () => (
<div>
<p>World</p>
</div>
);
```
### `condition`
Examples of **incorrect** code for this rule, when configured with `{ condition: "parens" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
Examples of **correct** code for this rule, when configured with `{ condition: "parens" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ condition: "parens-new-line" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
Examples of **correct** code for this rule, when configured with `{ condition: "parens-new-line" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ condition: "never" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
Examples of **correct** code for this rule, when configured with `{ condition: "never" }`.
```jsx
<div>
{foo ? (
<div>
<p>Hello</p>
</div>
) : null}
</div>
```
### `logical`
Examples of **incorrect** code for this rule, when configured with `{ logical: "parens" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
Examples of **correct** code for this rule, when configured with `{ logical: "parens" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ logical: "parens-new-line" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
Examples of **correct** code for this rule, when configured with `{ logical: "parens-new-line" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ logical: "never" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
Examples of **correct** code for this rule, when configured with `{ logical: "never" }`.
```jsx
<div>
{foo && (
<div>
<p>Hello World</p>
</div>
)}
</div>
```
### `prop`
Examples of **incorrect** code for this rule, when configured with `{ prop: "parens" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
Examples of **correct** code for this rule, when configured with `{ prop: "parens" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ prop: "parens-new-line" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
Examples of **correct** code for this rule, when configured with `{ prop: "parens-new-line" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
Examples of **incorrect** code for this rule, when configured with `{ prop: "never" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```
Examples of **correct** code for this rule, when configured with `{ prop: "never" }`.
```jsx
<div
foo={
<div>
<p>Hello</p>
</div>
}
>
<p>Hello</p>
</div>
```