Merge pull request #38 from virtualroot/feat/yaml-source-of-truth

Use tools.yaml as source of truth

Author: virtualroot

CLAUDE.md

@@ -0,0 +1,37 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**CanI.TF** is a static website comparing features between OpenTofu and Terraform. It exposes both an HTML comparison table and a JSON API at `/tools.json`.
+
+## Development Workflow
+
+Adding or updating features requires two steps:
+
+1. Edit `tools/tools.yaml` — this is the source of truth (feature-centric: each feature lists per-tool data under a `tools:` map)
+2. Run `go run main.go` to validate and regenerate `data/tools.json` and `static/tools.json`
+
+To preview the site locally:
+```bash
+hugo server --buildDrafts --disableFastRender
+```
+
+Hugo version is pinned via `.tool-versions` (hugo 0.135.0). Install with `asdf install`.
+
+## Architecture
+
+- **`tools/tools.yaml`** — YAML source of truth. Feature-centric: a top-level `tools:` map holds metadata per tool, and a top-level `features:` list holds each feature with per-tool data under a `tools:` map. Omitting a tool key means that tool doesn't support the feature.
+- **`main.go`** — reads `tools/tools.yaml`, defines the JSON schema, validates the data, and writes `data/tools.json` + `static/tools.json`.
+- **`data/tools.json`** — consumed by Hugo templates at build time.
+- **`static/tools.json`** — served directly as the public API.
+- **`layouts/`** — Hugo templates. `_default/baseof.html` is the shell; `index.html` renders the comparison table by iterating the tools data.
+
+## 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 `-`.
+
+## Deployment
+
+Pushing to `main` triggers `.github/workflows/hugo.yml`, which builds with Hugo and deploys to GitHub Pages automatically.

data/tools.json

@@ -13,8 +13,8 @@
       },
       {
         "name": "State encryption",
-        "url": "https://opentofu.org/docs/language/state/encryption/",
-        "version": "1.7"
+        "version": "1.7",
+        "url": "https://opentofu.org/docs/language/state/encryption/"
       },
       {
         "name": "Removed block",
@@ -128,6 +128,16 @@
         "name": "Provider-defined functions",
         "version": "1.8"
       },
+      {
+        "name": "Loopable import blocks",
+        "version": "1.7",
+        "url": "https://developer.hashicorp.com/terraform/language/v1.7.x/import#import-multiple-instances-with-for_each"
+      },
+      {
+        "name": "templatefile() and templatestring() recursion",
+        "version": "1.9",
+        "url": "https://developer.hashicorp.com/terraform/language/functions/templatestring"
+      },
       {
         "name": "Provider mocking",
         "version": "1.7"
@@ -137,30 +147,20 @@
         "version": "1.7"
       },
       {
-        "name": "templatefile() and templatestring() recursion",
-        "version": "1.9",
-        "url": "https://developer.hashicorp.com/terraform/language/functions/templatestring"
+        "name": "S3 native state locking",
+        "version": "1.10",
+        "url": "https://developer.hashicorp.com/terraform/language/v1.10.x/upgrade-guides#s3-backend"
       },
       {
         "name": "Ephemeral values and resources",
         "version": "1.10",
         "url": "https://developer.hashicorp.com/terraform/language/resources/ephemeral"
       },
-      {
-        "name": "S3 native state locking",
-        "version": "1.10",
-        "url": "https://developer.hashicorp.com/terraform/language/v1.10.x/upgrade-guides#s3-backend"
-      },
       {
         "name": "Write-only attributes",
         "version": "1.11",
         "url": "https://developer.hashicorp.com/terraform/language/resources/ephemeral/write-only"
       },
-      {
-        "name": "Loopable import blocks",
-        "version": "1.7",
-        "url": "https://developer.hashicorp.com/terraform/language/v1.7.x/import#import-multiple-instances-with-for_each"
-      },
       {
         "name": "Import via identity attribute",
         "version": "1.12",

go.mod

@@ -4,4 +4,7 @@ go 1.23.1
 
 require github.com/qri-io/jsonschema v0.2.1
 
-require github.com/qri-io/jsonpointer v0.1.1 // indirect
+require (
+	github.com/qri-io/jsonpointer v0.1.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -8,3 +8,6 @@ github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=