Skip to content

Commit 12cdf2d

Browse files
ljharbljharb
committed
[Docs] clean up linting errors in ReactWrapper API docs
1 parent 0676ee7 commit 12cdf2d

38 files changed

+161
-182
lines changed

‎docs/api/ReactWrapper/at.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Returns a wrapper around the node at a given index of the current wrapper.
1919

2020
```jsx
2121
const wrapper = mount(<MyComponent />);
22-
expect(wrapper.find(Foo).at(0).props().foo).to.equal("bar");
22+
expect(wrapper.find(Foo).at(0).props().foo).to.equal('bar');
2323
```
2424

2525

‎docs/api/ReactWrapper/contains.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ the ones passed in.
2222

2323

2424
```jsx
25-
const wrapper = mount(
25+
const wrapper = mount((
2626
<div>
2727
<div data-foo="foo" data-bar="bar">Hello</div>
2828
</div>
29-
);
29+
));
3030

3131
expect(wrapper.contains(<div data-foo="foo" data-bar="bar">Hello</div>)).to.equal(true);
3232

@@ -37,13 +37,13 @@ expect(wrapper.contains(<div data-foo="foo" data-bar="bar" />)).to.equal(false);
3737
```
3838

3939
```jsx
40-
const wrapper = mount(
40+
const wrapper = mount((
4141
<div>
4242
<span>Hello</span>
4343
<div>Goodbye</div>
4444
<span>Again</span>
4545
</div>
46-
);
46+
));
4747

4848
expect(wrapper.contains([
4949
<span>Hello</span>,

‎docs/api/ReactWrapper/containsAllMatchingElements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ like the nodes passed in.
2222

2323

2424
```jsx
25-
const wrapper = mount(
25+
const wrapper = mount((
2626
<div>
2727
<span className="foo">Hello</span>
2828
<div style={{ fontSize: 13 }}>Goodbye</div>
2929
<span>Again</span>
3030
</div>
31-
);
31+
));
3232

