runlamb

A simple tool to compile, package and publish TypeScript Lambda functions.

Motivation: TypeScript can be a bit burdensome to setup for small projects. Most of my lambda functions are small code bases, that do not get updated frequently. The idea is to ease the work setting up and deploying TypeScript projects to lambda so it is as fast to create a TypeScript function as it is a node8 project.

WIP

TODO

• Init projects
• Override tslint & tsconfig
• Push version tag
• Allow runfiles.
• MacOSX support?
• Probably other things too...
• Tests... for me and for you!

Install

WIP, untested... yet

npm install -g https://github.com/fromkeith/runlam.git

Basic Use

Compile for local use

runlam myfunc

This will execute tslint & then tsc

Compile for release

runlam myfunc --release

This will compile via linux use

Publish

runlam myfunc --release --publish

Publish a prebuilt zipfile

runlam myfunc --publish --publish-only=myfunc-1537988871.zip

Publish for a specific stage

runlam myfunc --release --publish --stage=devo

Put packaged code into a local folder, and don't invoke the copy commands. Eg. local dev work

runlam myfunc --dev=dest/ --no-copy

Folder Structure

An example project would be setup in the following way:

package.json
myfunc/package.json
myfunc/index.ts
myfunc/node_modules/*
secondfunc/package.json
secondfunc/index.ts

This example project has two lambda functions: myfunc and secondfunc.

Compiling a lambda function for myfunc will create the following files.

myfunc/myfunc-1537988871.zip

Creating a project

Not yet implemented

runlam init

Sub Commands

Any runfile.js in a subfolder will be added as subcommand.

Eg. the func/file

    // myfunc/runfile.js
    export test() {
        // code here
    }

can be run as

    run myfunc:test

Configuration

Configure how the lambda func is exported

Any subfolder can contain a runlam.json file with the following configurations.

{
    "aws": {
        "profile": "default",
        "region": "us-west-2"
    },
    "lambda": {
        "regions": ["us-west-2", "us-east-1"],
        "overrides": {
            "us-west-2": {
                "functionName": "override-name"
            },
            "us-east-1": {
                "functionName": "different-name"
            }
        },
        "publish": true | false
    },
    "entry": "index.js",
    "build": {
        "copy": [
            "copythesefolders",
            {"from": "/abs/path/to", "to": "./relative/to/dist"}
        ],
        "native": "wsl" | "docker-tag" | true
    },
    "stages": {
        "devo": {
            // exact mirror of root
        },
        "any-key": {
            // exact mirror of root
        }
    }
}

Extra Info

Distributable Zip

The zip is set to prune all non-production packages. It also removes any aws-sdk packages as Lambda comes with those pre-installed.

Reserved Names

node_modules
dist
init
bin
package

Docker

A docker file is available for building native linux libraries on a non-AmazonLinux box. Currently this code base uses the included docker file (on dochub: fromkeith/runlam).

I have found that anti-virus, like windows defender can cause weird rw errors when executing. For me "npm prune" would hit a file that no longer existed, and fail. If you run into that, disable your anti-virus realtime monitoring.

License

MIT