new version

Author: oscarotero

.gitignore

@@ -1,2 +1,3 @@
 /node_modules
-/yarn.lock
+/yarn.lock
+/package-lock.json

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.3.0] - 2018-03-07
+
+### Added
+
+- Static function `PHPServer.start()` as a shortcut to `new PHPServer().run()`.
+- The callback / promise have the `PHPServer` instance as first argument
+
 ## [1.2.1] - 2018-01-02
 
 ### Fixed
@@ -40,6 +47,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 First version with basic features.
 
+[1.3.0]: https://github.com/oscarotero/php-server-manager/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/oscarotero/php-server-manager/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/oscarotero/php-server-manager/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/oscarotero/php-server-manager/compare/v1.0.0...v1.1.0

README.md

@@ -52,15 +52,21 @@ const server = new PHPServer({
 server.run();
 ```
 
+## Quick use
+
+You can use the static function `start()` to create and run a PHPServer in a single line:
+
+```js
+PHPServer.start();
+```
+
 ## Use with gulp
 
 ```js
-gulp.task('php-server', done => {
-    const server = new PHPServer({
+gulp.task('php-server', () =>
+    PHPServer.start({
         directory: 'public',
         script: 'public/index.php'
-    });
-
-    server.run(done);
-});
+    })
+);
 ```

index.js

@@ -2,6 +2,12 @@ const spawn = require('child_process').spawn;
 const http = require('http');
 
 module.exports = class PHPServer {
+    static start(config, cb) {
+        const server = new PHPServer(config);
+
+        return server.run(cb);
+    }
+
     constructor(config) {
         this.php = 'php';
         this.host = '127.0.0.1';
@@ -61,17 +67,15 @@ module.exports = class PHPServer {
         );
 
         if (cb) {
-            checkServer(this.host, this.port, cb);
+            checkServer(this.host, this.port, () => cb(this));
         } else {
             return new Promise((resolve, reject) => {
                 try {
-                    checkServer(this.host, this.port, () => {
-                        resolve()
-                    })
+                    checkServer(this.host, this.port, () => resolve(this));
                 } catch (e) {
-                    reject(e)
+                    reject(e);
                 }
-            })
+            });
         }
     }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "php-server-manager",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Manage PHP built-in servers in node",
   "main": "index.js",
   "author": "Oscar Otero",
@@ -22,7 +22,7 @@
     "url": "https://github.com/oscarotero/php-server-manager/issues"
   },
   "devDependencies": {
-    "mocha": "^4.0.1",
-    "prettier": "^1.8.2"
+    "mocha": "^5.0.4",
+    "prettier": "^1.11.1"
   }
 }