Merge pull request #6 from vkkis93/feat/context_object

Feat/context object

.codeclimate.yml

@@ -0,0 +1,14 @@
+version: "2"
+checks:
+  method-complexity:
+    config:
+      threshold: 50
+  method-lines:
+    config:
+      threshold: 100
+plugins:
+  eslint:
+    enabled: true
+    channel: "eslint-4"
+    config:
+      config: .eslintrc

.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+*.log
+*.json
+*.lock
+*.md

.eslintrc

@@ -0,0 +1,102 @@
+{
+  "env": {
+    "browser": false,
+    "node": true,
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    //# Possible Errors
+    //# http://eslint.org/docs/rules/#possible-errors
+    "comma-dangle": [2, "only-multiline"],
+    "no-control-regex": 0,
+    "no-debugger": 2,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-empty-character-class": 2,
+    "no-ex-assign": 2,
+    "no-extra-boolean-cast": 2,
+    "no-extra-parens": [2, "functions"],
+    "no-extra-semi": 2,
+    "no-func-assign": 2,
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-obj-calls": 2,
+    "no-proto": 2,
+    //"no-template-curly-in-string": 2,
+    "no-unexpected-multiline": 2,
+    "no-unreachable": 2,
+    //"no-unsafe-negation": 2,
+    "use-isnan": 2,
+    "valid-typeof": 2,
+
+    //# Best Practices
+    //# http://eslint.org/docs/rules/#best-practices
+    "no-fallthrough": 2,
+    //"no-global-assign": 2,
+    "no-multi-spaces": 2,
+    "no-octal": 2,
+    "no-redeclare": 2,
+    "no-self-assign": 2,
+    "no-unused-labels": 2,
+    "max-lines": ["error", 1000],
+
+    //# Strict Mode
+    //# http://eslint.org/docs/rules/#strict-mode
+    "strict": [2, "global"],
+
+    //# Variables
+    //# http://eslint.org/docs/rules/#variables
+    "no-delete-var": 2,
+    "no-undef": 2,
+    "no-unused-vars": [2, {"args": "none"}],
+
+    //# Node.js and CommonJS
+    //# http://eslint.org/docs/rules/#nodejs-and-commonjs
+    "no-mixed-requires": 2,
+    "no-new-require": 2,
+    "no-path-concat": 2,
+    "no-restricted-modules": [2, "sys", "_linklist"],
+
+    //# Stylistic Issues
+    //# http://eslint.org/docs/rules/#stylistic-issues
+    "brace-style": [2, "1tbs", {"allowSingleLine": true}],
+    "comma-spacing": 2,
+    "eol-last": 2,
+    //"func-call-spacing": 2,
+    "key-spacing": [2, {"mode": "minimum"}],
+    "keyword-spacing": 2,
+    "max-len": [2, 150, 2],
+    "indent": ["error", 4],
+    "new-parens": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-multiple-empty-lines": [2, {"max": 2}],
+    "no-trailing-spaces": 2,
+    "quotes": [2, "single", "avoid-escape"],
+    "semi": 2,
+    "space-before-blocks": [2, "always"],
+    "space-before-function-paren": [2, "never"],
+    "space-in-parens": [2, "never"],
+    "space-infix-ops": 2,
+    "space-unary-ops": 2,
+
+    //# ECMAScript 6
+    //# http://eslint.org/docs/rules/#ecmascript-6
+    "arrow-spacing": [2, {"before": true, "after": true}],
+    "constructor-super": 2,
+    "no-class-assign": 2,
+    "no-confusing-arrow": ["error", {"allowParens": true}],
+    "no-const-assign": 2,
+    "no-dupe-class-members": 2,
+    "no-new-symbol": 2,
+    "no-this-before-super": 2,
+    "prefer-const": 2,
+    "template-curly-spacing": 2
+  },
+  "globals": {
+    "util": true,
+    "i18n": true,
+    "container": true
+  }
+}

README.md

@@ -1,10 +1,18 @@
 [![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
+[![npm version](https://badge.fury.io/js/serverless-step-functions-offline.svg)](https://badge.fury.io/js/serverless-step-functions-offline)
+[![Known Vulnerabilities](https://snyk.io/test/github/vkkis93/serverless-step-functions-offline/badge.svg?targetFile=package.json)](https://snyk.io/test/github/vkkis93/serverless-step-functions-offline?targetFile=package.json)
+[![Dependency Status](https://david-dm.org/vkkis93/serverless-step-functions-offline.svg)](https://david-dm.org/vkkis93/serverless-step-functions-offline)
 
-# serverless-step-offline
+# serverless-step-functions-offline
 
-:warning: **Currently in beta** :warning:
+## Documentation
 
-# IMPORTANT: This plugin only works with *node.js* runtime and only with callback. It does not work with context object.
+- [Install](#install)
+- [Setup](#setup)
+- [Requirements](#requirements)
+- [Usage](#usage)
+- [Run plugin](#run-plugin)
+- [What does plugin support](#what-does-plugin-support)
 
 # Install
 Using NPM:
@@ -103,12 +111,14 @@ By default `process.env.STEP_IS_OFFLINE = true`.
 | ***Pass*** | * |
 | ***Parallel*** |  Only *Branches*
 
-### Future plans
- - Support context object
- - Support fields *Retry*, *Catch*
- - Support other languages except node.js
- - Improve performance
- - Fixing bugs
+### TODOs
+ - [x] Support context object
+ - [x] Improve performance
+ - [x] Fixing bugs
+ - [ ] Add unit tests - to make plugin stable (next step)
+ - [ ] Support fields *Retry*, *Catch*
+ - [ ] Support other languages except node.js
+
 
 If you have any questions, feel free to contact me: [email protected]