upgrade dependencies, es6ify and fix PID file read (#6)

.travis.yml

@@ -1,8 +1,10 @@
 language: node_js
 node_js:
-- 6
-- 7
-- 8
+- 10
+- 11
+- 12
+- 13
+- 14
 
 addons:
   apt:

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Damon Oehlman <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,24 +1,22 @@
-
 # ngineer
 
 ngineer is a node automation later for nginx that assists with the following:
 
-- scaffolding a new nginx configuration folder (i.e. `conf/`, `html/`, `logs/`)
-- starting and reloading nginx using targeted base path
-- adding location proxy directives
-
+* scaffolding a new nginx configuration folder (i.e. `conf/`, `html/`, `logs/`)
+* starting and reloading nginx using targeted base path
+* adding location proxy directives
 
 [![NPM](https://nodei.co/npm/ngineer.png)](https://nodei.co/npm/ngineer/)
 
-[![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)](https://github.com/dominictarr/stability#unstable) [![Build Status](https://api.travis-ci.org/DamonOehlman/ngineer.svg?branch=master)](https://travis-ci.org/DamonOehlman/ngineer) [![bitHound Score](https://www.bithound.io/github/DamonOehlman/ngineer/badges/score.svg)](https://www.bithound.io/github/DamonOehlman/ngineer) 
+[![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)](https://github.com/dominictarr/stability#unstable) [![Build Status](https://api.travis-ci.org/DamonOehlman/ngineer.svg?branch=master)](https://travis-ci.org/DamonOehlman/ngineer)
 
 ## Getting Started
 
 The following example shows how the `ngineer` module can be used to scaffold and start nginx within an application.
 
 ```js
-var async = require('async');
-var nginx = require('ngineer')(__dirname + '/nginx', {
+const async = require('async');
+const nginx = require('..')(__dirname + '/nginx', {
   port: 8080
 });
 
@@ -35,18 +33,18 @@ async.series([
   console.log('proxying google at http://localhost:8080/ngineer');
 });
 
+nginx.stopOnExit();
 ```
 
-The above example proxies a request from http://localhost:8080/ngineer through to https://github.com/DamonOehlman/ngineer.  A more practical example is shown below where we proxy a local [express](https://github.com/visionmedia/express) application through nginx.
+The above example proxies a request from <http://localhost:8080/ngineer> through to <https://github.com/DamonOehlman/ngineer>.  A more practical example is shown below where we proxy a local [express](https://github.com/visionmedia/express) application through nginx.
 
 ```js
-var async = require('async');
-var express = require('express');
+const async = require('async');
+const express = require('express');
 
-var nginx = require('ngineer')(__dirname + '/nginx', {
+const nginx = require('..')(__dirname + '/nginx', {
   port: 8080
 });
-var proxy = nginx.location('/express-test').proxy('http://localhost:3000/');
 
 // create our simple express app
 express()
@@ -58,7 +56,11 @@ express()
       return console.error('could not start bind express app to port 3000', err);
     }
 
-    async.series([ nginx.scaffold, nginx.start, proxy ], function(err) {
+    async.series([
+      nginx.scaffold,
+      nginx.start,
+      nginx.location('/express-test').proxy('http://localhost:3000/')
+    ], function(err) {
       if (err) {
         return console.error(err);
       }
@@ -68,10 +70,9 @@ express()
     });
   });
 
-
+nginx.stopOnExit();
 ```
 
-
 ## How it Works
 
 Ngineer expects that it will have a nginx configuration folder that it s responsible for managing (see the `-p` commandline argument).  While ngineer doesn't require that it is reponsible for running the nginx process, it is happy to do this.  If you do decide to use this option then ensure that you upstart (or similar) the node process running nginx.
@@ -93,72 +94,28 @@ When using ngineer it's important to note that you are probably accepting a few
 Ngineer communicates with the `nginx` process and sends the `HUP` [signal](http://wiki.nginx.org/CommandLine#Loading_a_New_Configuration_Using_Signals)
 to flag the the nginx configuration should be reloaded and nginx gracefully restarted.
 
-
 ## Why ngineer?
 
 Why do you want this?  Well, because `nginx` does a kick arse job of serving
-static files and also proxying services so it makes sense you use it over
-pure node alternatives such as [node-http-proxy](https://github.com/nodejitsu/node-http-proxy).
-No offense is meant to the awesome [nodejitsu](nodejitsu.com) team here, but
-I feel much more comfortable using nginx over node to be the first line in
-serving both node applications and static content.
+static files and also proxying services so this provides you an option of using it
+over node based proxying solutions.
 
 ## Prior Art
 
-- [nginx-http-proxy](https://github.com/liamoehlman/nginx-http-proxy)
+* [nginx-http-proxy](https://github.com/liamoehlman/nginx-http-proxy)
 
 ## Alternative Projects
 
 Before using `ngineer` you should consider also consider the following
 projects (in addition to those listed in Prior Art):
 
-- [nginx-vhosts](https://github.com/maxogden/nginx-vhosts)
-
-## Reference
-
-### ngineer(basePath, opts)
-
-#### location(pattern) => NginxLocation
-
-Create a new location directive for the nginx configuration
-
-#### reload()
-
-The reload method sends the reload configuration (HUP) signal to the nginx process.
-
-#### reset()
-
-The reset function cleans out the config directory and stops the nginx running if
-is running.
-
-#### scaffold(callback)
-
-Scaffold an nginx configuration directory based on a known default
-configuration.
-
-#### start(callback)
-
-Attempt to start nginx by using a few well known nginx binary locations.
-
-#### stop(callback)
-
-
-Stop the nginx process
-
-### location(pattern)
-
-Create a location section for the nginx configuraton.
-
-#### proxy(targetUrl)
-
-Include a [proxy_pass](http://wiki.nginx.org/HttpProxyModule#proxy_pass)
-directive into the location
+* [nginx-vhosts](https://github.com/maxogden/nginx-vhosts)
 
 ## License(s)
 
 ### MIT
 
-Copyright (c) 2017 Damon Oehlman <[email protected]>
+Copyright (c) 2017 Damon Oehlman <mailto:[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

examples/proxy-express.js

@@ -1,10 +1,9 @@
-var async = require('async');
-var express = require('express');
+const async = require('async');
+const express = require('express');
 
-var nginx = require('..')(__dirname + '/nginx', {
+const nginx = require('..')(__dirname + '/nginx', {
   port: 8080
 });
-var proxy = nginx.location('/express-test').proxy('http://localhost:3000/');
 
 // create our simple express app
 express()
@@ -16,7 +15,11 @@ express()
       return console.error('could not start bind express app to port 3000', err);
     }
 
-    async.series([ nginx.scaffold, nginx.start, proxy ], function(err) {
+    async.series([
+      nginx.scaffold,
+      nginx.start,
+      nginx.location('/express-test').proxy('http://localhost:3000/')
+    ], function(err) {
       if (err) {
         return console.error(err);
       }
@@ -26,3 +29,4 @@ express()
     });
   });
 
+nginx.stopOnExit();

examples/proxy-ngineer.js

@@ -1,5 +1,5 @@
-var async = require('async');
-var nginx = require('..')(__dirname + '/nginx', {
+const async = require('async');
+const nginx = require('..')(__dirname + '/nginx', {
   port: 8080
 });
 
@@ -15,3 +15,5 @@ async.series([
   console.log('started nginx, pid: ' + nginx.pid);
   console.log('proxying google at http://localhost:8080/ngineer');
 });
+
+nginx.stopOnExit();