Ignore commented-out expect statements (#2)

* ignore commented out expect statements

* update README

* update README and contributor list

* updated tests

* update contributors

* more icons lol

Author: hiddentao

.all-contributorsrc

@@ -18,6 +18,18 @@
         "infra",
         "test"
       ]
+    },
+    {
+      "login": "hiddentao",
+      "name": "Ramesh Nair",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/266594?v=4",
+      "profile": "https://hiddentao.com/",
+      "contributions": [
+        "code",
+        "doc",
+        "example",
+        "test"
+      ]
     }
   ]
 }

README.md

@@ -140,6 +140,37 @@ it('counts multiple assertions too', async () => {
 });
 ```
 
+**Comments are ignored**
+```js
+it('ignores commented-out assertions', async () => {
+  const res = await fetch('www.example.com');
+  // expect(res.json).toBeTruthy();
+  const json = await res.json();
+  /*
+    expect(json).toEqual({ whatever: 'trevor1' });
+  */
+  expect(json).toEqual({ whatever: 'trevor' });
+  /* expect(json).toEqual({ whatever: 'trevor2' }); */
+});
+```
+
+`↓ ↓ ↓ ↓ ↓ ↓`
+
+```js
+it('counts multiple assertions too', async () => {
+  expect.hasAssertions();
+  expect.assertions(1);
+  const res = await fetch('www.example.com');
+  // expect(res.json).toBeTruthy();
+  const json = await res.json();
+  /*
+    expect(json).toEqual({ whatever: 'trevor1' });
+  */
+  expect(json).toEqual({ whatever: 'trevor' });
+  /* expect(json).toEqual({ whatever: 'trevor2' }); */
+});
+```
+
 ### Override
 
 If you add either `expect.assertions(number)` or `expect.hasAssertions()` then your defaults will be favoured and the
@@ -180,8 +211,8 @@ it('will leave test as override supplied', () => {
 ## Contributors
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-| [<img src="https://avatars0.githubusercontent.com/u/5610087?v=4" width="100px;"/><br /><sub>Matt Phillips</sub>](http://mattphillips.io)<br />[💻](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Code") [📖](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Documentation") [🚇](#infra-mattphillips "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Tests") |
-| :---: |
+| [<img src="https://avatars0.githubusercontent.com/u/5610087?v=4" width="100px;"/><br /><sub>Matt Phillips</sub>](http://mattphillips.io)<br />[💻](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Code") [📖](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Documentation") [🚇](#infra-mattphillips "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/mattphillips/babel-jest-assertions/commits?author=mattphillips "Tests") | [<img src="https://avatars0.githubusercontent.com/u/266594?v=4" width="100px;"/><br /><sub>Ramesh Nair</sub>](https://hiddentao.com/)<br />[💻](https://github.com/mattphillips/babel-jest-assertions/commits?author=hiddentao "Code") [📖](https://github.com/mattphillips/babel-jest-assertions/commits?author=hiddentao "Documentation") [💡](#example-hiddentao "Examples") [⚠️](https://github.com/mattphillips/babel-jest-assertions/commits?author=hiddentao "Tests") |
+| :---: | :---: |
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 ## LICENSE

src/__snapshots__/async.test.js.snap

@@ -217,3 +217,56 @@ describe('.add', () => {
 });
 "
 `;
+
+exports[`Does not count commented out expect statements 1`] = `
+"
+describe('.add', () => {
+  it('resolves 1', async () => {
+    // expect(add(1, 2)).toEqual(3);
+    try {
+      /*
+        expect(add(4, 5).toEqual(9));
+      */
+      const value = await Promise.resolve(add(0, 1));
+
+      const a = 1; // expect(a).toEqual(1);
+      const b = 2; /* expect(b).toEqual(2); */
+
+      expect(value).toEqual(1);
+      // expect(value).toEqual(2);
+    } catch (err) {
+      /*
+        expect(add(6, 1).toEqual(7));
+        */
+    }
+  });
+});
+
+      ↓ ↓ ↓ ↓ ↓ ↓
+
+describe('.add', () => {
+  it('resolves 1', async () => {
+    expect.assertions(1);
+    expect.hasAssertions();
+
+    // expect(add(1, 2)).toEqual(3);
+    try {
+      /*
+        expect(add(4, 5).toEqual(9));
+      */
+      const value = await Promise.resolve(add(0, 1));
+
+      const a = 1; // expect(a).toEqual(1);
+      const b = 2; /* expect(b).toEqual(2); */
+
+      expect(value).toEqual(1);
+      // expect(value).toEqual(2);
+    } catch (err) {
+      /*
+        expect(add(6, 1).toEqual(7));
+        */
+    }
+  });
+});
+"
+`;

