resolve merge conflicts with master

evanshortiss · evanshortiss · May 11, 2022 · Jul 8, 2022 · Jul 14, 2022 · Aug 31, 2022
commit 55e81a634ba0595107f16232050229157e0ce0dc
diff --git a/API.md b/API.md
@@ -15,6 +15,7 @@ A complete listing of the `env-var` API.
       * [asArray()](#asarraydelimiter-string)
       * [asBool()](#asbool)
       * [asBoolStrict()](#asboolstrict)
+      * [asEmailString()](#asemailstring)
       * [asEnum()](#asenumvalidvalues-string)
       * [asFloat()](#asfloat)
       * [asFloatNegative()](#asfloatnegative)
@@ -195,6 +196,11 @@ Attempt to parse the variable to a Boolean. Throws an exception if parsing
 fails. The var must be set to either "true" or "false" (upper or lowercase) to
 succeed.
 
+#### asEmailString()
+
+Read the variable and validate that it's an email address. Throws an exception
+if the value is not an email address.
+
 #### asEnum(validValues: string[])
 
 Converts the value to a string, and matches against the list of valid values.

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 7.2.0 (01/09/2022)
+* Add `asEmailString()` accessor (#146)
+
 ## 7.1.1 (28/10/2021)
 * Fix duplicate identifier error for TypeScript builds (#151)
 

diff --git a/README.md b/README.md
@@ -53,8 +53,8 @@ You can use `env-var` in both JavaScript and TypeScript!
 ```js
 const env = require('env-var');
 
-// Import syntax is also supported
-// import * as env from 'env-var'
+// Or using module import syntax:
+// import env from 'env-var'
 
 const PASSWORD = env.get('DB_PASSWORD')
   // Throw an error if the DB_PASSWORD variable is not set (optional)

diff --git a/lib/accessors.ts b/lib/accessors.ts
@@ -17,7 +17,8 @@ export interface Acccessors<T> {
   asBool: (s: string) => boolean|T
   asBoolStrict: (s: string) => boolean|T
   asEnum: <V extends string>(s: V, validValues: Readonly<V[]>|V[]) => V|T
-  asArray: (s: string, delimiter?: string) => string[]|T
+  asArray: (s: string, delimiter?: string) => string[]|T,
+  asEmailString: (s: string) => string|T
 }
 
 export const accessors: Acccessors<never> = {
@@ -38,6 +39,16 @@ export const accessors: Acccessors<never> = {
     return s
   },
 
+  asEmailString (s) {
+    const EMAIL_REGEX = /^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\u0001-\u0008\u000b\u000c\u000e-\u001f\u0021\u0023-\u005b\u005d-\u007f]|\\[\u0001-\u0009\u000b\u000c\u000e-\u007f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\u0001-\u0008\u000b\u000c\u000e-\u001f\u0021-\u005a\u0053-\u007f]|\\[\u0001-\u0009\u000b\u000c\u000e-\u007f])+)\])$/
+
+    if (!EMAIL_REGEX.test(s)) {
+      throw new Error('should be a valid email address')
+    }
+
+    return s
+  },
+
   asBool (s) {
     const val = s.toLowerCase()
 

diff --git a/lib/variable.ts b/lib/variable.ts
@@ -247,4 +247,8 @@ export class Variable<T = undefined> {
   public asUrlString() {
     return this.getValue(accessors.asUrlString)
   }
+
+  public asEmailString() {
+    return this.getValue(accessors.asEmailString)
+  }
 }
diff --git a/test/index.js b/test/index.js
@@ -24,6 +24,7 @@ describe('env-var', function () {
     ARRAY_WITH_DELIMITER_PREFIX: ',value',
     DASH_ARRAY: '1-2-3',
     URL: 'http://google.com/',
+    EMAIL: 'email@example.com',
     ENUM: 'VALID',
     EMPTY_STRING: '',
     EMPTY_STRING_WITH_WHITESPACE: '  '
@@ -597,6 +598,21 @@ describe('env-var', function () {
     })
   })
 
+  describe('#asEmailString', function () {
+    it('should return an email address', function () {
+      expect(mod.get('EMAIL').asEmailString()).to.be.a('string')
+      expect(mod.get('EMAIL').asEmailString()).to.equal(TEST_VARS.EMAIL)
+    })
+
+    it('should throw due to a bad email address', function () {
+      process.env.EMAIL = '.invalid@example.com'
+
+      expect(() => {
+        mod.get('EMAIL').asEmailString()
+      }).to.throw('env-var: "EMAIL" should be a valid email address')
+    })
+  })
+
   describe('#example', () => {
     let fromMod