https://github.com/icebreaker-trash/serverless-config-generator
use js to generate serverless.yml
https://github.com/icebreaker-trash/serverless-config-generator
serverless yml
Last synced: 12 months ago
JSON representation
use js to generate serverless.yml
- Host: GitHub
- URL: https://github.com/icebreaker-trash/serverless-config-generator
- Owner: icebreaker-trash
- License: mit
- Created: 2021-01-03T05:04:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T23:51:08.000Z (almost 2 years ago)
- Last Synced: 2025-04-11T22:07:42.846Z (12 months ago)
- Topics: serverless, yml
- Language: TypeScript
- Homepage:
- Size: 119 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# serverless-config-generator
> use js to generate serverless.yml
a util help you to generate serverless framework deploy file fluently
## Installation
```sh
# global cli
npm i -g serverless-config-generator
yarn global add serverless-config-generator
//or
npm i -D serverless-config-generator
yarn add -D serverless-config-generator
```
## How to use
if you install globally
you could run
```sh
# in your target dir
sls-gen
# serverless.js to serverless.yml
sls-gen -i serverless.layer.js -o serverless.layer.yml
```
or write jscode in Node.js
```js
const { generateSync, generate } = require('serverless-config-generator')
const path = require('path')
// default
generateSync()
//or
async main(){
await generate()
}
// process.cwd() serverless.js => serverless.yml
generateSync({
input:path.resolve(__dirname,'./lib/xxx.js'),
output:{
dir:path.resolve(__dirname,'./layer'),
filename:'serverless.layer.yml'
}
})
```
## Option
| params | type | default |
|---|---|---|
|input|`string`| `path.resolve(process.cwd(),'serverless.js')` |
|output|`string/Object`|`path.resolve(process.cwd(),'serverless.yml')`|
|output.dir|`string`|`undefined`|
|output.filename|`string`|`undefined`|