Merge pull request eleith#228 from zackschuster/updates

upgrade eslint/prettier, add `log` override & implement single-file bundling
zypA13510 · Sep 3, 2018 · a16e200 · a16e200
2 parents 7fddabe + d752591
commit a16e200
Show file tree

Hide file tree

Showing 11 changed files with 17,091 additions and 216 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,6 +1,10 @@
 /node_modules/
 /test/
+/rollup/
+/rollup.config.js
+/email.esm.js
+
 /.gitignore
 /.npmignore
 /.travis.yml
-/npm-debug.log
+/*.log
diff --git a/.travis.yml b/.travis.yml
@@ -1,14 +1,8 @@
 language: node_js
 node_js:
- - "6"
- - "7"
- - "8"
- - "9"
-env:
- - CXX=g++-4.8
-addons:
- apt:
- sources:
- - ubuntu-toolchain-r-test
- packages:
- - g++-4.8
+ - "6"
+ - "8"
+ - "10"
+script:
+ - npm run test
+ - npm run rollup
diff --git a/Readme.md b/Readme.md
@@ -7,7 +7,7 @@ send emails, html and attachments (files, streams and strings) from node.js to a
  npm install emailjs
 
 ## FEATURES
- - works with SSL and TLS smtp servers 
+ - works with SSL and TLS smtp servers
  - supports smtp authentication ('PLAIN', 'LOGIN', 'CRAM-MD5', 'XOAUTH2')
  - emails are queued and the queue is sent asynchronously
  - supports sending html emails and emails with multiple attachments (MIME)
@@ -23,16 +23,16 @@ send emails, html and attachments (files, streams and strings) from node.js to a
 ```javascript
 var email = require("./path/to/emailjs/email");
 var server = email.server.connect({
- user: "username", 
- password:"password", 
- host: "smtp.your-email.com", 
+ user: "username",
+ password:"password",
+ host: "smtp.your-email.com",
  ssl: true
 });
 
 // send the message and get a callback with an error or details of the message that was sent
 server.send({
- text: "i hope this works", 
- from: "you <[email protected]>", 
+ text: "i hope this works",
+ from: "you <[email protected]>",
  to: "someone <[email protected]>, another <[email protected]>",
  cc: "else <[email protected]>",
  subject: "testing emailjs"
@@ -44,19 +44,19 @@ server.send({
 ```javascript
 var email = require("./path/to/emailjs/email");
 var server = email.server.connect({
- user: "username", 
- password:"password", 
- host: "smtp.your-email.com", 
+ user: "username",
+ password:"password",
+ host: "smtp.your-email.com",
  ssl: true
 });
 
 var message = {
- text: "i hope this works", 
- from: "you <[email protected]>", 
+ text: "i hope this works",
+ from: "you <[email protected]>",
  to: "someone <[email protected]>, another <[email protected]>",
  cc: "else <[email protected]>",
  subject: "testing emailjs",
- attachment: 
+ attachment:
  [
  {data:"<html>i <i>hope</i> this works!</html>", alternative:true},
  {path:"path/to/file.zip", type:"application/zip", name:"renamed.zip"}
@@ -66,10 +66,10 @@ var message = {
 // send the message and get a callback with an error or details of the message that was sent
 server.send(message, function(err, message) { console.log(err || message); });
 
-// you can continue to send more messages with successive calls to 'server.send', 
+// you can continue to send more messages with successive calls to 'server.send',
 // they will be queued on the same smtp connection
 
-// or you can create a new server connection with 'email.server.connect' 
+// or you can create a new server connection with 'email.server.connect'
 // to asynchronously send individual emails instead of a queue
 ```
 
@@ -78,19 +78,19 @@ server.send(message, function(err, message) { console.log(err || message); });
 ```javascript
 var email = require("./path/to/emailjs/email");
 var server = email.server.connect({
- user: "username", 
- password:"password", 
- host: "smtp-mail.outlook.com", 
+ user: "username",
+ password:"password",
+ host: "smtp-mail.outlook.com",
  tls: {ciphers: "SSLv3"}
 });
 
 var message = {
- text: "i hope this works", 
- from: "you <[email protected]>", 
+ text: "i hope this works",
+ from: "you <[email protected]>",
  to: "someone <[email protected]>, another <[email protected]>",
  cc: "else <[email protected]>",
  subject: "testing emailjs",
- attachment: 
+ attachment:
  [
  {data:"<html>i <i>hope</i> this works!</html>", alternative:true},
  {path:"path/to/file.zip", type:"application/zip", name:"renamed.zip"}
@@ -106,19 +106,19 @@ server.send(message, function(err, message) { console.log(err || message); });
 ```javascript
 var email = require("./path/to/emailjs/email");
 var server = email.server.connect({
- user: "username", 
- password:"password", 
- host: "smtp-mail.outlook.com", 
+ user: "username",
+ password:"password",
+ host: "smtp-mail.outlook.com",
  tls: {ciphers: "SSLv3"}
 });
 
 var message = {
- text: "i hope this works", 
- from: "you <[email protected]>", 
+ text: "i hope this works",
+ from: "you <[email protected]>",
  to: "someone <[email protected]>, another <[email protected]>",
  cc: "else <[email protected]>",
  subject: "testing emailjs",
- attachment: 
+ attachment:
  [
  {data: "<html>i <i>hope</i> this works! here is an image: <img src='cid:my-image' width='100' height ='50'> </html>"},
  {path:"path/to/file.zip", type:"application/zip", name:"renamed.zip"},
@@ -131,14 +131,14 @@ server.send(message, function(err, message) { console.log(err || message); });
 ```
 
 
-# API 
+# API
 
 ## email.server.connect(options)
 
  // options is an object with the following keys
  options =
  {
-  user // username for logging into smtp 
+  user // username for logging into smtp
   password // password for logging into smtp
   host // smtp host
   port // smtp port (if null a standard port number will be used)
@@ -147,10 +147,11 @@ server.send(message, function(err, message) { console.log(err || message); });
   timeout // max number of milliseconds to wait for smtp responses (defaults to 5000)
   domain // domain to greet smtp with (defaults to os.hostname)
  authentication // array of preferred authentication methods ('PLAIN', 'LOGIN', 'CRAM-MD5', 'XOAUTH2')
+  logger // override the built-in logger (useful for e.g. Azure Function Apps, where console.log doesn't work)
  }
- 
+
 ## email.server.send(message, callback)
- 
+
  // message can be a smtp.Message (as returned by email.message.create)
  // or an object identical to the first argument accepted by email.message.create
 
@@ -167,7 +168,7 @@ server.send(message, function(err, message) { console.log(err || message); });
 
  headers =
  {
-  text // text of the email 
+  text // text of the email
   from // sender of the format (address or name <address> or "name" <address>)
   to // recipients (same format as above), multiple recipients are separated by a comma
   cc // carbon copied recipients (same format as above)
@@ -184,7 +185,7 @@ associative array of currently supported SMTP authentication mechanisms
 
  // can be called multiple times, each adding a new attachment
  // options is an object with the following possible keys:
- 
+
  options =
  {
   // one of these fields is required
@@ -193,7 +194,7 @@ associative array of currently supported SMTP authentication mechanisms
   stream // binary stream that will provide attachment data (make sure it is in the paused state)
   // better performance for binary streams is achieved if buffer.length % (76*6) == 0
   // current max size of buffer must be no larger than Message.BUFFERSIZE
-  
+
   // optionally these fields are also accepted
   type // string of the file mime type
   name // name to give the file as perceived by the recipient
@@ -205,10 +206,11 @@ associative array of currently supported SMTP authentication mechanisms
   headers // object containing header=>value pairs for inclusion in this attachment's header
   related // an array of attachments that you want to be related to the parent attachment
  }
- 
+
 ## Authors
 
 eleith
+zackschuster
 
 ## Testing
 

diff --git a/email.esm.js b/email.esm.js
@@ -0,0 +1,7 @@
+import * as server from './smtp/client';
+import * as message from './smtp/message';
+import * as date from './smtp/date';
+import * as SMTP from './smtp/smtp';
+import * as error from './smtp/error';
+
+export { server, message, date, SMTP, error };
diff --git a/package.json b/package.json
@@ -20,23 +20,33 @@
  },
  "devDependencies": {
  "chai": "^4.1.2",
- "eslint": "^4.19.1",
+ "eslint": "^5.1.0",
  "eslint-config-prettier": "^2.9.0",
- "eslint-plugin-mocha": "^5.0.0",
- "eslint-plugin-prettier": "^2.6.0",
+ "eslint-plugin-mocha": "^5.1.0",
+ "eslint-plugin-prettier": "^2.6.2",
  "mailparser": "^2.2.0",
  "mocha": "^5.2.0",
- "prettier": "^1.13.5",
+ "prettier": "^1.13.7",
+ "rollup": "^0.62.0",
+ "rollup-plugin-commonjs": "^9.1.3",
+ "rollup-plugin-node-resolve": "^3.3.0",
  "smtp-server": "^3.4.6"
  },
  "engine": [
  "node >= 6"
  ],
  "main": "email.js",
  "scripts": {
- "test": "mocha -R spec"
+ "rollup": "rollup -c rollup.config.js && npm run rollup:test",
+ "rollup:test": "npm run test -- --file rollup/email.bundle.test.js",
+ "test": "mocha"
  },
  "license": "MIT",
+ "eslintIgnore": [
+ "rollup.config.js",
+ "rollup/email.bundle.js",
+ "email.esm.js"
+ ],
  "prettier": {
  "singleQuote": true,
  "trailingComma": "es5",

diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,17 @@
+import commonjs from 'rollup-plugin-commonjs';
+import resolve from 'rollup-plugin-node-resolve';
+
+export default {
+ input: 'email.esm.js',
+ output: {
+ file: 'rollup/email.bundle.js',
+ format: 'cjs',
+ interop: false,
+ freeze: false,
+ },
+ external: require('module').builtinModules,
+ plugins: [
+ resolve(),
+ commonjs(),
+ ]
+};