Skip to content
A serverless plugin to use @zeit/ncc for bundling
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
.babelrc
.eslintrc.js
.gitignore
.prettierignore
.prettierrc
LICENSE
README.md
package-lock.json
package.json
tsconfig.json

README.md

serverless-plugin-ncc

A serverless plugin to use @zeit/ncc for compiling code before packaging.

Usage

npm install -D serverless-plugin-ncc @zeit/ncc

@zeit/ncc is a peer dependency, so we'll have to install it separately.

Add the pluging to serverless.yml

plugins:
  - serverless-plugin-ncc

How to use with TypeScript files?

# serverless.yml

functions:
  typescriptFn:
    # the plugin checks for src/index.ts as well as src/index.js
    # whichever exists is picked up
    handler: src/index.handler

Pass options

Custom options can be passed to ncc like this:

# serverless.yml

custom:
  ncc:
    minify: true

Note that all options are currently passed directly to ncc. To view all possible options check the ncc docs

Pass custom options per-function

Passing custom options to a function is as simple as introducing a custom block under the function with your ncc config

# serverless.yml

functions:
  hello:
    handler: src/hello/index.hello
    custom:
      ncc:
        minify: false

Disable ncc per function

You can pass enabled: false as custom config per function to disable ncc on that function

# serverless.yml

functions:
  hello:
    handler: src/hello/index.hello
    custom:
      ncc:
        enabled: false

License

MIT

You can’t perform that action at this time.