isemail - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

package.json

 {
   "name": "isemail",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "author": "Eli Skeggs <[e-mail]>",
@@ -8,3 +8,4 @@ "description": "validate an email address according to RFCs 5321, 5322, and others",
   "scripts": {
-    "test": "mocha"
+    "test": "lab -r console -o stdout -r lcov -o coverage.lcov -a code -L",
+    "test-cov-html": "lab -r html -o coverage.html -a code"
   },
@@ -28,14 +29,9 @@ "repository": {
   "devDependencies": {
-    "mocha": "~2.3.2",
-    "chai": "~3.2.0"
+    "code": "^1.5.0",
+    "lab": "^5.16.1"
   },
-  "licenses": [
-    {
-      "type": "BSD",
-      "url": "http://www.opensource.org/licenses/bsd-license.php"
-    }
-  ],
+  "license": "BSD-2-Clause",
   "engines": {
-    "node": ">=0.8.0"
+    "node": ">=0.10"
   }
 }

README.md

 isemail
 =======
 
+Node email address validation library
+
 [![Build Status](https://travis-ci.org/hapijs/isemail.png)](https://travis-ci.org/hapijs/isemail)
 [![Coverage Status](https://coveralls.io/repos/hapijs/isemail/badge.png?branch=master)](https://coveralls.io/r/hapijs/isemail?branch=master)
 
+Lead Maintainer: [Eli Skeggs](https://github.com/skeggse)
+
 This first version of `isemail` is a port of the PHP `is_email` function by Dominic Sayers.
 
-Future versions will improve upon the current version, optimizing it for efficient usage and DRYing the code.
-
 Install
@@ -21,3 +23,3 @@ -------
 
-The tests were pulled from is_email's extensive [test suite][tests] on October 15, 2013. Many thanks to the contributors!
+The tests were pulled from is_email's extensive [test suite][tests] on October 15, 2013. Many thanks to the contributors! Additional tests have been added to increase code coverage and verify edge-cases.
 
@@ -27,3 +29,3 @@ Run any of the following.
 ```sh
-$ mocha
+$ lab
 $ npm test
@@ -88,2 +90,3 @@ $ make test
 Add tests for library usage, not just functionality comparisons.
+Future versions will improve upon the current version, optimizing it for efficient usage and DRYing the code.
 
@@ -90,0 +93,0 @@ License

test/isemail.js

@@ -1,185 +0,33 @@
-var expect = require('chai').expect;
-var isEmail = require('..');
+var Lab = require('lab');
+var Code = require('code');
+var IsEmail = require('..');
+var Tests = require('./tests.json');
 
-// diagnoses
+var internals = {
+    defaultThreshold: 16
+};
+
+// Test shortcuts
+var isEmail = IsEmail;
+var lab = exports.lab = Lab.script();
+var before = lab.before;
+var after = lab.after;
+var describe = lab.describe;
+var it = lab.it;
+var expect = Code.expect;
+
+// Diagnoses
 var diag = isEmail.diagnoses;
 
-// expectations
-var expectations = [
-    ['', diag.errNoDomain],
-    ['test', diag.errNoDomain],
-    ['@', diag.errNoLocalPart],
-    ['test@', diag.errNoDomain],
-    ['test@io', diag.valid],
-    ['@io', diag.errNoLocalPart],
-    ['@iana.org', diag.errNoLocalPart],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.dnsWarnNoRecord],
-    ['test@iana.a', diag.dnsWarnNoRecord],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.errDotStart],
-    ['[e-mail]', diag.errDotEnd],
-    ['test..iana.org', diag.errConsecutiveDots],
-    ['test_exa-mple.com', diag.errNoDomain],
-    ['!#$%&`*+/=?^`{|}~@iana.org', diag.valid],
-    ['test\\@[e-mail]', diag.errExpectingATEXT],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.valid],
-    ['test@iana.123', diag.rfc5321TLDNumeric],
-    ['test@255.255.255.255', diag.rfc5321TLDNumeric],
-    ['[e-mail]', diag.valid],
-    ['a[e-mail]', diag.rfc5322LocalTooLong],
-    ['test@abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghiklm', diag.rfc5322LabelTooLong],
-    ['[e-mail]', diag.dnsWarnNoRecord],
-    ['test@abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghiklm.com', diag.rfc5322LabelTooLong],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]', diag.errDomainHyphenStart],
-    ['[e-mail]', diag.errDomainHyphenEnd],
-    //['[e-mail]', diag.dnsWarnNoMXRecord],
-    ['[e-mail]-uk', diag.dnsWarnNoRecord],
-    ['test@.iana.org', diag.errDotStart],
-    ['[e-mail].', diag.errDotEnd],
-    ['test@iana..com', diag.errConsecutiveDots],
-    ['a@a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v.w.x.y.z.a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v.w.x.y.z.a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v.w.x.y.z.a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v.w.x.y.z.a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v', diag.dnsWarnNoRecord],
-    ['[e-mail]yzabcdefghijklmnopqrstuvwxyzabcdefghi', diag.dnsWarnNoRecord],
-    ['[e-mail]yzabcdefghijklmnopqrstuvwxyzabcdefghij', diag.rfc5322TooLong],
-    ['[e-mail]', diag.rfc5322TooLong],
-    ['[e-mail]', diag.rfc5322DomainTooLong],
-    ['"test"@iana.org', diag.rfc5321QuotedString],
-    ['""@iana.org', diag.rfc5321QuotedString],
-    ['"""@iana.org', diag.errExpectingATEXT],
-    ['"\\a"@iana.org', diag.rfc5321QuotedString],
-    ['"\\""@iana.org', diag.rfc5321QuotedString],
-    ['"\\"@iana.org', diag.errUnclosedQuotedString],
-    ['"\\\\"@iana.org', diag.rfc5321QuotedString],
-    ['test"@iana.org', diag.errExpectingATEXT],
-    ['"[e-mail]', diag.errUnclosedQuotedString],
-    ['"test"[e-mail]', diag.errATEXTAfterQS],
-    ['test"text"@iana.org', diag.errExpectingATEXT],
-    ['"test""test"@iana.org', diag.errExpectingATEXT],
-    ['"test"."test"@iana.org', diag.deprecatedLocalPart],
-    ['"test\\ test"@iana.org', diag.rfc5321QuotedString],
-    ['"test"[e-mail]', diag.deprecatedLocalPart],
-    ['"test\0"@iana.org', diag.errExpectingQTEXT],
-    ['"test\\\0"@iana.org', diag.deprecatedQP],
-    ['"test\r\n test"@iana.org', diag.cfwsFWS],
-    ['"abcdefghijklmnopqrstuvwxyz abcdefghijklmnopqrstuvwxyz abcdefghj"@iana.org', diag.rfc5322LocalTooLong],
-    ['"abcdefghijklmnopqrstuvwxyz abcdefghijklmnopqrstuvwxyz abcdefg\\h"@iana.org', diag.rfc5322LocalTooLong],
-    ['test@[255.255.255.255]', diag.rfc5321AddressLiteral],
-    ['test@a[255.255.255.255]', diag.errExpectingATEXT],
-    ['test@[255.255.255]', diag.rfc5322DomainLiteral],
-    ['test@[255.255.255.255.255]', diag.rfc5322DomainLiteral],
-    ['test@[255.255.255.256]', diag.rfc5322DomainLiteral],
-    ['test@[1111:2222:3333:4444:5555:6666:7777:8888]', diag.rfc5322DomainLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:7777]', diag.rfc5322IPv6GroupCount],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:7777:8888]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:7777:8888:9999]', diag.rfc5322IPv6GroupCount],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:7777:888G]', diag.rfc5322IPv6BadCharacter],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666::8888]', diag.deprecatedIPv6],
-    ['test@[IPv6:1111:2222:3333:4444:5555::8888]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666::7777:8888]', diag.rfc5322IPv6MaxGroups],
-    ['test@[IPv6::3333:4444:5555:6666:7777:8888]', diag.rfc5322IPv6ColonStart],
-    ['test@[IPv6:::3333:4444:5555:6666:7777:8888]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111::4444:5555::8888]', diag.rfc5322IPv62x2xColon],
-    ['test@[IPv6:::]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:255.255.255.255]', diag.rfc5322IPv6GroupCount],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:255.255.255.255]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666:7777:255.255.255.255]', diag.rfc5322IPv6GroupCount],
-    ['test@[IPv6:1111:2222:3333:4444::255.255.255.255]', diag.rfc5321AddressLiteral],
-    ['test@[IPv6:1111:2222:3333:4444:5555:6666::255.255.255.255]', diag.rfc5322IPv6MaxGroups],
-    ['test@[IPv6:1111:2222:3333:4444:::255.255.255.255]', diag.rfc5322IPv62x2xColon],
-    ['test@[IPv6::255.255.255.255]', diag.rfc5322IPv6ColonStart],
-    [' test @iana.org', diag.deprecatedCFWSNearAt],
-    ['test@ iana .com', diag.deprecatedCFWSNearAt],
-    ['test . [e-mail]', diag.deprecatedFWS],
-    ['\r\n [e-mail]', diag.cfwsFWS],
-    ['\r\n \r\n [e-mail]', diag.deprecatedFWS],
-    ['(comment)[e-mail]', diag.cfwsComment],
-    ['((comment)[e-mail]', diag.errUnclosedComment],
-    ['(comment(comment))[e-mail]', diag.cfwsComment],
-    ['test@(comment)iana.org', diag.deprecatedCFWSNearAt],
-    ['test(comment)[e-mail]', diag.errATEXTAfterCFWS],
-    ['test@(comment)[255.255.255.255]', diag.deprecatedCFWSNearAt],
-    ['(comment)[e-mail]', diag.cfwsComment],
-    ['test@(comment)abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghikl.com', diag.deprecatedCFWSNearAt],
-    ['(comment)[e-mail]', diag.cfwsComment],
-    ['[e-mail]\n', diag.errExpectingATEXT],
-    ['[e-mail]--jxalpdlp', diag.dnsWarnNoRecord],
-    ['[e-mail]', diag.valid],
-    ['[e-mail]-', diag.errDomainHyphenEnd],
-    ['"[e-mail]', diag.errUnclosedQuotedString],
-    ['([e-mail]', diag.errUnclosedComment],
-    ['test@(iana.org', diag.errUnclosedComment],
-    ['test@[1.2.3.4', diag.errUnclosedDomainLiteral],
-    ['"test\\"@iana.org', diag.errUnclosedQuotedString],
-    ['(comment\\)[e-mail]', diag.errUnclosedComment],
-    ['[e-mail](comment\\)', diag.errUnclosedComment],
-    ['[e-mail](comment\\', diag.errBackslashEnd],
-    ['test@[RFC-5322-domain-literal]', diag.rfc5322DomainLiteral],
-    ['test@[RFC-5322]-domain-literal]', diag.errATEXTAfterDomainLiteral],
-    ['test@[RFC-5322-[domain-literal]', diag.errExpectingDTEXT],
-    ['test@[RFC-5322-\\\x07-domain-literal]', diag.rfc5322DomainLiteralOBSDText],
-    ['test@[RFC-5322-\\\t-domain-literal]', diag.rfc5322DomainLiteralOBSDText],
-    ['test@[RFC-5322-\\]-domain-literal]', diag.rfc5322DomainLiteralOBSDText],
-    ['test@[RFC-5322-\x7f-domain-literal]', diag.rfc5322DomainLiteralOBSDText],
-    ['test@[RFC-5322-domain-literal\\]', diag.errUnclosedDomainLiteral],
-    ['test@[RFC-5322-domain-literal\\', diag.errBackslashEnd],
-    ['test@[RFC 5322 domain literal]', diag.rfc5322DomainLiteral],
-    ['test@[RFC-5322-domain-literal] (comment)', diag.rfc5322DomainLiteral],
-    ['\[e-mail]', diag.errExpectingATEXT],
-    ['test@\x7f.org', diag.errExpectingATEXT],
-    ['"\x7f"@iana.org', diag.deprecatedQTEXT],
-    ['"\\\x7f"@iana.org', diag.deprecatedQP],
-    ['(\x7f)[e-mail]', diag.deprecatedCTEXT],
-    ['[e-mail]\r', diag.errCRNoLF],
-    ['\[e-mail]', diag.errCRNoLF],
-    ['"\rtest"@iana.org', diag.errCRNoLF],
-    ['(\r)[e-mail]', diag.errCRNoLF],
-    ['[e-mail](\r)', diag.errCRNoLF],
-    ['\[e-mail]', diag.errExpectingATEXT],
-    ['"\n"@iana.org', diag.errExpectingQTEXT],
-    ['"\\\n"@iana.org', diag.deprecatedQP],
-    ['(\n)[e-mail]', diag.errExpectingCTEXT],
-    ['\[e-mail]', diag.errExpectingATEXT],
-    ['test@\x07.org', diag.errExpectingATEXT],
-    ['"\x07"@iana.org', diag.deprecatedQTEXT],
-    ['"\\\x07"@iana.org', diag.deprecatedQP],
-    ['(\x07)[e-mail]', diag.deprecatedCTEXT],
-    ['\r\[e-mail]', diag.errFWSCRLFEnd],
-    ['\r\n \r\[e-mail]', diag.errFWSCRLFEnd],
-    [' \r\[e-mail]', diag.errFWSCRLFEnd],
-    [' \r\n [e-mail]', diag.cfwsFWS],
-    [' \r\n \r\[e-mail]', diag.errFWSCRLFEnd],
-    [' \r\n\r\[e-mail]', diag.errFWSCRLFx2],
-    [' \r\n\r\n [e-mail]', diag.errFWSCRLFx2],
-    ['[e-mail]\r\n ', diag.cfwsFWS],
-    ['[e-mail]\r\n \r\n ', diag.deprecatedFWS],
-    ['[e-mail]\r\n', diag.errFWSCRLFEnd],
-    ['[e-mail] \r', diag.errCRNoLF],
-    ['[e-mail]\r\n \r\n', diag.errFWSCRLFEnd],
-    ['[e-mail] \r\n', diag.errFWSCRLFEnd],
-    ['[e-mail] \r\n ', diag.cfwsFWS],
-    ['[e-mail] \r\n \r\n', diag.errFWSCRLFEnd],
-    ['[e-mail] \r\n\r\n', diag.errFWSCRLFx2],
-    ['[e-mail] \r\n\r\n ', diag.errFWSCRLFx2],
-    ['test@iana. org', diag.deprecatedFWS],
-    ['test@[\r', diag.errCRNoLF],
-    ['test@[\r\n', diag.errFWSCRLFEnd],
-    [' [e-mail]', diag.cfwsFWS],
-    ['[e-mail] ', diag.cfwsFWS],
-    ['test@[IPv6:1::2:]', diag.rfc5322IPv6ColonEnd],
-    ['"test\\©"@iana.org', diag.errExpectingQPair],
-    ['test@iana/icann.org', diag.rfc5322Domain],
-    ['test.(comment)[e-mail]', diag.deprecatedComment],
-    ['test@iana.(comment)org', diag.deprecatedComment],
-    ['test@iana(comment)iana.org', diag.errATEXTAfterCFWS],
-    ['(comment\r\n comment)[e-mail]', diag.cfwsFWS],
-    ['test@org', diag.rfc5321TLD],
-    ['[e-mail]', diag.dnsWarnNoMXRecord],
-    ['[e-mail]', diag.dnsWarnNoRecord]
-];
+// Expectations
+var expectations = Tests.map(function mapper (value) {
 
+    value[1] = diag[value[1]];
+    return value;
+});
+
+// Null characters aren't supported in JSON
+expectations.push(['test@[\0', diag.errExpectingDTEXT]);
+expectations.push(['(\0)[e-mail]', diag.errExpectingCTEXT]);
+
 var tldExpectations = [
@@ -192,2 +40,79 @@ ['shouldbe@invalid', diag.errUnknownTLD],
 
+    it('should check options.tldWhitelist', function (done) {
+
+        expect(isEmail('person@top', {
+            tldWhitelist: 'top',
+            checkDNS: false
+        })).to.equal(true);
+
+        expect(isEmail('person@top', {
+            tldWhitelist: ['com'],
+            checkDNS: false
+        })).to.equal(false);
+
+        expect(function () {
+
+            isEmail('', {
+                tldWhitelist: 77
+            });
+        }).to.throw(/tldWhitelist/);
+        done();
+    });
+
+    it('should check options.minDomainAtoms', function (done) {
+
+        expect(function () {
+
+            isEmail('person@top', {
+                minDomainAtoms: -1
+            });
+        }).to.throw(/minDomainAtoms/);
+
+        expect(function () {
+
+            isEmail('person@top', {
+                minDomainAtoms: 1.5
+            });
+        }).to.throw(/minDomainAtoms/);
+        done();
+    });
+
+    it('should use options.errorLevel', function (done) {
+
+        expect(isEmail('person@123', {
+            errorLevel: diag.rfc5321TLDNumeric + 1
+        })).to.equal(0);
+
+        expect(isEmail('person@123', {
+            errorLevel: diag.rfc5321TLDNumeric
+        })).to.equal(diag.rfc5321TLDNumeric);
+        done();
+    });
+
+    it('should ensure callback provided with checkDNS', function (done) {
+
+        expect(function () {
+
+            isEmail('person@top', {
+                checkDNS: true
+            });
+        }).to.throw(/(?=.*\bcheckDNS\b)(?=.*\bcallback\b)/);
+        done();
+    });
+
+    it('should handle omitted options', function (done) {
+
+        expect(isEmail(expectations[0][0])).to.equal(expectations[0][1] < internals.defaultThreshold);
+        done();
+    });
+
+    it('should handle omitted options with callback', function (done) {
+
+        isEmail(expectations[0][0], function (res) {
+
+            expect(res).to.equal(expectations[0][1] < internals.defaultThreshold);
+            done();
+        });
+    });
+
     expectations.forEach(function (obj, i) {
@@ -214,3 +139,3 @@
 
-        it('should handle tld test ' + (i + 1), function () {
+        it('should handle tld test ' + (i + 1), function (done) {
 
@@ -228,6 +153,8 @@ expect(isEmail(email, {
             })).to.equal(result);
+
+            done();
         });
     });
 
-    it('should handle domain atom test 1', function () {
+    it('should handle domain atom test 1', function (done) {
 
@@ -238,5 +165,7 @@ expect(isEmail('shouldbe@invalid', {
         })).to.equal(diag.errDomainTooShort);
+
+        done();
     });
 
-    it('should handle domain atom test 2', function () {
+    it('should handle domain atom test 2', function (done) {
 
@@ -247,3 +176,5 @@ expect(isEmail('[e-mail]', {
         })).to.equal(diag.valid);
+
+        done();
     });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

86405

increased by11.59%

Number of package files

11

increased by10%

Lines of code

1540

increased by7.09%

Number of lines in readme file

96

increased by3.23%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

No dependency changes