Merge pull request #39 from virtualroot/feat/feature-request-url

Add featureRequestURL support for yet to be features

Author: virtualroot

CLAUDE.md

@@ -30,7 +30,7 @@ Hugo version is pinned via `.tool-versions` (hugo 0.135.0). Install with `asdf i
 
 ## Data Schema
 
-Each tool entry has: `version`, `versionURL`, `license`, `licenseURL`, `registry`, and `features[]`. Each feature has `name`, `version`, and optional `url`. Feature names are matched by string equality across tools to build the comparison table — a feature present in one tool but not the other renders as `-`.
+Each tool entry has: `version`, `versionURL`, `license`, `licenseURL`, `registry`, and `features[]`. Each feature has `name` (required), and optional `version`, `url`, and `featureRequestURL`. Feature names are matched by string equality across tools to build the comparison table — a feature present in one tool but not the other renders as `-`. A `featureRequestURL` with no `version` renders as a `?` link.
 
 ## Deployment
 

README.md

@@ -4,17 +4,75 @@ As time passes, OpenTofu and Terraform become more distant from each other. [Can
 
 ## Add new features
 
-To add new features, edit the JSON in the tool's variable inside `main.go`.
-The entry should include the feature's name, the released version, and an optionable URL to its documentation.
-If the entry is valid for both tools, use the same name.
-Run `go run main.go` to validate the changes against the schema and replace the source of truth `data/tools.json`.
+The `tools/tools.yaml` file is the source of truth. Then run `go run main.go` to validate and regenerate `data/tools.json` and `static/tools.json`.
+
+### `tools/tools.yaml` structure
+
+The file has two top-level keys:
+
+#### `tools`
+
+Metadata for each tool. Displayed in the header rows of the comparison table.
+
+```yaml
+tools:
+  opentofu:
+    version: "1.11"
+    versionURL: https://github.com/opentofu/opentofu/releases/latest
+    license: MPL-2.0
+    licenseURL: https://github.com/opentofu/opentofu/blob/main/LICENSE
+    registry: https://search.opentofu.org/
+```
+
+#### `features`
+
+Each tool entry under a feature supports three optional fields:
+
+| Field               | Description                                                                 |
+|---------------------|-----------------------------------------------------------------------------|
+| `version`           | The version that introduced the feature (e.g. `"1.9"`).                    |
+| `url`               | URL to the feature's documentation. Renders the version as a link.         |
+| `featureRequestURL` | URL to an open issue or RFC tracking the feature. Renders as a `?` link when the feature is not yet supported (i.e. no `version`). |
+
+**Feature supported by both tools:**
+```yaml
+- name: State encryption
+  tools:
+    opentofu:
+      version: "1.7"
+      url: https://opentofu.org/docs/language/state/encryption/
+    terraform:
+      version: "1.9"
+      url: https://developer.hashicorp.com/terraform/language/state/encryption
+```
+
+**Feature supported by one tool only (renders `-` for the other):**
+```yaml
+- name: State encryption
+  tools:
+    opentofu:
+      version: "1.7"
+      url: https://opentofu.org/docs/language/state/encryption/
+```
+
+**Feature not yet supported, with a tracking link:**
+```yaml
+- name: Some upcoming feature
+  tools:
+    opentofu:
+      version: "1.9"
+      url: https://opentofu.org/docs/...
+    terraform:
+      featureRequestURL: https://github.com/hashicorp/terraform/issues/123
+```
 
 ## Local development
 
 ```
 $ # Install hugo
 $ asdf plugin add hugo
 $ asdf install
