README.md

Serverless Optimizer Plugin

Browserifies, minifies your Serverless Node.js Functions on deployment, and more!

Reducing the file size of your AWS Lambda Functions allows AWS to provision them more quickly, speeding up the response time of your Lambdas. Smaller Lambda sizes also helps you develop faster because you can upload them faster. This Severless Plugin is absolutely recommended for every project including Lambdas with Node.js.

Note: Requires Serverless v0.4.0 or higher.

###Setup

• Install via npm in the root of your Serverless Project:

npm install serverless-optimizer-plugin --save

• In the custom property of either your s-component.json or s-function.json add an optimize property.

"custom": {
	"optimize": true
}

• Add the plugin to the plugins array in your Serverless Project's s-project.json, like this:

plugins: [
    "serverless-optimizer-plugin"
]

• All done!

Adding the custom.optimize property in s-component.json applies the optimization setting to ALL functions in that component. Adding the custom.optimize property to s-function.json applies the optimization setting to ONLY that specific function. You can use custom.optimize in both places. The custom.optimize setting in s-function.json will override the setting in s-component.json.

ES6 with Babel and Babelify

Bundles are packaged with Browserify, and can be transformed to support ES6 features with Babelify.

Install babelify within the root context of your project:

npm install babelify --save

Assuming you have a node component called "nodejscomponent", install any babelify presets within the context of that component:

cd nodejscomponent && npm install babel-preset-es2015 --save

Add the babelify transform to s-component.json:

{
    "name": "nodejscomponent",
    "runtime": "nodejs",
    "custom": {
        "optimize": {
            "exclude": [ "aws-sdk" ],
            "transforms": [
                {
                    "name": "babelify",
                    "opts": {
                        "presets": [
                            "es2015"
                        ]
                    }
                }
            ]
        }
    }
}

We're currently working on adding support for Typsecript. Check back for updates!