feat: Shorten outputs (removing this_) (#34)

antonbabenko · web-flow · commit 885fa6013790 · 2021-04-26T20:53:42.000+02:00
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -7,30 +7,30 @@ on:
       - master
 
 jobs:
-# Min Terraform version(s)
+  # Min Terraform version(s)
   getDirectories:
-      name: Get root directories
-      runs-on: ubuntu-latest
-      steps:
-          - name: Checkout
-            uses: actions/checkout@v2
-          - name: Install Python
-            uses: actions/setup-python@v2
-          - name: Build matrix
-            id: matrix
-            run: |
-              DIRS=$(python -c "import json; import glob; print(json.dumps([x.replace('/versions.tf', '') for x in glob.glob('./**/versions.tf', recursive=True)]))")
-              echo "::set-output name=directories::$DIRS"
-      outputs:
-          directories: ${{ steps.matrix.outputs.directories }}
+    name: Get root directories
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Python
+        uses: actions/setup-python@v2
+      - name: Build matrix
+        id: matrix
+        run: |
+          DIRS=$(python -c "import json; import glob; print(json.dumps([x.replace('/versions.tf', '') for x in glob.glob('./**/versions.tf', recursive=True)]))")
+          echo "::set-output name=directories::$DIRS"
+    outputs:
+      directories: ${{ steps.matrix.outputs.directories }}
 
   preCommitMinVersions:
     name: Min TF validate
     needs: getDirectories
     runs-on: ubuntu-latest
     strategy:
-        matrix:
-            directory: ${{ fromJson(needs.getDirectories.outputs.directories) }}
+      matrix:
+        directory: ${{ fromJson(needs.getDirectories.outputs.directories) }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -59,7 +59,7 @@ jobs:
           pre-commit run terraform_validate --color=always --show-diff-on-failure --files $(ls *.tf)
 
 
-# Max Terraform version
+  # Max Terraform version
   getBaseVersion:
     name: Module max TF version
     runs-on: ubuntu-latest
@@ -94,7 +94,7 @@ jobs:
       - name: Install pre-commit dependencies
         run: |
           pip install pre-commit
-          curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.0-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
+          curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12\..+?-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
           curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
       - name: Execute pre-commit
         # Run all pre-commit checks on max version supported
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: git://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.48.0
+    rev: v1.50.0
     hooks:
       - id: terraform_fmt
       - id: terraform_validate
diff --git a/README.md b/README.md
@@ -2,10 +2,6 @@
 
 Terraform module to create a DynamoDB table.
 
-This type of resources supported:
-
-* [DynamoDB table](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html)
-
 ## Terraform versions
 
 Terraform 0.12 or newer is supported.
@@ -108,10 +104,10 @@ No modules.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_this_dynamodb_table_arn"></a> [this\_dynamodb\_table\_arn](#output\_this\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
-| <a name="output_this_dynamodb_table_id"></a> [this\_dynamodb\_table\_id](#output\_this\_dynamodb\_table\_id) | ID of the DynamoDB table |
-| <a name="output_this_dynamodb_table_stream_arn"></a> [this\_dynamodb\_table\_stream\_arn](#output\_this\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
-| <a name="output_this_dynamodb_table_stream_label"></a> [this\_dynamodb\_table\_stream\_label](#output\_this\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_arn"></a> [dynamodb\_table\_arn](#output\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
+| <a name="output_dynamodb_table_id"></a> [dynamodb\_table\_id](#output\_dynamodb\_table\_id) | ID of the DynamoDB table |
+| <a name="output_dynamodb_table_stream_arn"></a> [dynamodb\_table\_stream\_arn](#output\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_stream_label"></a> [dynamodb\_table\_stream\_label](#output\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Authors
diff --git a/examples/autoscaling/README.md b/examples/autoscaling/README.md
@@ -50,8 +50,8 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_this_dynamodb_table_arn"></a> [this\_dynamodb\_table\_arn](#output\_this\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
-| <a name="output_this_dynamodb_table_id"></a> [this\_dynamodb\_table\_id](#output\_this\_dynamodb\_table\_id) | ID of the DynamoDB table |
-| <a name="output_this_dynamodb_table_stream_arn"></a> [this\_dynamodb\_table\_stream\_arn](#output\_this\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
-| <a name="output_this_dynamodb_table_stream_label"></a> [this\_dynamodb\_table\_stream\_label](#output\_this\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_arn"></a> [dynamodb\_table\_arn](#output\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
+| <a name="output_dynamodb_table_id"></a> [dynamodb\_table\_id](#output\_dynamodb\_table\_id) | ID of the DynamoDB table |
+| <a name="output_dynamodb_table_stream_arn"></a> [dynamodb\_table\_stream\_arn](#output\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_stream_label"></a> [dynamodb\_table\_stream\_label](#output\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/autoscaling/outputs.tf b/examples/autoscaling/outputs.tf
@@ -1,19 +1,19 @@
-output "this_dynamodb_table_arn" {
+output "dynamodb_table_arn" {
   description = "ARN of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_arn
+  value       = module.dynamodb_table.dynamodb_table_arn
 }
 
-output "this_dynamodb_table_id" {
+output "dynamodb_table_id" {
   description = "ID of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_id
+  value       = module.dynamodb_table.dynamodb_table_id
 }
 
-output "this_dynamodb_table_stream_arn" {
+output "dynamodb_table_stream_arn" {
   description = "The ARN of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_arn
+  value       = module.dynamodb_table.dynamodb_table_stream_arn
 }
 
-output "this_dynamodb_table_stream_label" {
+output "dynamodb_table_stream_label" {
   description = "A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_label
+  value       = module.dynamodb_table.dynamodb_table_stream_label
 }
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -50,8 +50,8 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_this_dynamodb_table_arn"></a> [this\_dynamodb\_table\_arn](#output\_this\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
-| <a name="output_this_dynamodb_table_id"></a> [this\_dynamodb\_table\_id](#output\_this\_dynamodb\_table\_id) | ID of the DynamoDB table |
-| <a name="output_this_dynamodb_table_stream_arn"></a> [this\_dynamodb\_table\_stream\_arn](#output\_this\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
-| <a name="output_this_dynamodb_table_stream_label"></a> [this\_dynamodb\_table\_stream\_label](#output\_this\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_arn"></a> [dynamodb\_table\_arn](#output\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
+| <a name="output_dynamodb_table_id"></a> [dynamodb\_table\_id](#output\_dynamodb\_table\_id) | ID of the DynamoDB table |
+| <a name="output_dynamodb_table_stream_arn"></a> [dynamodb\_table\_stream\_arn](#output\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_stream_label"></a> [dynamodb\_table\_stream\_label](#output\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/basic/outputs.tf b/examples/basic/outputs.tf
@@ -1,19 +1,19 @@
-output "this_dynamodb_table_arn" {
+output "dynamodb_table_arn" {
   description = "ARN of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_arn
+  value       = module.dynamodb_table.dynamodb_table_arn
 }
 
-output "this_dynamodb_table_id" {
+output "dynamodb_table_id" {
   description = "ID of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_id
+  value       = module.dynamodb_table.dynamodb_table_id
 }
 
-output "this_dynamodb_table_stream_arn" {
+output "dynamodb_table_stream_arn" {
   description = "The ARN of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_arn
+  value       = module.dynamodb_table.dynamodb_table_stream_arn
 }
 
-output "this_dynamodb_table_stream_label" {
+output "dynamodb_table_stream_label" {
   description = "A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_label
+  value       = module.dynamodb_table.dynamodb_table_stream_label
 }
diff --git a/examples/global-tables/README.md b/examples/global-tables/README.md
@@ -49,8 +49,8 @@ No inputs.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_this_dynamodb_table_arn"></a> [this\_dynamodb\_table\_arn](#output\_this\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
-| <a name="output_this_dynamodb_table_id"></a> [this\_dynamodb\_table\_id](#output\_this\_dynamodb\_table\_id) | ID of the DynamoDB table |
-| <a name="output_this_dynamodb_table_stream_arn"></a> [this\_dynamodb\_table\_stream\_arn](#output\_this\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
-| <a name="output_this_dynamodb_table_stream_label"></a> [this\_dynamodb\_table\_stream\_label](#output\_this\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_arn"></a> [dynamodb\_table\_arn](#output\_dynamodb\_table\_arn) | ARN of the DynamoDB table |
+| <a name="output_dynamodb_table_id"></a> [dynamodb\_table\_id](#output\_dynamodb\_table\_id) | ID of the DynamoDB table |
+| <a name="output_dynamodb_table_stream_arn"></a> [dynamodb\_table\_stream\_arn](#output\_dynamodb\_table\_stream\_arn) | The ARN of the Table Stream. Only available when var.stream\_enabled is true |
+| <a name="output_dynamodb_table_stream_label"></a> [dynamodb\_table\_stream\_label](#output\_dynamodb\_table\_stream\_label) | A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream\_enabled is true |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/global-tables/outputs.tf b/examples/global-tables/outputs.tf
@@ -1,19 +1,19 @@
-output "this_dynamodb_table_arn" {
+output "dynamodb_table_arn" {
   description = "ARN of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_arn
+  value       = module.dynamodb_table.dynamodb_table_arn
 }
 
-output "this_dynamodb_table_id" {
+output "dynamodb_table_id" {
   description = "ID of the DynamoDB table"
-  value       = module.dynamodb_table.this_dynamodb_table_id
+  value       = module.dynamodb_table.dynamodb_table_id
 }
 
-output "this_dynamodb_table_stream_arn" {
+output "dynamodb_table_stream_arn" {
   description = "The ARN of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_arn
+  value       = module.dynamodb_table.dynamodb_table_stream_arn
 }
 
-output "this_dynamodb_table_stream_label" {
+output "dynamodb_table_stream_label" {
   description = "A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream_enabled is true"
-  value       = module.dynamodb_table.this_dynamodb_table_stream_label
+  value       = module.dynamodb_table.dynamodb_table_stream_label
 }
diff --git a/outputs.tf b/outputs.tf
@@ -1,19 +1,19 @@
-output "this_dynamodb_table_arn" {
+output "dynamodb_table_arn" {
   description = "ARN of the DynamoDB table"
   value       = element(concat(aws_dynamodb_table.this.*.arn, [""]), 0)
 }
 
-output "this_dynamodb_table_id" {
+output "dynamodb_table_id" {
   description = "ID of the DynamoDB table"
   value       = element(concat(aws_dynamodb_table.this.*.id, [""]), 0)
 }
 
-output "this_dynamodb_table_stream_arn" {
+output "dynamodb_table_stream_arn" {
   description = "The ARN of the Table Stream. Only available when var.stream_enabled is true"
   value       = var.stream_enabled ? concat(aws_dynamodb_table.this.*.stream_arn, [""])[0] : null
 }
 
-output "this_dynamodb_table_stream_label" {
+output "dynamodb_table_stream_label" {
   description = "A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream_enabled is true"
   value       = var.stream_enabled ? concat(aws_dynamodb_table.this.*.stream_label, [""])[0] : null
 }

Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,19 @@`
`1`		`-output "this_dynamodb_table_arn" {`
	`1`	`+output "dynamodb_table_arn" {`
`2`	`2`	`description = "ARN of the DynamoDB table"`
`3`	`3`	`value = element(concat(aws_dynamodb_table.this.*.arn, [""]), 0)`
`4`	`4`	`}`
`5`	`5`
`6`		`-output "this_dynamodb_table_id" {`
	`6`	`+output "dynamodb_table_id" {`
`7`	`7`	`description = "ID of the DynamoDB table"`
`8`	`8`	`value = element(concat(aws_dynamodb_table.this.*.id, [""]), 0)`
`9`	`9`	`}`
`10`	`10`
`11`		`-output "this_dynamodb_table_stream_arn" {`
	`11`	`+output "dynamodb_table_stream_arn" {`
`12`	`12`	`description = "The ARN of the Table Stream. Only available when var.stream_enabled is true"`
`13`	`13`	`value = var.stream_enabled ? concat(aws_dynamodb_table.this.*.stream_arn, [""])[0] : null`
`14`	`14`	`}`
`15`	`15`
`16`		`-output "this_dynamodb_table_stream_label" {`
	`16`	`+output "dynamodb_table_stream_label" {`
`17`	`17`	`description = "A timestamp, in ISO 8601 format of the Table Stream. Only available when var.stream_enabled is true"`
`18`	`18`	`value = var.stream_enabled ? concat(aws_dynamodb_table.this.*.stream_label, [""])[0] : null`
`19`	`19`	`}`