feat: adds terraform-docs as a linter 📄

README.md

@@ -85,7 +85,7 @@ trunk check enable {linter}
 | SQL             | [sqlfluff], [sqlfmt], [sql-formatter], [squawk]                                                                          |
 | SVG             | [svgo]                                                                                                                   |
 | Swift           | [stringslint], [swiftlint], [swiftformat]                                                                                |
-| Terraform       | [terraform] (validate and fmt), [checkov], [tflint], [tfsec], [terrascan], [tofu]                                        |
+| Terraform       | [terraform] (validate and fmt), [checkov], [tflint], [tfsec], [terrascan], [tofu], [terraform-docs]                      |
 | Terragrunt      | [terragrunt]                                                                                                             |
 | Textproto       | [txtpbfmt]                                                                                                               |
 | TOML            | [taplo]                                                                                                                  |
@@ -188,6 +188,7 @@ trunk check enable {linter}
 [terraform]: https://developer.hashicorp.com/terraform/cli/code
 [tofu]: https://opentofu.org/
 [terragrunt]: https://terragrunt.gruntwork.io/docs/getting-started/quick-start/
+[terraform-docs]: https://terraform-docs.io/
 [tflint]: https://github.com/terraform-linters/tflint#readme
 [tfsec]: https://github.com/aquasecurity/tfsec
 [trivy]: https://trunk.io/linters/security/trivy

linters/terraform-docs/plugin.yaml

@@ -0,0 +1,21 @@
+version: 0.1
+lint:
+  definitions:
+    - name: terraform-docs
+      files: [terraform]
+      main_tool: terraform-docs
+      description: Generate terraform + tofu module documentation
+      commands:
+        - name: terraform-docs
+          output: rewrite
+          formatter: true
+          run_from: ${target_directory}
+          run: terraform-docs markdown --output-file=README.md .
+          read_output_from: stdout
+          stdin: true
+          success_codes: [0]
+      suggest_if: never
+      known_good_version: 0.16.0
+      version_command:
+        parse_regex: ${semver}
+        run: terraform-docs --version

linters/terraform-docs/terraform-docs.test.ts

@@ -0,0 +1,3 @@
+import { linterFmtTest } from "tests";
+
+linterFmtTest({ linterName: "terraform-docs" });

linters/terraform-docs/test_data/README.md

@@ -0,0 +1,4 @@
+# This is a test of the emergency broadcast system
+
+<!-- BEGIN_TF_DOCS -->
+<!-- END_TF_DOCS -->

linters/terraform-docs/test_data/terraform_docs_v0.16.0_variables.fmt.shot

@@ -0,0 +1,6 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing formatter terraform-docs test variables 1`] = `
+"README.md updated successfully
+"
+`;

linters/terraform-docs/test_data/variables.in.tf

@@ -0,0 +1,5 @@
+variable "testing" {
+  type = string
+  default = "Hello world"
+  description = "This is a test of the emergency broadcast system"
+}