chore: add support for terrafmt (#3085)

Author: remyleone

.github/workflows/terrafmt.yml

@@ -0,0 +1,17 @@
+name: Run terrafmt
+on:
+  pull_request:
+  push:
+  merge_group:
+
+jobs:
+  terrafmt:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout should always be before setup-go to ensure caching is working
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.24.0
+      - name: Run terrafmt on documentation
+        run: go tool terrafmt fmt --verbose --check ./docs

docs/data-sources/account_ssh_key.md

@@ -20,7 +20,7 @@ The following commands allow you to:
 ```hcl
 # Get info by SSH key name
 data "scaleway_account_ssh_key" "my_key" {
-  name  = "my-key-name"
+  name = "my-key-name"
 }
 
 # Get info by SSH key id

docs/data-sources/baremetal_easy_partitioning.md

@@ -13,47 +13,47 @@ This data source simplifies the process of generating valid partitioning configu
 
 ```hcl
 data "scaleway_easy_partitioning" "default" {
-  offer_id          = "11111111-1111-1111-1111-111111111111"
-  os_id             = "22222222-2222-2222-2222-222222222222"
-  swap              = true
-  extra_partition   = true
-  ext_4_mountpoint  = "/data"
+  offer_id         = "11111111-1111-1111-1111-111111111111"
+  os_id            = "22222222-2222-2222-2222-222222222222"
+  swap             = true
+  extra_partition  = true
+  ext_4_mountpoint = "/data"
 }
 ```
 
 ```hcl
 data "scaleway_baremetal_offer" "my_offer" {
-    zone = "fr-par-1"
-    name = "EM-B220E-NVME"
+  zone = "fr-par-1"
+  name = "EM-B220E-NVME"
 }
 
 data "scaleway_baremetal_os" "my_os" {
-    zone    = "fr-par-1"
-    name    = "Ubuntu"
-    version = "22.04 LTS (Jammy Jellyfish)"
+  zone    = "fr-par-1"
+  name    = "Ubuntu"
+  version = "22.04 LTS (Jammy Jellyfish)"
 }
 
 resource "scaleway_iam_ssh_key" "main" {
-    name       = "my-ssh-key"
-    public_key = "my-ssh-key-public"
+  name       = "my-ssh-key"
+  public_key = "my-ssh-key-public"
 }
 
 data "scaleway_baremetal_easy_partitioning" "test" {
-    offer_id          = data.scaleway_baremetal_offer.my_offer.offer_id
-    os_id             = data.scaleway_baremetal_os.my_os.os_id
-    swap              = false
-    ext_4_mountpoint  = "/hello"
+  offer_id         = data.scaleway_baremetal_offer.my_offer.offer_id
+  os_id            = data.scaleway_baremetal_os.my_os.os_id
+  swap             = false
+  ext_4_mountpoint = "/hello"
 }
 
 resource "scaleway_baremetal_server" "base" {
-    name         = "my-baremetal-server"
-    zone         = "fr-par-1"
-    description  = "test a description"
-    offer        = data.scaleway_baremetal_offer.my_offer.offer_id
-    os           = data.scaleway_baremetal_os.my_os.os_id
-    partitioning = data.scaleway_baremetal_easy_partitioning.test.json_partition
-    tags         = ["terraform-test", "scaleway_baremetal_server", "minimal", "edited"]
-    ssh_key_ids  = [scaleway_iam_ssh_key.main.id]
+  name         = "my-baremetal-server"
+  zone         = "fr-par-1"
+  description  = "test a description"
+  offer        = data.scaleway_baremetal_offer.my_offer.offer_id
+  os           = data.scaleway_baremetal_os.my_os.os_id
+  partitioning = data.scaleway_baremetal_easy_partitioning.test.json_partition
+  tags         = ["terraform-test", "scaleway_baremetal_server", "minimal", "edited"]
+  ssh_key_ids  = [scaleway_iam_ssh_key.main.id]
 }
 ```
 
@@ -75,4 +75,4 @@ In addition to all above arguments, the following attributes are exported:
 
 - `id` — A composite identifier derived from offer_id and os_id.
 
-- `json_partition` — A validated partitioning schema in JSON format that can be directly used for BareMetal server deployment.
+- `json_partition` — A validated partitioning schema in JSON format that can be directly used for BareMetal server deployment.

docs/data-sources/baremetal_os.md

@@ -15,7 +15,7 @@ You can also use the [scaleway-cli](https://github.com/scaleway/scaleway-cli) wi
 ```hcl
 # Get info by os name and version
 data "scaleway_baremetal_os" "by_name" {
-  name = "Ubuntu"
+  name    = "Ubuntu"
   version = "20.04 LTS (Focal Fossa)"
 }
 

docs/data-sources/billing_consumptions.md

@@ -33,4 +33,4 @@ In addition to all arguments above, the following attributes are exported:
     - `unit` - The unit of consumed quantity.
     - `billed_quantity` - The consumed quantity.
     - `project_id` - The project ID of the consumption.
-- `updated_at` - The last consumption update date.
+- `updated_at` - The last consumption update date.

docs/data-sources/block_snapshot.md

@@ -25,7 +25,7 @@ data "scaleway_block_snapshot" "my_snapshot" {
 
 // Get info by snapshot name and volume id
 data "scaleway_block_snapshot" "my_snapshot" {
-  name = "my-name"
+  name      = "my-name"
   volume_id = "11111111-1111-1111-1111-111111111111"
 }
 

docs/data-sources/cockpit_source.md

@@ -17,7 +17,7 @@ The following example retrieves a Cockpit data source by its unique ID.
 
 ```terraform
 data "scaleway_cockpit_source" "example" {
-    id = "fr-par/11111111-1111-1111-1111-111111111111"
+  id = "fr-par/11111111-1111-1111-1111-111111111111"
 }
 ```
 
@@ -27,9 +27,9 @@ You can also retrieve a data source by specifying filtering criteria such as `na
 
 ```terraform
 data "scaleway_cockpit_source" "filtered" {
-    project_id = "11111111-1111-1111-1111-111111111111"
-    region     = "fr-par"
-    name       = "my-data-source"
+  project_id = "11111111-1111-1111-1111-111111111111"
+  region     = "fr-par"
+  name       = "my-data-source"
 }
 ```
 

docs/data-sources/container.md

@@ -22,20 +22,20 @@ resource scaleway_container_namespace main {
 }
 
 resource scaleway_container main {
-    name = "test-container-data"
-    namespace_id = scaleway_container_namespace.main.id
+  name         = "test-container-data"
+  namespace_id = scaleway_container_namespace.main.id
 }
 
 // Get info by container name
 data "scaleway_container" "by_name" {
-    namespace_id = scaleway_container_namespace.main.id
-    name = scaleway_container.main.name
+  namespace_id = scaleway_container_namespace.main.id
+  name         = scaleway_container.main.name
 }
 
 // Get info by container ID
 data "scaleway_container" "by_id" {
-    namespace_id = scaleway_container_namespace.main.id
-    container_id = scaleway_container.main.id
+  namespace_id = scaleway_container_namespace.main.id
+  container_id = scaleway_container.main.id
 }
 ```
 

docs/data-sources/flexible_ips.md

@@ -12,7 +12,7 @@ Gets information about multiple Flexible IPs.
 ```hcl
 # Find ips that share the same tags
 data "scaleway_flexible_ips" "fips_by_tags" {
-  tags = [ "a tag" ]
+  tags = ["a tag"]
 }
 
 # Find ips that share the same Server ID
@@ -21,19 +21,19 @@ data "scaleway_baremetal_offer" "my_offer" {
 }
 
 resource "scaleway_baremetal_server" "base" {
-  name  = "MyServer"
-  offer = data.scaleway_baremetal_offer.my_offer.offer_id
-  install_config_afterward  = true
+  name                     = "MyServer"
+  offer                    = data.scaleway_baremetal_offer.my_offer.offer_id
+  install_config_afterward = true
 }
 
 resource "scaleway_flexible_ip" "first" {
   server_id = scaleway_baremetal_server.base.id
-  tags = [ "foo", "first" ]
+  tags      = ["foo", "first"]
 }
 
 resource "scaleway_flexible_ip" "second" {
   server_id = scaleway_baremetal_server.base.id
-  tags = [ "foo", "second" ]
+  tags      = ["foo", "second"]
 }
 
 data "scaleway_flexible_ips" "fips_by_server_id" {

docs/data-sources/function.md

@@ -21,13 +21,13 @@ The following commands allow you to:
 ```terraform
 // Get info by function name
 data "scaleway_function" "my_function" {
-  name = "my-namespace-name"
+  name         = "my-namespace-name"
   namespace_id = "11111111-1111-1111-1111-111111111111"
 }
 
 // Get info by function ID
 data "scaleway_function" "my_function" {
-  function_id = "11111111-1111-1111-1111-111111111111"
+  function_id  = "11111111-1111-1111-1111-111111111111"
   namespace_id = "11111111-1111-1111-1111-111111111111"
 }
 ```