3333
expect(wrapper.containsAllMatchingElements([
3434
<span>Hello</span>,

‎docs/api/ReactWrapper/containsAnyMatchingElements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ like one of the array passed in.
2222

2323

2424
```jsx
25-
const wrapper = mount(
25+
const wrapper = mount((
2626
<div>
2727
<span className="foo">Hello</span>
2828
<div style={{ fontSize: 13 }}>Goodbye</div>
2929
<span>Again</span>
3030
</div>
31-
);
31+
));
3232

3333
expect(wrapper.containsAnyMatchingElements([
3434
<span>Bonjour</span>,

‎docs/api/ReactWrapper/containsMatchingElement.md

+9-19
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,18 @@ the one passed in.
2222

2323

2424
```jsx
25-
const wrapper = mount(
25+
const wrapper = mount((
2626
<div>
2727
<div data-foo="foo" data-bar="bar">Hello</div>
2828
</div>
29-
);
30-
31-
expect(wrapper.containsMatchingElement(
32-
<div data-foo="foo" data-bar="bar">Hello</div>
33-
)).to.equal(true);
34-
expect(wrapper.containsMatchingElement(
35-
<div data-foo="foo">Hello</div>
36-
)).to.equal(true);
37-
38-
expect(wrapper.containsMatchingElement(
39-
<div data-foo="foo" data-bar="bar" data-baz="baz">Hello</div>
40-
)).to.equal(false);
41-
expect(wrapper.containsMatchingElement(
42-
<div data-foo="foo" data-bar="Hello">Hello</div>
43-
)).to.equal(false);
44-
expect(wrapper.containsMatchingElement(
45-
<div data-foo="foo" data-bar="bar" />
46-
)).to.equal(false);
29+
));
30+
31+
expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar">Hello</div>)).to.equal(true);
32+
expect(wrapper.containsMatchingElement(<div data-foo="foo">Hello</div>)).to.equal(true);
33+
34+
expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar" data-baz="baz">Hello</div>)).to.equal(false);
35+
expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="Hello">Hello</div>)).to.equal(false);
36+
expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar" />)).to.equal(false);
4737
```
4838

4939
#### Common Gotchas

‎docs/api/ReactWrapper/context.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ root component instance.
1717
```jsx
1818
const wrapper = mount(
1919
<MyComponent />,
20-
{ context: { foo: 10 } }
20+
{ context: { foo: 10 } },
2121
);
2222

2323
expect(wrapper.context().foo).to.equal(10);

‎docs/api/ReactWrapper/debug.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,21 @@ console when tests are not passing when you expect them to.
1414

1515
Say we have the following components:
1616
```jsx
17-
class Foo extends React.Component {
18-
render() {
19-
return (
20-
<div className="foo">
21-
<span>Foo</span>
22-
</div>
23-
);
24-
}
17+
function Foo() {
18+
return (
19+
<div className="foo">
20+
<span>Foo</span>
21+
</div>
22+
);
2523
}
2624

27-
class Bar extends React.Component {
28-
render() {
29-
return (
30-
<div className="bar">
31-
<span>Non-Foo</span>
32-
<Foo baz="bax" />
33-
</div>
34-
);
35-
}
25+
function Bar() {
26+
return (
27+
<div className="bar">
28+
<span>Non-Foo</span>
29+
<Foo baz="bax" />
30+
</div>
31+
);
3632
}
3733
```
3834

@@ -42,6 +38,7 @@ console.log(mount(<Bar id="2" />).debug());
4238
```
4339

4440
Would output the following to the console:
41+
<!-- eslint-disable -->
4542
```jsx
4643
<Bar id="2">
4744
<div className="bar">
@@ -65,6 +62,7 @@ Likewise, running:
6562
console.log(mount(<Bar id="2" />).find(Foo).debug());
6663
```
6764
Would output the following to the console:
65+
<!-- eslint-disable -->
6866
```jsx
6967
<Foo baz="bax">
7068
<div className="foo">

‎docs/api/ReactWrapper/every.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Returns whether or not all of the nodes in the wrapper match the provided select
1818
#### Examples
1919

2020
```jsx
21-
const wrapper = mount(
21+
const wrapper = mount((
2222
<div>
2323
<div className="foo qoo" />
2424
<div className="foo boo" />
2525
<div className="foo hoo" />
2626
</div>
27-
);
27+
));
2828
expect(wrapper.find('.foo').every('.foo')).to.equal(true);
2929
expect(wrapper.find('.foo').every('.qoo')).to.equal(false);
3030
expect(wrapper.find('.foo').every('.bar')).to.equal(false);

‎docs/api/ReactWrapper/everyWhere.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Returns whether or not all of the nodes in the wrapper pass the provided predica
1818
#### Example
1919

2020
```jsx
21-
const wrapper = mount(
21+
const wrapper = mount((
2222
<div>
2323
<div className="foo qoo" />
2424
<div className="foo boo" />
2525
<div className="foo hoo" />
2626
</div>
27-
);
27+
));
2828
expect(wrapper.find('.foo').everyWhere(n => n.hasClass('foo'))).to.equal(true);
2929
expect(wrapper.find('.foo').everyWhere(n => n.hasClass('qoo'))).to.equal(false);
3030
expect(wrapper.find('.foo').everyWhere(n => n.hasClass('bar'))).to.equal(false);

‎docs/api/ReactWrapper/find.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ expect(wrapper.find('Foo')).to.have.length(1);
5050
Object Property Selector:
5151
```jsx
5252
const wrapper = mount(<MyComponent />);
53-
expect(wrapper.find({prop: 'value'})).to.have.length(1);
53+
expect(wrapper.find({ prop: 'value' })).to.have.length(1);
5454
```
5555

5656
#### Related Methods

‎docs/api/ReactWrapper/first.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Reduce the set of matched nodes to the first in the set.
1414

1515
```jsx
1616
const wrapper = mount(<MyComponent />);
17-
expect(wrapper.find(Foo).first().props().foo).to.equal("bar");
17+
expect(wrapper.find(Foo).first().props().foo).to.equal('bar');
1818
```

‎docs/api/ReactWrapper/forEach.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ instance.
2121
#### Example
2222

2323
```jsx
24-
const wrapper = mount(
24+
const wrapper = mount((
2525
<div>
2626
<div className="foo bax" />
2727
<div className="foo bar" />
2828
<div className="foo baz" />
2929
</div>
30-
);
30+
));
3131

32-
wrapper.find('.foo').forEach(function (node) {
32+
wrapper.find('.foo').forEach((node) => {
3333
expect(node.hasClass('foo')).to.equal(true);
3434
});
3535
```

‎docs/api/ReactWrapper/get.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Returns the node at a given index of the current wrapper.
1919

2020
```jsx
2121
const wrapper = mount(<MyComponent />);
22-
expect(wrapper.find(Foo).get(0).props.foo).to.equal("bar");
22+
expect(wrapper.find(Foo).get(0).props.foo).to.equal('bar');
2323
```
2424

2525

‎docs/api/ReactWrapper/getDOMNode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ Notes:
1717

1818
```jsx
1919
const wrapper = mount(<MyComponent />);
20-
expect(wrapper.getDOMNode()).to.have.property("className");
20+
expect(wrapper.getDOMNode()).to.have.property('className');
2121
```

‎docs/api/ReactWrapper/getNode.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ Returns the wrapper's underlying node.
1212
#### Examples
1313

1414
```jsx
15-
class Test extends React.Component {
16-
render() {
17-
return (
18-
<div>
19-
<span />
20-
<span />
21-
</div>
22-
);
23-
}
15+
function Test() {
16+
return (
17+
<div>
18+
<span />
19+
<span />
20+
</div>
21+
);
2422
}
2523

2624
const wrapper = mount(<Test />);

‎docs/api/ReactWrapper/getNodes.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ Returns the wrapper's underlying nodes.
1212
#### Examples
1313

1414
```jsx
15-
class Test extends React.Component {
16-
render() {
17-
return (
18-
<div>
19-
<span />
20-
<span />
21-
</div>
22-
);
23-
}
15+
function Test() {
16+
return (
17+
<div>
18+
<span />
19+
<span />
20+
</div>
21+
);
2422
}
2523

2624
const wrapper = mount(<Test />);

‎docs/api/ReactWrapper/html.md

+10-18
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,25 @@ Note: can only be called on a wrapper of a single node.
1414
#### Examples
1515

1616
```jsx
17-
class Foo extends React.Component {
18-
render() {
19-
return (<div className="in-foo" />);
20-
}
17+
function Foo() {
18+
return (<div className="in-foo" />);
2119
}
2220
```
2321

2422
```jsx
25-
class Bar extends React.Component {
26-
render() {
27-
return (
28-
<div className="in-bar">
29-
<Foo />
30-
</div>
31-
);
32-
}
23+
function Bar() {
24+
return (
25+
<div className="in-bar">
26+
<Foo />
27+
</div>
28+
);
3329
}
3430
```
3531

3632
```jsx
3733
const wrapper = mount(<Bar />);
38-
expect(wrapper.html()).to.equal(
39-
`<div class="in-bar"><div class="in-foo"></div></div>`
40-
);
41-
expect(wrapper.find(Foo).html()).to.equal(
42-
`<div class="in-foo"></div>`
43-
);
34+
expect(wrapper.html()).to.equal('<div class="in-bar"><div class="in-foo"></div></div>');
35+
expect(wrapper.find(Foo).html()).to.equal('<div class="in-foo"></div>');
4436
```
4537

4638
```jsx

‎docs/api/ReactWrapper/key.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ NOTE: can only be called on a wrapper of a single node.
88

99

1010
```jsx
11-
const wrapper = mount(
11+
const wrapper = mount((
1212
<ul>
1313
{['foo', 'bar'].map(s => <li key={s}>{s}</li>)}
1414
</ul>
15-
).find('li');
15+
)).find('li');
1616
expect(wrapper.at(0).key()).to.equal('foo');
1717
expect(wrapper.at(1).key()).to.equal('bar');
1818
```

‎docs/api/ReactWrapper/last.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Reduce the set of matched nodes to the last in the set.
1414

1515
```jsx
1616
const wrapper = mount(<MyComponent />);
17-
expect(wrapper.find(Foo).last().props().foo).to.equal("bar");
17+
expect(wrapper.find(Foo).last().props().foo).to.equal('bar');
1818
```

‎docs/api/ReactWrapper/map.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ the original instance.
2121
#### Example
2222

2323
```jsx
24-
const wrapper = mount(
24+
const wrapper = mount((
2525
<div>
2626
<div className="foo">bax</div>
2727
<div className="foo">bar</div>
2828
<div className="foo">baz</div>
2929
</div>
30-
);
30+
));
3131

3232
const texts = wrapper.find('.foo').map(node => node.text());
33-
expect(texts).to.eql([ 'bax', 'bar', 'baz' ]);
33+
expect(texts).to.eql(['bax', 'bar', 'baz']);
3434
```
3535

3636

0 commit comments

Comments
 (0)