Escapin

0.4.9 verified Fri May 01 auth: no javascript

Escapin is a transpiler that converts source code into executable serverless applications for cloud services and APIs, version 0.4.9. Released by Fujitsu Laboratories, it generates serverless.yml and transpiled code for deployment via the Serverless Framework, primarily targeting AWS. It supports TypeScript and JavaScript, with features like storage abstraction, function integration, and OpenAPI import. The package is stable but niche, with infrequent updates and limited community adoption. It differentiates by providing a domain-specific language for cloud service orchestration, reducing boilerplate. Requires Node.js >=10 and the Serverless Framework as a peer dependency.

Common errors

error escapin: command not found ↓

cause Escapin is not installed or not in PATH.

fix

Install as dev dependency: npm install --save-dev escapin. Then use npx escapin.

error Error: Cannot find module 'serverless' ↓

cause Serverless Framework is not installed globally or locally.

fix

npm install -g serverless

error TypeError: Cannot read property 'name' of undefined ↓

cause Missing 'name' property in .escapinrc config.

fix

Add a 'name' field to your configuration file (e.g., 'name': 'myapp').

Warnings

gotcha Requires Node.js >=10 and the Serverless Framework globally installed. ↓

fix Install Serverless Framework via npm install -g serverless.

gotcha Escapin only supports a limited set of cloud providers; likely AWS only. ↓

fix Ensure your target platform (e.g., aws) is configured in .escapinrc.

deprecated The 'default_storage' config option may be deprecated; use 'storage' instead. ↓

fix Replace 'default_storage' with 'storage' in config.

gotcha CLI output directory ('build/') may conflict with existing build scripts. ↓

fix Set 'output_dir' in config to a non-conflicting directory.

Install

npm install escapin

yarn add escapin

pnpm add escapin

Imports

escapin CLI
wrong
```
require('escapin')
```
correct
```
npx escapin
```
Escapin is primarily a CLI tool; there is no programmatic API exported.
escapin config file
wrong
```
.escapinrc.ts
```
correct
```
.escapinrc.js
```
Configuration files can be JSON, YAML, or JS (CommonJS). TypeScript config is not supported directly.
escapin output
```
escapin transpiles code to ./build/ by default
```
The output directory is configurable via 'output_dir' in config.

Quickstart

This package.json snippet shows the minimal setup to build and deploy a serverless application with Escapin and the Serverless Framework.

{
  "scripts": {
    "build": "escapin",
    "start": "cd build && serverless deploy"
  }
}