From 16d042943d1327366132c1a443a86beea501bfd3 Mon Sep 17 00:00:00 2001
From: Jan Sebastian Siwy <github@jansiwy.de>
Date: Mon, 23 Sep 2024 11:06:39 +0200
Subject: [PATCH] Unify structure of module variables

---
 _test/main.tf |  2 +-
 variables.tf  | 54 +++++++++++++++++++++++++++++++++++++--------------
 2 files changed, 40 insertions(+), 16 deletions(-)

diff --git a/_test/main.tf b/_test/main.tf
index 31415e7..e8ce173 100644
--- a/_test/main.tf
+++ b/_test/main.tf
@@ -3,7 +3,7 @@ provider "aws" {
 }
 
 module "lambda" {
-  source  = "./.."
+  source = "./.."
 
   function_name = "example"
   description   = "This is an example"
diff --git a/variables.tf b/variables.tf
index eca2c0f..db44944 100644
--- a/variables.tf
+++ b/variables.tf
@@ -5,64 +5,84 @@ variable "archive_file" {
   })
   default = null
 
-  description = "An instance of the `archive_file` data source containing the code of the Lambda function. Conflicts with `source_dir`."
+  description = <<EOS
+An instance of the `archive_file` data source containing the code of the Lambda function. Conflicts with `source_dir`.
+EOS
 }
 
 variable "cloudwatch_log_group_retention_in_days" {
   type    = number
   default = 3
 
-  description = "The number of days to retain the log of the Lambda function."
+  description = <<EOS
+The number of days to retain the log of the Lambda function.
+EOS
 }
 
 variable "description" {
   type = string
 
-  description = "Description of the Lambda function."
+  description = <<EOS
+Description of the Lambda function.
+EOS
 }
 
 variable "environment_variables" {
   type    = map(string)
   default = null
 
-  description = "Environment variable key-value pairs."
+  description = <<EOS
+Environment variable key-value pairs.
+EOS
 }
 
 variable "function_name" {
   type = string
 
-  description = "Name of the Lambda function."
+  description = <<EOS
+Name of the Lambda function.
+EOS
 }
 
 variable "handler" {
   type = string
 
-  description = "The name of the method within your code that Lambda calls to execute your function."
+  description = <<EOS
+The name of the method within your code that Lambda calls to execute your function.
+EOS
 }
 
 variable "layers" {
   type    = list(string)
   default = []
 
-  description = "List of up to five Lambda layer ARNs."
+  description = <<EOS
+List of up to five Lambda layer ARNs.
+EOS
 }
 
 variable "memory_size" {
   type = number
 
-  description = "The amount of memory (in MB) available to the function at runtime. Increasing the Lambda function memory also increases its CPU allocation."
+  description = <<EOS
+The amount of memory (in MB) available to the function at runtime. Increasing the Lambda function memory also increases its CPU allocation.
+EOS
 }
 
 variable "reserved_concurrent_executions" {
   type = number
 
-  description = "The number of simultaneous executions to reserve for the Lambda function."
+  description = <<EOS
+The number of simultaneous executions to reserve for the Lambda function.
+EOS
 }
 
 variable "runtime" {
   type = string
 
-  description = "The identifier of the Lambda function [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)."
+  description = <<EOS
+The identifier of the Lambda function [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
+EOS
 }
 
 variable "secret_environment_variables" {
@@ -82,20 +102,26 @@ variable "source_dir" {
   type    = string
   default = null
 
-  description = "Path of the directory which shall be packed as code of the Lambda function. Conflicts with `archive_file`."
+  description = <<EOS
+Path of the directory which shall be packed as code of the Lambda function. Conflicts with `archive_file`.
+EOS
 }
 
 variable "tags" {
   type    = map(string)
   default = {}
 
-  description = "Tags which will be assigned to all resources."
+  description = <<EOS
+Map of tags assigned to all AWS resources created by this module.
+EOS
 }
 
 variable "timeout" {
   type = number
 
-  description = "The amount of time (in seconds) per execution before stopping it."
+  description = <<EOS
+The amount of time (in seconds) per execution before stopping it.
+EOS
 }
 
 variable "vpc_config" {
@@ -106,12 +132,10 @@ variable "vpc_config" {
         id  = string
       })
     )
-
     vpc = object({
       id = string
     })
   })
-
   default = null
 
   description = <<EOS