Serverless Function Value Plugin

[![License][License Badge]][License File]
[![Version][Version Badge]][Version Package]
[![Release][Release Badge]][Release Workflow]
[![Coverage][Coverage Badge]][Coverage Report]
[![Node Version][Node Version Badge]](./package.json#L67)
[![Serverless Version][Serverless Version]](https://serverless.com)

Serverless framework plugin that will automatically generate AWS CloudFormation
snippets to reference a functions name, ARN or logical ID value
based on the internally generated Lambda logical ID. All 2.x versions
support only Serverless 3.x. For Serverless 2.x please use the 1.x
versions.

Installation

``console
npm i -D serverless-plugin-function-value
`

Usage

`yml
service: test

plugins:
- serverless-plugin-function-value

provider:
name: aws
...

resources:
Resources:
LambdaFunctionExecutor:
DependsOn:
- ${fn.logicalid:test}
Type: Custom::LambdaFunctionExecutor
Properties:
ServiceToken: ${fn.arn:test}
Name: ${fn.name:test}

functions:
test:
...
`

During processing the ${fn.*} related items will be resolved to either the
Fn::GetAtt for ${fn.arn:}, Ref for ${fn.name:} or simply the logical
ID for ${fn.logicalid:*}. The custom resource above would look like the below
in the generated CloudFormation template.

`json
"LambdaFunctionExecutor": {
"DependsOn": [
"TestLambdaFunction"
],
"Type": "Custom::LambdaFunctionExecutor",
"Properties": {
"ServiceToken": {
"Fn::GetAtt": [
"TestLambdaFunction",
"Arn"
]
},
"Name": {
"Ref": "TestLambdaFunction"
}
}
}
`

Development

Development can be done on any machine that can install Node.js. Only the latest
LTS version is tested against.

$3

Install dependencies via npm.

`console
npm i
`

$3

Execute linters via npm.

`console


git, javascript, markdown and package.json

npm run lint

git only

npm run lint:git

javascript only

npm run lint:js

markdown only

npm run lint:md

package.json only

npm run lint:pkg
`

$3

Execute tests via npm.

`console


lint, unit tests and integration tests

npm test

unit tests only

npm run test:unit

integration tests only

npm run test:integration
`

$3

Execute automatic fixers via npm.

`console


javascript, markdown and package.json

npm run fix

javascript only

npm run fix:js

markdown only

npm run fix:md

package.json only

npm run fix:pkg
`

$3

Run a build via npm.

`console
npm run build
``

[License Badge]: https://img.shields.io/github/license/devpow112/serverless-plugin-function-value?label=License
[License File]: ./LICENSE
[Version Badge]: https://img.shields.io/npm/v/serverless-plugin-function-value?label=Version
[Version Package]: https://www.npmjs.com/serverless-plugin-function-value
[Node Version Badge]: https://img.shields.io/node/v/serverless-plugin-function-value
[Release Badge]: https://github.com/devpow112/serverless-plugin-function-value/actions/workflows/release.yml/badge.svg?branch=main
[Release Workflow]: https://github.com/devpow112/serverless-plugin-function-value/actions/workflows/release.yml?query=branch%3Amain
[Coverage Badge]: https://img.shields.io/coveralls/github/devpow112/serverless-plugin-function-value/main?label=Coverage
[Coverage Report]: https://coveralls.io/github/devpow112/serverless-plugin-function-value?branch=main
[Serverless Version]: https://img.shields.io/github/package-json/dependency-version/devpow112/serverless-plugin-function-value/dev/serverless/main