- :open_file_folder: `assorted/@sls-api.json` - :open_file_folder: `struct/#serverless-api` - :clipboard: `struct/sls-test-hangler-gen` - :clipboard: `struct/sls-test-hangler-conf` - :clipboard: `struct/sls-test-hangler` - :clipboard: `struct/sls-test-env` - :clipboard: `struct/sls-swagger` - :clipboard: `struct/sls-src-hangler` - :clipboard: `struct/sls-src-core-api` - :open_file_folder: `gitignore/#serverless-api` - :clipboard: `gitignore/lambda-tdd` # :open_file_folder: assorted/@sls-api.json (`index`) Manage serverless project using lambda-serverless-api and lambda-tdd.
Targets Requires Variables
## :open_file_folder: struct/#serverless-api (`index`) Manage project structure for serverless project using lambda-serverless-api and lambda-tdd.
Targets Requires Variables
### :clipboard: struct/sls-test-hangler-gen (`index`) _Updating test/hangler-gen.spec.js using overwrite._ - Managed file to generate hangler.js file.
Targets Requires
### :clipboard: struct/sls-test-hangler-conf (`index`) _Updating test/hangler.conf.js using create-only._ - Create confiuration template for lambda-tdd test setup.
Targets Requires
### :clipboard: struct/sls-test-hangler (`index`) _Updating test/hangler.spec.js using overwrite._ - Managed file to run lambda-tdd tests and sync swagger docs.
Targets Requires
### :clipboard: struct/sls-test-env (`index`) _Updating test/env-vars.yml using merge-deep._ - Create configuration template for lambda-tdd test setup.
Targets Requires Variables
### :clipboard: struct/sls-swagger (`index`) _Updating swagger.yml using create-only._ - Create empty swagger definition file.
Targets Requires
### :clipboard: struct/sls-src-hangler (`index`) _Updating src/hangler.js using create-only._ - Manage handler definition file.
Targets Requires
### :clipboard: struct/sls-src-core-api (`index`) _Updating src/core/api.js using create-only._ - Template for api instantiation.
Targets Requires
    project
    └─ src
       └─ core
          └─ api.js
## :open_file_folder: gitignore/#serverless-api (`index`) Manage gitignore content for serverless project using lambda-serverless-api and lambda-tdd.
Targets Requires
### :clipboard: gitignore/lambda-tdd (`index`) _Updating .gitignore using append-new._ - Inject recommended entries for lambda-tdd setup.
Targets Requires
------ ## Requires ### lambda-serverless-api ([`link`](https://github.com/blackflux/lambda-serverless-api)) *AWS Lambda Serverless API Gateway Framework.* Abstracts the creation of a basic API and the most commonly desired features. ### lambda-tdd ([`link`](https://github.com/blackflux/lambda-tdd)) *Testing Framework for AWS Lambda.* Testing Framework for AWS Lambda that uses recordings to work offline without requiring Cloud environment. ### serverless ([`link`](https://serverless.com/)) *Serverless Framework.* The Serverless Framework is a free and open-source web framework that was developed for building serverless applications. ### swagger ([`link`](https://swagger.io/resources/open-api/)) *Swagger RESTful API Specification.* Swagger™ is a format used to describe and document RESTful APIs. ### git ([`link`](https://git-scm.com/)) *Version control system.* The most used version control system. Not to be confused with github (which uses git). ------ ## Variables ### awsSessionToken : `string` **Default**: `XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` *Aws session token.* Should only be filled in with dummy credentials for tests. ### awsSecretAccessKey : `string` **Default**: `XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` *Aws secret access key.* Should only be filled in with dummy credentials for tests. ### awsAccessKeyId : `string` **Default**: `XXXXXXXXXXXXXXXXXXXX` *Aws access key id.* Should only be filled in with dummy credentials for tests. ### awsRegion : `string` *Aws data center region code gets deployed to.* List of available regions can be found [here](https://docs.aws.amazon.com/general/latest/gr/rande.html). ------ ## Targets ### test/hangler-gen.spec.js :small_red_triangle: serverless, lambda-serverless-api, lambda-tdd :small_blue_diamond: `other` *Managed file that generates hangler.js file.* ### test/hangler.conf.js :small_red_triangle: lambda-tdd :small_blue_diamond: `other` *Configuration for lambda-tdd test setup.* ### test/hangler.spec.js :small_red_triangle: lambda-serverless-api, lambda-tdd :small_blue_diamond: `other` *Test Utility to run lambda-tdd tests and sync swagger docs.* ### test/env-vars.yml :small_red_triangle: lambda-tdd :small_blue_diamond: `other` *Configuration definitions for lambda-tdd test setup.* ### swagger.yml :small_red_triangle: swagger :small_blue_diamond: `yml` *Swagger RESTful API definition.* Swagger documentation for project. ### src/hangler.js :small_red_triangle: lambda-serverless-api, aws :small_blue_diamond: `other` *Handler definitions.* Managed handler definition file. ### src/core/api.js :small_red_triangle: lambda-serverless-api, aws :small_blue_diamond: `other` *Template for Api initialization.* API initialization file. ### .gitignore ([`link`](https://git-scm.com/docs/gitignore)) :small_red_triangle: git :small_blue_diamond: `list` *Exclude files from being tracked.* Specifies files intentionally untracked by git. ------ ## Strategies ### overwrite :small_blue_diamond: `any` *Simply replace the old with the new content.* ### create-only :small_blue_diamond: `any` *Does nothing when the file is already present, otherwise creates it.* ### merge-deep :small_blue_diamond: `json`, `yml` *Does a "smart" deep merge.* This will not work as desired for all object deep merging, but should for many cases. ### append-new :small_blue_diamond: `list` *Appends content to end of the file if lines do not exists in file.* Useful for managing e.g. `.gitignore` when the original content should be kept.