Merge pull request #988 from airbnb/eslint-markdown

lint our markdown

.eslintignore

@@ -0,0 +1,2 @@
+_book/
+build/

.eslintrc-markdown

@@ -0,0 +1,21 @@
+{
+  "extends": "./.eslintrc",
+  "root": true,
+  "plugins": [
+    "markdown"
+  ],
+  "rules": {
+    "class-methods-use-this": 0,
+    "import/no-unresolved": 0,
+    "import/no-extraneous-dependencies": 0,
+    "import/extensions": 0,
+    "max-len": 0,
+    "no-unused-vars": 0,
+    "no-console": 0,
+    "no-undef": 0,
+    "react/react-in-jsx-scope": 0,
+    "react/jsx-filename-extension": 0,
+    "react/jsx-no-undef": 0,
+    "react/no-multi-comp": 0,
+  },
+}

README.md

@@ -101,19 +101,19 @@ describe('<MyComponent />', () => {
   });
 
   it('renders children when passed in', () => {
-    const wrapper = shallow(
+    const wrapper = shallow((
       <MyComponent>
         <div className="unique" />
       </MyComponent>
-    );
+    ));
     expect(wrapper.contains(<div className="unique" />)).to.equal(true);
   });
 
   it('simulates click events', () => {
     const onButtonClick = sinon.spy();
-    const wrapper = shallow(
+    const wrapper = shallow((
       <Foo onButtonClick={onButtonClick} />
-    );
+    ));
     wrapper.find('button').simulate('click');
     expect(onButtonClick).to.have.property('callCount', 1);
   });
@@ -144,9 +144,9 @@ describe('<Foo />', () => {
 
   it('simulates click events', () => {
     const onButtonClick = sinon.spy();
-    const wrapper = mount(
+    const wrapper = mount((
       <Foo onButtonClick={onButtonClick} />
-    );
+    ));
     wrapper.find('button').simulate('click');
     expect(onButtonClick).to.have.property('callCount', 1);
   });

docs/api/ReactWrapper/at.md

@@ -19,7 +19,7 @@ Returns a wrapper around the node at a given index of the current wrapper.
 
 ```jsx
 const wrapper = mount(<MyComponent />);
-expect(wrapper.find(Foo).at(0).props().foo).to.equal("bar");
+expect(wrapper.find(Foo).at(0).props().foo).to.equal('bar');
 ```
 
 

docs/api/ReactWrapper/contains.md

@@ -22,11 +22,11 @@ the ones passed in.
 
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <div data-foo="foo" data-bar="bar">Hello</div>
   </div>
-);
+));
 
 expect(wrapper.contains(<div data-foo="foo" data-bar="bar">Hello</div>)).to.equal(true);
 
@@ -37,13 +37,13 @@ expect(wrapper.contains(<div data-foo="foo" data-bar="bar" />)).to.equal(false);
 ```
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <span>Hello</span>
     <div>Goodbye</div>
     <span>Again</span>
   </div>
-);
+));
 
 expect(wrapper.contains([
   <span>Hello</span>,

docs/api/ReactWrapper/containsAllMatchingElements.md

@@ -22,13 +22,13 @@ like the nodes passed in.
 
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <span className="foo">Hello</span>
     <div style={{ fontSize: 13 }}>Goodbye</div>
     <span>Again</span>
   </div>
-);
+));
 
 expect(wrapper.containsAllMatchingElements([
   <span>Hello</span>,

docs/api/ReactWrapper/containsAnyMatchingElements.md

@@ -22,13 +22,13 @@ like one of the array passed in.
 
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <span className="foo">Hello</span>
     <div style={{ fontSize: 13 }}>Goodbye</div>
     <span>Again</span>
   </div>
-);
+));
 
 expect(wrapper.containsAnyMatchingElements([
   <span>Bonjour</span>,

docs/api/ReactWrapper/containsMatchingElement.md

@@ -22,28 +22,18 @@ the one passed in.
 
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <div data-foo="foo" data-bar="bar">Hello</div>
   </div>
-);
-
-expect(wrapper.containsMatchingElement(
-  <div data-foo="foo" data-bar="bar">Hello</div>
-)).to.equal(true);
-expect(wrapper.containsMatchingElement(
-  <div data-foo="foo">Hello</div>
-)).to.equal(true);
-
-expect(wrapper.containsMatchingElement(
-  <div data-foo="foo" data-bar="bar" data-baz="baz">Hello</div>
-)).to.equal(false);
-expect(wrapper.containsMatchingElement(
-  <div data-foo="foo" data-bar="Hello">Hello</div>
-)).to.equal(false);
-expect(wrapper.containsMatchingElement(
-  <div data-foo="foo" data-bar="bar" />
-)).to.equal(false);
+));
+
+expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar">Hello</div>)).to.equal(true);
+expect(wrapper.containsMatchingElement(<div data-foo="foo">Hello</div>)).to.equal(true);
+
+expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar" data-baz="baz">Hello</div>)).to.equal(false);
+expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="Hello">Hello</div>)).to.equal(false);
+expect(wrapper.containsMatchingElement(<div data-foo="foo" data-bar="bar" />)).to.equal(false);
 ```
 
 #### Common Gotchas

docs/api/ReactWrapper/context.md

