@aligent/serverless-conventions
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.0 • Public • Published

    Serverless Conventions Plugin

    serverless npm version

    A Serverless framework plugin to enforce various formatting conventions to maintain consistency within Serverless applications.

    List of conventions

    Convention Good Example Bad Example
    Service name must be dash delimited this-is-a-good-name thisIsABadName
    Service name must not contain the word "service" this-is-a-good-name this-is-a-bad-service
    Handler names must have the same name as the function functions:
     thisIsAWellNamedExample:
      handler: src/this-is-a-well-named-example.handler
    functions:
     thisIsABadlyNamedFunction:
      handler: src/this-is-a-badly-named-example.handler
    Function names must be in camel case thisIsAWellNamedExample ThisIsABadlyNamedExample
    Handler names must be dash delimited src/this-is-a-well-named-example.handler src/ThisIsABadlyNamedExample.handler
    Handler names must end in ".handler" src/this-is-a-well-named-example.handler src/this-is-a-badly-named-example
    DynamoDB table names must be in kebab case example-name-good-table-name BadTableName
    DynamoDB table names must start with the service name example-name-good-table-name bad-table-name
    IAM deployment role must be valid arn:aws:iam::123456789000:role/example.serverless user/example.serverless

    Serverless configuration

    The plugin is configured within the serverless.yaml by adding the plugin to the list of plugins.

    plugins:
      - "@aligent/serverless-conventions"
    

    Ignoring specific checks

    All checks can be ignored by specifying the check to ignore under a top level property named conventions in serverless.yaml.

    A list of all the available ignore commands are below:

    conventions:
      ignore:
        serviceName: true
        handlerName: true
        functionName: true
        handlerNameMatchesFunction: true
        dynamoDBTableName: true
        iamDeploymentRole: true
    

    Running the conventions check

    The conventions check will run automatically each time you run a serverless command that compiles the packages. (e.g. serverless package, serverless deploy)

    Alternatively, the conventions check can be run manually with serverless conventions-check.

    Example Output

    serverless output

    Keywords

    none

    Install

    npm i @aligent/serverless-conventions

    DownloadsWeekly Downloads

    201

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    138 kB

    Total Files

    11

    Last publish

    Collaborators

    • aligent-bot
    • aligent-danielvanderploeg
    • luke-denton-aligent
    • jarrod.swift
    • john.smith.aligent