feat: added ability to change template (closes #6)

Author: niftylettuce

.babelrc

@@ -1,10 +1,11 @@
 {
   "presets": [
-    ["env", {
+    ["@babel/env", {
       "targets": {
         "node": "6.4.0"
       }
     }]
   ],
+  "plugins": ["@babel/plugin-transform-runtime"],
   "sourceMaps": "inline"
 }

.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": ["eslint:recommended", "plugin:node/recommended"],
+  "rules": {
+    "no-unused-vars": "off"
+  }
+}

README.md

@@ -9,18 +9,24 @@
 
 > Automatically opens your browser to preview [Node.js][node] email messages sent with [Nodemailer][]. Made for [Lad][]!
 
-**[VIEW THE DEMO](demo.png)**
-
 
 ## Table of Contents
 
+* [Screenshot](#screenshot)
 * [Install](#install)
 * [Usage](#usage)
+* [Custom Preview Template and Stylesheets](#custom-preview-template-and-stylesheets)
+* [Debugging](#debugging)
 * [Options](#options)
 * [Contributors](#contributors)
 * [License](#license)
 
 
+## Screenshot
+
+![demo screenshot](demo.png)
+
+
 ## Install
 
 [npm][]:
@@ -40,7 +46,7 @@ yarn add preview-email
 
 > **NOTE**: You should probably just use [email-templates][] directly instead of using this package.
 
-The function `previewEmail` returns a `Promise` which resolves with a URL. We automatically open the browser to this URL unless you specify the third argument `open` as `false` (see [Options](#options) for more info).
+The function `previewEmail` returns a `Promise` which resolves with a URL. We automatically open the browser to this URL unless you specify `options.open` as `false` (see [Options](#options) for more info).
 
 ```js
 const previewEmail = require('preview-email');
@@ -70,17 +76,38 @@ transport.sendMail(message).then(console.log).catch(console.error);
 ```
 
 
-## Options
+## Custom Preview Template and Stylesheets
+
+Using the `options.template` object, you can define your own template for rendering (e.g. get inspiration from [template.pug](template.pug) and write your own!):
+
+```js
+const path = require('path');
 
-Note that you can also pass three additional arguments to `previewEmail` function.
+// ...
 
-These arguments are `id`, `open`, and `options` (e.g. `previewEmail(message, id, open, options)`).
+previewEmail(message, { template: path.join(__dirname, 'my-custom-preview-template.pug') })
+  .then(console.log)
+  .catch(console.error);
+```
+
+
+## Debugging
+
+Thanks to the [debug][] package, you can easily debug output from `preview-email`:
 
-By default we automatically set an `id` using `uuid.v4()` (see [uuid][] for more info).
+```sh
+DEBUG=preview-email node app.js
+```
 
-Also, `open` is set to `true` by default - this means that we automatically open the browser for you.
 
-The `options` argument is an Object which defaults to `{ wait: false }`.  This object is passed along to [opn][]'s [options][opn-options].
+## Options
+
+* `message` (Object) - a [Nodemailer message configuration object](https://nodemailer.com/message/)
+* `options` (Object) - an object with the following two properties:
+  * `id` (String) - a unique ID for the file name created for the preview in `dir` (defaults to `uuid.v4()` from [uuid][])
+  * `dir` (String) - a path to a directory for saving the generated email previews (defaults to `os.tmpdir()`, see [os docs](https://nodejs.org/api/os.html#os_os_tmpdir) for more insight)
+  * `open` (Object or Boolean) - an options object that is passed to [open][] (defaults to `{ wait: false }`) - if set to `false` then it will not open the email automaitcally in the browser using [open][], and if set to `true` then it will default to `{ wait: false }`
+  * `template` (String) - a file path to a `pug` template file (defaults to preview-email's [template.pug](template.pug) by default) - **this is where you can pass a custom template for rendering email previews, e.g. your own stylesheet**
 
 
 ## Contributors
@@ -111,6 +138,6 @@ The `options` argument is an Object which defaults to `{ wait: false }`.  This o
 
 [lad]: https://lad.js.org
 
-[opn]: https://github.com/sindresorhus/opn
+[open]: https://github.com/sindresorhus/open
 
-[opn-options]: https://github.com/sindresorhus/opn#options
+[debug]: https://github.com/visionmedia/debug

package.json

@@ -3,94 +3,123 @@
   "description": "Automatically opens your browser to preview Node.js email messages sent with Nodemailer. Made for Lad!",
   "version": "0.0.10",
   "author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)",
+  "ava": {
+    "failFast": true,
+    "verbose": true
+  },
   "bugs": {
     "url": "https://github.com/niftylettuce/preview-email/issues",
     "email": "niftylettuce@gmail.com"
   },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
   "contributors": [
     "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)"
   ],
   "dependencies": {
-    "bluebird": "^3.5.3",
-    "moment": "^2.23.0",
-    "nodemailer": "^5.1.1",
-    "opn": "^5.4.0",
-    "pug": "^2.0.3",
+    "@babel/runtime": "^7.4.5",
+    "debug": "^4.1.1",
+    "moment": "^2.24.0",
+    "nodemailer": "^6.2.1",
+    "open": "^6.3.0",
+    "pify": "^4.0.1",
+    "pug": "^2.0.4",
     "uuid": "^3.3.2"
   },
-  "ava": {
-    "failFast": true,
-    "verbose": true
-  },
   "devDependencies": {
-    "auto-bind": "^2.0.0",
-    "ava": "^1.0.1",
-    "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.7.0",
-    "codecov": "^3.1.0",
+    "@babel/cli": "^7.4.4",
+    "@babel/core": "^7.4.5",
+    "@babel/plugin-transform-runtime": "^7.4.4",
+    "@babel/preset-env": "^7.4.5",
+    "@commitlint/cli": "^8.0.0",
+    "@commitlint/config-conventional": "^8.0.0",
+    "auto-bind": "^2.1.0",
+    "ava": "^2.1.0",
+    "codecov": "^3.5.0",
     "cross-env": "^5.2.0",
-    "eslint": "^5.12.0",
-    "eslint-config-prettier": "^3.3.0",
-    "eslint-plugin-prettier": "^3.0.1",
-    "husky": "^1.3.1",
-    "lint-staged": "^8.1.0",
-    "nyc": "^13.1.0",
-    "prettier": "^1.15.3",
+    "eslint": "^6.0.0",
+    "eslint-config-xo-lass": "^1.0.3",
+    "eslint-plugin-node": "^9.1.0",
+    "husky": "^2.4.1",
+    "lint-staged": "^8.2.1",
+    "nyc": "^14.1.1",
     "remark-cli": "^6.0.1",
-    "remark-preset-github": "^0.0.13",
-    "xo": "^0.23.0"
+    "remark-preset-github": "^0.0.14",
+    "rimraf": "^2.6.3",
+    "xo": "^0.24.0"
   },
   "engines": {
     "node": ">=6.4.0"
   },
+  "files": [
+    "lib",
+    "template.pug"
+  ],
   "homepage": "https://github.com/niftylettuce/preview-email",
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm test",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
   "keywords": [
-    "litmus",
-    "demo",
-    "preview",
-    "email",
-    "test",
+    "auto",
+    "automatic",
+    "automatically",
     "browser",
-    "open",
-    "template",
-    "render",
-    "letter",
-    "opener",
-    "opn",
     "chrome",
+    "demo",
+    "email",
     "emails",
-    "templates",
     "engine",
-    "pug",
-    "show",
-    "lad",
-    "koa",
     "express",
-    "nodemailer",
+    "koa",
+    "lad",
+    "lass",
+    "letter",
+    "litmus",
     "mail",
     "mailer",
+    "nodemailer",
+    "open",
+    "open",
+    "opener",
+    "opn",
+    "preview",
+    "pug",
+    "render",
+    "show",
     "smtp",
-    "automatic",
-    "automatically",
-    "auto",
-    "lass"
+    "template",
+    "templates",
+    "test"
   ],
   "license": "MIT",
   "lint-staged": {
-    "*.{js,jsx,mjs,ts,tsx,css,less,scss,json,graphql}": [
-      "prettier --write --single-quote --trailing-comma none",
-      "git add"
-    ],
-    "*.md": [
-      "remark . -qfo",
-      "git add"
-    ]
+    "linters": {
+      "*.js": [
+        "xo --fix",
+        "git add"
+      ],
+      "*.md": [
+        "remark . -qfo",
+        "git add"
+      ],
+      "package.json": [
+        "fixpack",
+        "git add"
+      ]
+    }
   },
   "main": "lib/index.js",
-  "files": [
-    "lib",
-    "template.pug"
-  ],
+  "prettier": {
+    "singleQuote": true,
+    "bracketSpacing": true,
+    "trailingComma": "none"
+  },
   "remarkConfig": {
     "plugins": [
       "preset-github"
@@ -101,43 +130,21 @@
     "url": "https://github.com/niftylettuce/preview-email"
   },
   "scripts": {
+    "ava": "cross-env NODE_ENV=test DEBUG=preview-email ava",
+    "build": "npm run build:clean && npm run build:lib",
+    "build:clean": "rimraf lib dist",
+    "build:lib": "babel src --out-dir lib",
     "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "lint": "xo && remark . -qfo",
-    "precommit": "lint-staged && npm test",
-    "test": "npm run build && npm run lint && npm run test-coverage",
-    "test-coverage": "cross-env NODE_ENV=test nyc ava",
-    "build": "node_modules/.bin/babel src --out-dir lib",
-    "watch": "node_modules/.bin/babel src --watch --out-dir lib"
+    "lint": "xo && remark . -qfo && eslint lib",
+    "nyc": "cross-env NODE_ENV=test nyc ava",
+    "test": "npm run build && npm run lint && npm run ava",
+    "test-coverage": "npm run build && npm run lint && npm run nyc"
   },
   "xo": {
-    "extends": "prettier",
-    "plugins": [
-      "prettier"
-    ],
-    "parserOptions": {
-      "sourceType": "script"
-    },
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "singleQuote": true,
-          "bracketSpacing": true,
-          "trailingComma": "none"
-        }
-      ],
-      "max-len": [
-        "error",
-        {
-          "code": 80,
-          "ignoreUrls": true
-        }
-      ],
-      "capitalized-comments": "off",
-      "camelcase": "off",
-      "no-warning-comments": "off",
-      "no-use-extend-native/no-use-extend-native": "off"
-    },
-    "space": true
+    "prettier": true,
+    "space": true,
+    "extends": [
+      "xo-lass"
+    ]
   }
 }