@@ -17,7 +17,7 @@ root component instance.
 ```jsx
 const wrapper = mount(
   <MyComponent />,
-  { context: { foo: 10 } }
+  { context: { foo: 10 } },
 );
 
 expect(wrapper.context().foo).to.equal(10);

docs/api/ReactWrapper/debug.md

@@ -14,25 +14,21 @@ console when tests are not passing when you expect them to.
 
 Say we have the following components:
 ```jsx
-class Foo extends React.Component {
-  render() {
-    return (
-      <div className="foo">
-        <span>Foo</span>
-      </div>
-    );
-  }
+function Foo() {
+  return (
+    <div className="foo">
+      <span>Foo</span>
+    </div>
+  );
 }
 
-class Bar extends React.Component {
-  render() {
-    return (
-      <div className="bar">
-        <span>Non-Foo</span>
-        <Foo baz="bax" />
-      </div>
-    );
-  }
+function Bar() {
+  return (
+    <div className="bar">
+      <span>Non-Foo</span>
+      <Foo baz="bax" />
+    </div>
+  );
 }
 ```
 
@@ -42,6 +38,7 @@ console.log(mount(<Bar id="2" />).debug());
 ```
 
 Would output the following to the console:
+<!-- eslint-disable -->
 ```jsx
 <Bar id="2">
   <div className="bar">
@@ -65,6 +62,7 @@ Likewise, running:
 console.log(mount(<Bar id="2" />).find(Foo).debug());
 ```
 Would output the following to the console:
+<!-- eslint-disable -->
 ```jsx
 <Foo baz="bax">
   <div className="foo">

docs/api/ReactWrapper/every.md

@@ -18,13 +18,13 @@ Returns whether or not all of the nodes in the wrapper match the provided select
 #### Examples
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <div className="foo qoo" />
     <div className="foo boo" />
     <div className="foo hoo" />
   </div>
-);
+));
 expect(wrapper.find('.foo').every('.foo')).to.equal(true);
 expect(wrapper.find('.foo').every('.qoo')).to.equal(false);
 expect(wrapper.find('.foo').every('.bar')).to.equal(false);

docs/api/ReactWrapper/everyWhere.md

@@ -18,13 +18,13 @@ Returns whether or not all of the nodes in the wrapper pass the provided predica
 #### Example
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <div className="foo qoo" />
     <div className="foo boo" />
     <div className="foo hoo" />
   </div>
-);
+));
 expect(wrapper.find('.foo').everyWhere(n => n.hasClass('foo'))).to.equal(true);
 expect(wrapper.find('.foo').everyWhere(n => n.hasClass('qoo'))).to.equal(false);
 expect(wrapper.find('.foo').everyWhere(n => n.hasClass('bar'))).to.equal(false);

docs/api/ReactWrapper/find.md

@@ -50,7 +50,7 @@ expect(wrapper.find('Foo')).to.have.length(1);
 Object Property Selector:
 ```jsx
 const wrapper = mount(<MyComponent />);
-expect(wrapper.find({prop: 'value'})).to.have.length(1);
+expect(wrapper.find({ prop: 'value' })).to.have.length(1);
 ```
 
 #### Related Methods

docs/api/ReactWrapper/first.md

@@ -14,5 +14,5 @@ Reduce the set of matched nodes to the first in the set.
 
 ```jsx
 const wrapper = mount(<MyComponent />);
-expect(wrapper.find(Foo).first().props().foo).to.equal("bar");
+expect(wrapper.find(Foo).first().props().foo).to.equal('bar');
 ```

docs/api/ReactWrapper/forEach.md

@@ -21,15 +21,15 @@ instance.
 #### Example
 
 ```jsx
-const wrapper = mount(
+const wrapper = mount((
   <div>
     <div className="foo bax" />
     <div className="foo bar" />
     <div className="foo baz" />
   </div>
-);
+));
 
-wrapper.find('.foo').forEach(function (node) {
+wrapper.find('.foo').forEach((node) => {
   expect(node.hasClass('foo')).to.equal(true);
 });
 ```

docs/api/ReactWrapper/get.md

@@ -19,7 +19,7 @@ Returns the node at a given index of the current wrapper.
 
 ```jsx
 const wrapper = mount(<MyComponent />);
-expect(wrapper.find(Foo).get(0).props.foo).to.equal("bar");
+expect(wrapper.find(Foo).get(0).props.foo).to.equal('bar');
 ```
 
 

docs/api/ReactWrapper/getDOMNode.md

@@ -17,5 +17,5 @@ Notes:
 
 ```jsx
 const wrapper = mount(<MyComponent />);
-expect(wrapper.getDOMNode()).to.have.property("className");
+expect(wrapper.getDOMNode()).to.have.property('className');
 ```

docs/api/ReactWrapper/getNode.md

@@ -12,15 +12,13 @@ Returns the wrapper's underlying node.
 #### Examples
 
 ```jsx
-class Test extends React.Component {
-  render() {
-    return (
-      <div>
-        <span />
-        <span />
-      </div>
-    );
-  }
+function Test() {
+  return (
+    <div>
+      <span />
+      <span />
+    </div>
+  );
 }
 
 const wrapper = mount(<Test />);

docs/api/ReactWrapper/getNodes.md

@@ -12,15 +12,13 @@ Returns the wrapper's underlying nodes.
 #### Examples
 
 ```jsx
-class Test extends React.Component {
-  render() {
-    return (
-      <div>
-        <span />
-        <span />
-      </div>
-    );
-  }
+function Test() {
+  return (
+    <div>
+      <span />
+      <span />
+    </div>
+  );
 }
 
 const wrapper = mount(<Test />);