refactor: Restructure project

.eslintrc

@@ -15,6 +15,13 @@
     "expect": true
   },
   "plugins": ["eslint-plugin-import", "import", "jest"],
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "moduleDirectory": ["./", "node_modules"]
+      }
+    }
+  },
   "extends": ["eslint:recommended", "plugin:prettier/recommended"],
   "rules": {
     "comma-spacing": [1, { "before": false, "after": true }],

CONTRIBUTING.md

@@ -12,10 +12,6 @@ Thanks for being willing to contribute!
 3. `$ yarn test` to validate you've got it working
 4. Create a branch for your PR
 
-## Here as part of Hacktoberfest?
-
-Head over to [here](https://hacktoberfest.digitalocean.com/sign_up/register) to signup if you haven't already
-
 ## Making changes
 
 - All changes should have unit tests
@@ -24,12 +20,10 @@ Head over to [here](https://hacktoberfest.digitalocean.com/sign_up/register) to
 
 ### New Matchers
 
-- Each matcher should be placed in it's own directory inside of the `matchers` directory.
-- A matcher directory should contain the following:
-  - `index.js` - An export of the matcher in the format expected by Jest. See the docs for an [example](http://facebook.github.io/jest/docs/en/expect.html#expectextendmatchers). Note: the test outcome messages must be a function that returns a string (this caught me out 😉).
-  - `index.test.js` - Test suite that uses the new matcher and make sure it passes.
-  - `predicate.js` - The function that tests the actual value meets the expected value / behavior.
-  - `predicate.test.js` - Tests for the predicate both true/false cases must be covered.
+- Each matcher should be placed in it's own file inside of the `src/matchers/[matcher].js`.
+- A matcher should:
+  - Export the matcher in the format expected by Jest. See the docs for an [example](http://facebook.github.io/jest/docs/en/expect.html#expectextendmatchers). Note: the test outcome messages must be a function that returns a string (this caught me out 😉).
+- Tests for the matcher should go in `test/matchers/[matcher].test.js` - Test suite that uses the new matcher and make sure it passes.
 - Docs for the new matcher should be updated in the API section of the `README.md` to no longer say `Unimplemented`.
 - Type definitions for the new matchers should be added to `types/index.d.ts`.
 

package.json

@@ -78,6 +78,9 @@
     "snapshotSerializers": [
       "pretty-format/build/plugins/ConvertAnsi.js"
     ],
+    "moduleNameMapper": {
+      "src/(.*)": "<rootDir>/src/$1"
+    },
     "coverageThreshold": {
       "global": {
         "branches": 100,

src/matchers/fail.js

@@ -0,0 +1,6 @@
+export function fail(_, message) {
+  return {
+    pass: false,
+    message: () => (message ? message : 'fails by .fail() assertion'),
+  };
+}

src/matchers/pass.js

@@ -0,0 +1,6 @@
+export function pass(_, message) {
+  return {
+    pass: true,
+    message: () => (message ? message : 'passes by .pass() assertion'),
+  };
+}

src/matchers/toBeAfter.js

@@ -0,0 +1,18 @@
+export function toBeAfter(date, after) {
+  const { printReceived, matcherHint } = this.utils;
+  const passMessage =
+    matcherHint('.not.toBeAfter', 'received', '') +
+    '\n\n' +
+    `Expected date to be after ${printReceived(after)} but received:\n` +
+    `  ${printReceived(date)}`;
+
+  const failMessage =
+    matcherHint('.toBeAfter', 'received', '') +
+    '\n\n' +
+    `Expected date to be after ${printReceived(after)} but received:\n` +
+    `  ${printReceived(date)}`;
+
+  const pass = date > after;
+
+  return { pass, message: () => (pass ? passMessage : failMessage) };
+}

src/matchers/toBeAfterOrEqualTo.js

@@ -0,0 +1,19 @@
+export function toBeAfterOrEqualTo(actual, expected) {
+  const { printReceived, matcherHint } = this.utils;
+
+  const passMessage =
+    matcherHint('.not.toBeAfterOrEqualTo', 'received', '') +
+    '\n\n' +
+    `Expected date to be after or equal to ${printReceived(expected)} but received:\n` +
+    `  ${printReceived(actual)}`;
+
+  const failMessage =
+    matcherHint('.toBeAfterOrEqualTo', 'received', '') +
+    '\n\n' +
+    `Expected date to be after or equal to ${printReceived(expected)} but received:\n` +
+    `  ${printReceived(actual)}`;
+
+  const pass = actual >= expected;
+
+  return { pass, message: () => (pass ? passMessage : failMessage) };
+}

src/matchers/toBeArray.js

@@ -0,0 +1,19 @@
+export function toBeArray(expected) {
+  const { matcherHint, printReceived } = this.utils;
+
+  const passMessage =
+    matcherHint('.not.toBeArray', 'received', '') +
+    '\n\n' +
+    'Expected value to not be an array received:\n' +
+    `  ${printReceived(expected)}`;
+
+  const failMessage =
+    matcherHint('.toBeArray', 'received', '') +
+    '\n\n' +
+    'Expected value to be an array received:\n' +
+    `  ${printReceived(expected)}`;
+
+  const pass = Array.isArray(expected);
+
+  return { pass, message: () => (pass ? passMessage : failMessage) };
+}

src/matchers/toBeArrayOfSize.js

@@ -0,0 +1,25 @@
+import { determinePropertyMessage } from '../utils';
+
+export function toBeArrayOfSize(actual, expected) {
+  const { printExpected, printReceived, matcherHint } = this.utils;
+
+  const passMessage = `${matcherHint('.not.toBeArrayOfSize')}
+
+Expected value to not be an array of size:
+  ${printExpected(expected)}
+Received:
+  value: ${printReceived(actual)}
+  length: ${printReceived(determinePropertyMessage(actual, 'length'))}`;
+
+  const failMessage = `${matcherHint('.toBeArrayOfSize')}
+
+Expected value to be an array of size:
+  ${printExpected(expected)}
+Received:
+  value: ${printReceived(actual)}
+  length: ${printReceived(determinePropertyMessage(actual, 'length'))}`;
+
+  const pass = Array.isArray(actual) && actual.length === expected;
+
+  return { pass, message: () => (pass ? passMessage : failMessage) };
+}