Git Product home page Git Product logo

serverless-plugin-ncc's Introduction

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

serverless-plugin-ncc's People

Contributors

jaydp17 avatar dirkdev98 avatar sergioramos avatar simlu avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.