alliants-serverless-utils

Set of tools for serverless framework applications.

Install

$ npm install https://github.com/Alliants/alliants-serverless-utils

Usage

Eslint

Create an eslint.config.js with:

import config from 'alliants-serverless-utils/eslint'

export default config(/** options */)

The options available can be found here: https://github.com/antfu/eslint-config

Bundle Plugin

Plugin bundler to build in single files every handler of your serverless functions.

Add to your serverless.yml

plugins:
  - alliants-serverless-utils/plugins/bundle

package:
  individually: true

The plugin uses esbuild, if you want to configure it you can define a bundle.config.js in the root path with:

export default (/** serverless */) => {
  return {
    sourcemap: false
  }
}

Documentation Plugin

Plugin to generate an openapi documentation based on the serverless functions exported.

Add to your serverless.yml

plugins:
  - alliants-serverless-utils/plugins/documentation

custom:
  documentation:
    schemasPath: src/schemas/schemas.js
    errorsPath: src/utils/errors.js
    version: "1"
    title: Example API
    description: OpenAPI documentation.

To generate the documentation execute:

$ npx sls openapi generate -o docs/openapi.json

This plugin uses Joi schemas exported by the serverless functions to generate the valid openapi paths. schemasPath and errorsPath are used to provide default schemas such us generic errors reponses.

More information can be found in the example directory.

Bruno Plugin

Plugin to generate a bruno spec based on the serverless functions.

Documentation plugin is required.

Add to your serverless.yml

plugins:
  - alliants-serverless-utils/plugins/documentation
  - alliants-serverless-utils/plugins/bruno

custom:
  documentation:
    schemasPath: src/schemas/schemas.js
    errorsPath: src/utils/errors.js
    version: "1"
    title: Example API
    description: OpenAPI documentation.

To generate the bruno spec execute:

$ npx sls bruno generate