SERVERLESS BUILD PLUGIN

*** WARNING *** This is a beta release under heavy development, use with caution.

This plugin is intended to add flexibility to the serverless build process for nodejs, under serverless 1.0 including an 0.5 compatibility layer thanks to zyrorl.

Currently in testing state. To try it:

npm i
cd test
npm i
export AWS_PROFILE=default
sls deploy
sls deploy function -f one
sls invoke -f one --log
sls deploy function -f one --method=file
sls invoke -f one --log

After running the above you should have built the same function in each of the two methods successfully.

Serverless 1.0.x-beta Installation

Run: npm i --save serverless-build-plugin

Add the plugin to serverless.yml under plugins

eg.

service: my-service

provider:
  name: aws
  runtime: nodejs4.3

plugins:
  - serverless-build-plugin

package:
    exclude:
        - node_modules

functions:
  one:
    handler: functions/one/handler.handler

Then create the serverless.build.yml as per Configuration.

Serverless 0.5.x Installation

Run: npm i --save serverless-build-plugin

Modify s-project.json to add serverless-build-plugin to the plugins array.

ie.

{
  "name": "example-serverless-project",
  "plugins": [
    "serverless-build-plugin"
  ],
  "description": "My Serverless Project",
  "version": "0.0.1",
  "profile": "serverless-v0.5.5"
}

Then create the serverless.build.yml as per Configuration.

METHODS

There are two ways to build:

Bundling
- This will preserve the existing source filestructure and potentially any non-excluded files.
- Optionally, each JS file in babel'ed and uglified individually
Build Files
- With this method, specify a file (or let it default to a webpack.config.js)
- The file can return a string, a stream or a webpack.config.js object
- If the file exports a default function, its return value will instead be used, as above
- Webpack configs will be executed, and their output injected into the zip, including externals modules
- Strings & streams will be piped into a handler.js

CONFIGURATION

There are three ways to configure the plugin:

Create a serverless.build.yml inside the project directory
Populate custom.build in serverless.yml
The commandline
- sls deploy function -f one --file=./buildFile.js

# ./serverless.build.yml

method: "bundle"

sourceMaps : true
babel      : true # Will use ./.babelrc
uglify     : true # Will use defaults

exclude:
  - "*" # Ignores the root directory

modules:
  exclude: # excluded from the root node_modules
    - aws-sdk

  deepExclude: # excluded from nested node_modules
    - aws-sdk

functions:
  one:
    include:
      - "functions/one/**"
      - "lib/one/**"

    exclude:
      - "**/*.json"

OPTIONS

babel
- Can be true, will search for a .babelrc in the project directory
- Can be a babelrc-like object
uglify
- When true, will uglify source & modules
- Can be an options object, passed to uglify
method
- When bundle, will use bundling method
- When file, will use a build file or webpack config
file
- Path to a build file or webpack config

ROADBLOCKS

serverless 1.0 still doesn't support packaging single functions
- #1719
- #1777
sls deploy will currently take a while due to packaging everything for the first deployment.
- This is a bug due to not being able to hook into it.

zyrorl / serverless-build-plugin Goto Github PK