better tests

Author: mfbx9da4

.gitignore

@@ -37,5 +37,3 @@ Thumbs.db
 # Ignore built ts files
 dist/**/*
 
-# ignore yarn.lock
-yarn.lock

README.md

@@ -12,3 +12,31 @@
 ```
 yarn add deep-email-validator
 ```
+
+```typescript
+import validate from 'deep-email-validator'
+const main = async () => {
+  let res = await validate('[email protected]')
+  // {
+  //   "valid": false,
+  //   "validators": {
+  //       "regex": {
+  //         "valid": true
+  //       },
+  //       "typo": {
+  //         "valid": true
+  //       },
+  //       "disposable": {
+  //         "valid": true
+  //       },
+  //       "mx": {
+  //         "valid": true
+  //       },
+  //       "smtp": {
+  //         "valid": false,
+  //         "reason": "Invalid Mailbox",
+  //       }
+  //   }
+  // }
+}
+```

package-lock.json

@@ -1,6 +1,9 @@
 {
   "name": "deep-email-validator",
-  "version": "0.1.2",
+  "version": "0.1.5",
+  "files": [
+    "dist/**/*"
+  ],
   "description": "Validates emails based on regex, common typos, disposable email blacklists, DNS records and SMTP server response.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,14 +39,14 @@
     "run-debug": "nodemon --inspect dist/server.js"
   },
   "dependencies": {
-    "@types/mailcheck": "^1.1.31",
-    "@types/validator": "^12.0.1",
     "axios": "^0.19.2",
     "lodash": "^4.17.15",
     "mailcheck": "^1.1.1",
     "validator": "^12.2.0"
   },
   "devDependencies": {
+    "@types/mailcheck": "^1.1.31",
+    "@types/validator": "^12.0.1",
     "@types/eslint": "^6.1.1",
     "@types/jest": "^24.0.23",
     "@types/lodash": "^4.14.141",

package.json

@@ -33,3 +33,5 @@ async function main() {
   }
 }
 main()
+
+export default validate

src/index.ts

@@ -144,3 +144,32 @@ Object {
   },
 }
 `;
+
+exports[`validation tests passes 1`] = `
+Object {
+  "reason": "smtp",
+  "valid": false,
+  "validators": Object {
+    "disposable": Object {
+      "reason": undefined,
+      "valid": true,
+    },
+    "mx": Object {
+      "reason": undefined,
+      "valid": true,
+    },
+    "regex": Object {
+      "reason": undefined,
+      "valid": true,
+    },
+    "smtp": Object {
+      "reason": undefined,
+      "valid": true,
+    },
+    "typo": Object {
+      "reason": undefined,
+      "valid": true,
+    },
+  },
+}
+`;

test/__snapshots__/index.test.ts.snap

@@ -1,27 +1,33 @@
 import { validate } from '../src/index'
-import _ from 'lodash'
 
 describe('validation tests', () => {
   it('fails with bad regex', async () => {
     const res = await validate('dav [email protected]')
     expect(res).toMatchSnapshot()
   })
+
   it('fails with common typo', async () => {
     const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })
+
   it('fails with disposable email', async () => {
     const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })
 
   it('fails with bad dns', async () => {
-    const res = await validate('[email protected]')
+    const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })
 
   it('fails with bad mailbox', async () => {
     const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })
+
+  it('passes', async () => {
+    const res = await validate('[email protected]')
+    expect(res).toMatchSnapshot()
+  })
 })