src/__snapshots__/sync.test.js.snap

@@ -116,3 +116,50 @@ describe('.add', () => {
 });
 "
 `;
+
+exports[`Does not count commented out expect statements 1`] = `
+"
+describe('.add', () => {
+  it('returns 1 when given 0 and 1', () => {
+    // expect(add(1, 2)).toEqual(3);
+    expect(add(0, 1)).toEqual(1);
+
+    /*
+      expect(add(4, 5).toEqual(9));
+    */
+
+    const a = 1; // expect(a).toEqual(1);
+    const b = 2; /* expect(b).toEqual(2); */
+    
+    expect(add(1, 0)).toEqual(1);
+    /*
+      expect(add(6, 1).toEqual(7));
+      */
+  });
+});
+
+      ↓ ↓ ↓ ↓ ↓ ↓
+
+describe('.add', () => {
+  it('returns 1 when given 0 and 1', () => {
+    expect.assertions(2);
+    expect.hasAssertions();
+
+    // expect(add(1, 2)).toEqual(3);
+    expect(add(0, 1)).toEqual(1);
+
+    /*
+      expect(add(4, 5).toEqual(9));
+    */
+
+    const a = 1; // expect(a).toEqual(1);
+    const b = 2; /* expect(b).toEqual(2); */
+
+    expect(add(1, 0)).toEqual(1);
+    /*
+      expect(add(6, 1).toEqual(7));
+      */
+  });
+});
+"
+`;

src/async.test.js

@@ -111,6 +111,32 @@ pluginTester({
         });
       });
       `
+    },
+    'Does not count commented out expect statements': {
+      snapshot: true,
+      code: `
+      describe('.add', () => {
+        it('resolves 1', async () => {
+          // expect(add(1, 2)).toEqual(3);
+          try {
+            /*
+              expect(add(4, 5).toEqual(9));
+            */
+            const value = await Promise.resolve(add(0, 1));
+
+            const a = 1; // expect(a).toEqual(1);
+            const b = 2; /* expect(b).toEqual(2); */
+
+            expect(value).toEqual(1);
+            // expect(value).toEqual(2);
+          } catch (err) {
+            /*
+              expect(add(6, 1).toEqual(7));
+              */
+          }
+        });
+      });
+      `
     }
   }
 });

src/index.js

@@ -40,9 +40,12 @@ module.exports = function({ template, transformFromAst, types }) {
 
         const { code } = transformFromAst(types.Program([path.node]));
 
-        const count = (code.match(/expect\(/g) || []).length;
-        const containsExpectAssertions = code.includes('expect.assertions(');
-        const containsHasAssertions = code.includes('expect.hasAssertions()');
+        // remove comments
+        const normalisedCode = code.replace(/\/\/(.*)/g, '').replace(/\/\*([\s\S]*?)\*\//g, '');
+
+        const count = (normalisedCode.match(/expect\(/g) || []).length;
+        const containsExpectAssertions = normalisedCode.includes('expect.assertions(');
+        const containsHasAssertions = normalisedCode.includes('expect.hasAssertions()');
 
         const args = path.node.expression.arguments[1].body.body;
         if (!containsHasAssertions) {

src/sync.test.js

@@ -65,6 +65,29 @@ pluginTester({
         });
       });
       `
+    },
+    'Does not count commented out expect statements': {
+      snapshot: true,
+      code: `
+      describe('.add', () => {
+        it('returns 1 when given 0 and 1', () => {
+          // expect(add(1, 2)).toEqual(3);
+          expect(add(0, 1)).toEqual(1);
+
+          /*
+            expect(add(4, 5).toEqual(9));
+          */
+
+          const a = 1; // expect(a).toEqual(1);
+          const b = 2; /* expect(b).toEqual(2); */
+          
+          expect(add(1, 0)).toEqual(1);
+          /*
+            expect(add(6, 1).toEqual(7));
+            */
+        });
+      });
+      `
     }
   }
 });