Merge pull request #179 from vladimyr/master

Spring cleaning

Author: Unitech

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: 'semistandard',
+  rules: {
+    'space-before-function-paren': ['error', {
+      anonymous: 'always',
+      named: 'never'
+    }],
+    'comma-dangle': ['error', 'always-multiline'],
+  }
+};

.gitignore

@@ -1,5 +1,3 @@
 node_modules
 *.log
-*.log
 *.pid
-package-lock.json

.npmignore

@@ -0,0 +1 @@
+package-lock=false

.npmrc

@@ -1,6 +1,15 @@
 language: node_js
 node_js:
-   - "4"
-   - "6"
-   - "7"
-   - "8"
+  - '6'
+  - '8'
+  - 'lts/*'
+  - 'node'
+
+matrix:
+  include:
+    - node_js: '4'
+      env: NO_LINT=true
+
+script:
+  - if [[ -z "${NO_LINT}" ]]; then npm run lint; fi
+  - npm test

.travis.yml

@@ -1,7 +1,84 @@
-
 # Deploy system for PM2
 
-Documentation: [http://pm2.keymetrics.io/docs/usage/deployment/](http://pm2.keymetrics.io/docs/usage/deployment/)
+Documentation: <https://pm2.io/doc/en/runtime/guide/easy-deploy-with-ssh/>
+
+[![build status](https://badgen.net/travis/Unitech/pm2/master)](https://travis-ci.org/Unitech/pm2-deploy) [![npm package version](https://badgen.net/npm/v/pm2-deploy)](https://npm.im/pm2-deploy) [![install size](https://badgen.net/packagephobia/install/pm2-deploy)](https://packagephobia.now.sh/result?p=pm2-deploy) [![github license](https://badgen.net/github/license/Unitech/pm2-deploy)](https://github.com/Unitech/pm2-deploy/blob/master/LICENSE) [![js semistandard style](https://badgen.net/badge/code%20style/semistandard/pink)](https://github.com/Flet/semistandard)
+
+## Instalation
+
+    $ npm install pm2-deploy
+
+## Usage
+
+```js
+var deployForEnv = require('pm2-deploy').deployForEnv;
+
+// Define deploy configuration with target environments
+var deployConfig = {
+  prod: {
+    user: 'node',
+    host: '212.83.163.168',
+    ref: 'origin/master',
+    repo: 'git@github.com:Unitech/eip-vitrine.git',
+    path: '/var/www/test-deploy'
+  },
+  dev: {
+    user: 'node',
+    host: '212.83.163.168',
+    ref: 'origin/master',
+    repo: 'git@github.com:Unitech/eip-vitrine.git',
+    path: '/var/www/test-dev'
+  }
+};
+
+// Invoke deployment for `dev` environment
+deployForEnv(deployConfig, 'dev', [], function (err, args) {
+  if (err) {
+    console.error('Deploy failed:', err.message);
+    return console.error(err.stack);
+  }
+  console.log('Success!');
+});
+
+// Rollback `prod` environment
+deployForEnv(deployConfig, 'prod', ['revert', 1], function (err, args) {
+  if (err) {
+    console.error('Rollback failed:', err.message);
+    return console.error(err.stack);
+  }
+  console.log('Success!');
+});
+```
+
+## API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+-   [deployForEnv](#deployforenv)
+    -   [Parameters](#parameters)
+-   [DeployCallback](#deploycallback)
+    -   [Parameters](#parameters-1)
+
+### deployForEnv
+
+Deploy to a single environment
+
+#### Parameters
+
+-   `deployConfig` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object containing deploy configs for all environments
+-   `env` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the environment to deploy to
+-   `args` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** custom deploy command-line arguments
+-   `cb` **[DeployCallback](#deploycallback)** done callback
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** return value is always `false`
+
+### DeployCallback
+
+Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
+
+#### Parameters
 
-[![NPM version](https://badge.fury.io/js/pm2-deploy.png)](http://badge.fury.io/js/pm2)
-[![Build Status](https://api.travis-ci.org/Unitech/pm2-deploy.png?branch=master)](https://travis-ci.org/Unitech/pm2-deploy)
+-   `error` **[Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** deployment error
+-   `args` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** custom command-line arguments provided to deploy