-$ # hugo server --buildDrafts --disableFastRender
-$ # HTML in layouts/_default
+$ go run main.go
+$ hugo server --buildDrafts --disableFastRender
+$ # HTML templates are in layouts/_default
 ```

data/tools.json

@@ -183,4 +183,4 @@
       }
     ]
   }
-}
+}

layouts/_default/home.html

@@ -51,17 +51,25 @@ <h1><a href="https://cani.tf/">Can I TF</a></h1>
             <td>{{ $opentofuFeature.name }}</td>
             {{- if $opentofuFeature.url }}
             <td><a href="{{ $opentofuFeature.url }}">{{ $opentofuFeature.version }}</a></td>
-            {{ else }}
+            {{ else if $opentofuFeature.version }}
             <td>{{ $opentofuFeature.version }}</td>
+            {{ else if $opentofuFeature.featureRequestURL }}
+            <td><a href="{{ $opentofuFeature.featureRequestURL }}">?</a></td>
+            {{ else }}
+            <td>-</td>
             {{ end -}}
 
             {{- /* Check for matching Terraform feature */ -}}
             {{- if gt (len $matchingTerraformFeatures) 0 -}}
             {{- $matchingTerraformFeature := index $matchingTerraformFeatures 0 -}}
             {{- if $matchingTerraformFeature.url }}
             <td><a href="{{ $matchingTerraformFeature.url }}">{{ $matchingTerraformFeature.version }}</a></td>
-            {{ else }}
+            {{ else if $matchingTerraformFeature.version }}
             <td>{{ $matchingTerraformFeature.version }}</td>
+            {{ else if $matchingTerraformFeature.featureRequestURL }}
+            <td><a href="{{ $matchingTerraformFeature.featureRequestURL }}">?</a></td>
+            {{ else }}
+            <td>-</td>
             {{ end -}}
             {{ else -}}
             <td>-</td>
@@ -80,7 +88,15 @@ <h1><a href="https://cani.tf/">Can I TF</a></h1>
           <tr>
             <td>{{ $terraformFeature.name }}</td>
             <td>-</td>
+            {{- if $terraformFeature.url }}
             <td><a href="{{ $terraformFeature.url }}">{{ $terraformFeature.version }}</a></td>
+            {{ else if $terraformFeature.version }}
+            <td>{{ $terraformFeature.version }}</td>
+            {{ else if $terraformFeature.featureRequestURL }}
+            <td><a href="{{ $terraformFeature.featureRequestURL }}">?</a></td>
+            {{ else }}
+            <td>-</td>
+            {{ end }}
           </tr>
           {{ end -}}
           {{ end -}}

main.go

@@ -52,9 +52,13 @@ var schemaData = []byte(`{
               "version": {
                 "type": "string",
                 "maxLength": 4
+              },
+              "featureRequestURL": {
+                "type": "string",
+                "format": "uri"
               }
             },
-            "required": ["name", "version"]
+            "required": ["name"]
           }
         }
       },
@@ -64,9 +68,10 @@ var schemaData = []byte(`{
 }`)
 
 type Feature struct {
-	Name    string `json:"name" yaml:"name"`
-	Version string `json:"version" yaml:"version"`
-	URL     string `json:"url,omitempty" yaml:"url,omitempty"`
+	Name              string `json:"name" yaml:"name"`
+	Version           string `json:"version,omitempty" yaml:"version,omitempty"`
+	URL               string `json:"url,omitempty" yaml:"url,omitempty"`
+	FeatureRequestURL string `json:"featureRequestURL,omitempty" yaml:"featureRequestURL,omitempty"`
 }
 
 type Tool struct {
@@ -87,8 +92,9 @@ type ToolMeta struct {
 }
 
 type FeatureToolData struct {
-	Version string `yaml:"version"`
-	URL     string `yaml:"url,omitempty"`
+	Version           string `yaml:"version,omitempty"`
+	URL               string `yaml:"url,omitempty"`
+	FeatureRequestURL string `yaml:"featureRequestURL,omitempty"`
 }
 
 type FeatureEntry struct {
@@ -124,7 +130,7 @@ func main() {
 	for _, f := range tf.Features {
 		for toolName, fd := range f.Tools {
 			t := tools[toolName]
-			t.Features = append(t.Features, Feature{Name: f.Name, Version: fd.Version, URL: fd.URL})
+			t.Features = append(t.Features, Feature{Name: f.Name, Version: fd.Version, URL: fd.URL, FeatureRequestURL: fd.FeatureRequestURL})
 			tools[toolName] = t
 		}
 	}

static/tools.json

@@ -183,4 +183,4 @@
       }
     ]
   }
-}
+}