/yaml-parser

Parser for serverless.yml

Primary LanguageTypeScriptMIT LicenseMIT

Serverless Yaml Parser

npm NPM downloads Build Status semantic-release

Yaml Parser for Serverless Framework.

Installation

$ npm i @slsplus/yaml-parser -g

Usage

Usage: yparse [options]

Parse serverless config file with costomize and environment variables replacement

Options:
  -v, --version                       output the current version
  -i, --input [input]                 source serverless config file path
  -o, --output                        whether output parse result to input serverless config file (default: false)
  -O, --output-path [outputPath]      output parse result to target serverless config file path
  -r, --root [rootDir]                root directory for parse command running
  -a, --auto-create                   whether auto create serverless config file (default: false)
  -c, --component [component]         serverless component name
  -s, --sls-options [slsOptions]      serverless config
  -l, --layer-options [layerOptions]  serverless layer config
  -or, --override [override]          override serverless config (default: false)
  -h, --help                          display help for command

Example call:
  $ yparse --help

Parse serverless config file

$ yparse -o -s '{"src":"./"}'

Parse command will parse serverless config file with costomize and environment variables replacement.

For example, before is:

inputs:
  region: ${env:REGION}

If process.env.REGION=ap-guangzhou, after parsing, the serverless.yml will be:

inputs:
  src: ./
  region: ap-guangzhou

License

MIT License

Copyright (c) 2021 Tencent Cloud, Inc.