{"id":25519665,"url":"https://github.com/aligent/serverless-conventions","last_synced_at":"2026-03-05T05:05:58.591Z","repository":{"id":37948964,"uuid":"423667197","full_name":"aligent/serverless-conventions","owner":"aligent","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-03T05:44:07.000Z","size":1611,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":12,"default_branch":"main","last_synced_at":"2026-03-03T09:27:06.626Z","etag":null,"topics":["serverless"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-02T01:17:10.000Z","updated_at":"2025-07-24T06:58:03.000Z","dependencies_parsed_at":"2023-11-29T00:24:19.517Z","dependency_job_id":"996ece75-8a78-4792-8bba-9447c2026526","html_url":"https://github.com/aligent/serverless-conventions","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/aligent/serverless-conventions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-conventions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-conventions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-conventions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-conventions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/serverless-conventions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fserverless-conventions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30111728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T03:40:26.266Z","status":"ssl_error","status_checked_at":"2026-03-05T03:39:15.902Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["serverless"],"created_at":"2025-02-19T17:29:19.570Z","updated_at":"2026-03-05T05:05:58.576Z","avatar_url":"https://github.com/aligent.png","language":"TypeScript","readme":"# Serverless Conventions Plugin\n\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)\n[![npm version](https://badge.fury.io/js/@aligent%2Fserverless-conventions.svg)](https://badge.fury.io/js/@aligent%2Fserverless-conventions)\n\nA [Serverless framework](https://www.serverless.com) plugin to enforce various formatting conventions to maintain consistency within Serverless applications.\n\n## List of conventions\n| Convention | Good Example | Bad Example |\n| --- | --- | --- |\n| Service name must be dash delimited | this-is-a-good-name | thisIsABadName |\n| Service name must not contain the word \"service\" | this-is-a-good-name | this-is-a-bad-service | \n| Service name must be less than 24 characters | this-is-a-good-name | this-is-a-bad-name-because-its-too-long |\n| Stage must contains only lower case alphabet characters | dev | Development |\n| Stage must be exactly 3 characters long | prd | prod |\n| Handler names must have the same name as the function | functions:\u003cbr\u003e\u0026nbsp;thisIsAWellNamedExample:\u003cbr\u003e\u0026nbsp;\u0026nbsp;handler: src/this-is-a-well-named-example.handler | functions:\u003cbr\u003e\u0026nbsp;thisIsABadlyNamedFunction:\u003cbr\u003e\u0026nbsp;\u0026nbsp;handler: src/this-is-a-badly-named-example.handler |\n| Function names must be in camel case | thisIsAWellNamedExample | ThisIsABadlyNamedExample |\n| Function names should not be overwritten | functions:\u003cbr\u003e\u0026nbsp;exampleFunction:\u003cbr\u003e\u0026nbsp;\u0026nbsp;handler: src/example-function.handler | functions:\u003cbr\u003e\u0026nbsp;exampleFunction:\u003cbr\u003e\u0026nbsp;\u0026nbsp;name: exampleFunction\u003cbr\u003e\u0026nbsp;\u0026nbsp;handler: src/example-function.handler |\n| Handler names must be dash delimited | src/this-is-a-well-named-example.handler | src/ThisIsABadlyNamedExample.handler |\n| Handler names must end in \".handler\" | src/this-is-a-well-named-example.handler | src/this-is-a-badly-named-example |\n| DynamoDB table names must be in kebab case | example-name-good-table-name | BadTableName |\n| DynamoDB table names must start with the service name | example-name-good-table-name | bad-table-name |\n\n## Serverless configuration\nThe plugin is configured within the `serverless.yaml` by adding the plugin to the list of plugins.\n\n```\nplugins:\n  - \"@aligent/serverless-conventions\"\n```\n\n### Ignoring specific checks\nAll checks can be ignored by specifying the check to ignore under a top level property named `conventions` in `serverless.yaml`.\n\nA list of all the available ignore commands are below:\n\n```\nconventions:\n  ignore:\n    serviceName: true\n    stageName: true\n    handlerName: true\n    functionName: true\n    handlerNameMatchesFunction: true\n    dynamoDBTableName: true\n```\n\n## Running the conventions check\nThe conventions check will run automatically each time you run a serverless command that compiles the packages. (e.g. `serverless package`, `serverless deploy`)\n\nAlternatively, the conventions check can be run manually with `serverless conventions-check`.\n\n## Example Output\n![serverless output](/images/serverless_output.png)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fserverless-conventions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fserverless-conventions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fserverless-conventions/lists"}