Merge pull request #2 from GiDW/develop

Develop

Author: GiDW

.gitignore

@@ -131,6 +131,9 @@ $RECYCLE.BIN/
 
 .idea
 
+test
+lib
+
 *.zip
 lambda-config.json
 lambda-aws-config.json

.npmignore

@@ -0,0 +1,156 @@
+
+# Created by https://www.gitignore.io/api/node,macos,linux,windows
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/node,macos,linux,windows
+
+## Project
+
+.idea
+
+test
+lib
+
+*.zip
+lambda-config.json
+lambda-aws-config.json
+
+
+### end .gitignore
+
+
+# Include lib
+!lib
+
+*.map
+
+.editorconfig
+.idea
+.nvmrc
+src
+test
+node-lambda.js
+tsconfig.json

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+## [1.0.0] - 2017-06-25
+- Initial release

README.md

@@ -1,2 +1,68 @@
-# aws-node-lambda-helper
-Helper module for deploying AWS Lambda functions in Node.js.
+# aws-lambda-deploy
+## Usage
+
+```bash
+gald [command] [option]
+```
+
+There are 3 commands available
+```bash
+gald init
+gald test
+gald deploy
+```
+### Commands
+
+#### init
+
+Create (missing) configuration 
+files that provide information 
+to the module about 
+the AWS Lambda function. 
+
+After running `init` you should consider 
+adding `lambda-secrets.json` 
+to your `.gitignore`.
+
+The `Handler` property consists of 
+the module name and the function name. 
+
+For example a file `handler.js` with:
+```javascript
+exports.myHandler = function () {};
+```
+The resulting `Handler` property looks like this:
+```
+"Handler": "handler.myHandler"
+```
+
+#### test
+
+Execute all defined tests in `lambda-test.json` 
+or a different JSON file.
+
+```bash
+gald test [optional json file]
+```
+
+#### deploy
+
+Deploys the Lambda function to AWS Lambda.
+In case the Lambda function does not exist 
+or the configuration has been changed, 
+the user will be notified.
+
+Deploy looks for the archive defined in 
+`lambda-config.json` under the property `archiveName`.
+Your build system will have to provide a zip file 
+with the necessary components 
+for the AWS Lambda function.
+
+For example, have a build script that looks like this:
+```bash
+zip -r -9 archive.zip handler.js
+```
+If your AWS Lambda function depends on other packages, 
+make sure to include the `node_modules` folder, 
+with the dependencies installed, 
+in your zip file.