@yosr-ai/template-spring 0.0.0-stage → 0.2.5

package/seed.template.json

@@ -0,0 +1,711 @@
+{
+  "$schema": "../engine/schemas/seed.template.schema.json",
+  "schemaVersion": "0.1",
+  "name": "spring",
+  "version": "0.2.5",
+  "title": "Spring Boot (API only)",
+  "description": "Yosr Seed's API-only Spring Boot template (ADR 0027): Java 25, Spring Boot 4.1.2, JUnit 5 + MockMvc, locked Maven resolve, notes CRUD. Defaults to Postgres via Spring Data JPA; base tree is in-memory.",
+  "license": "MIT",
+  "authors": ["Yosr Seed"],
+  "keywords": [
+    "spring",
+    "spring-boot",
+    "java",
+    "jpa",
+    "postgresql",
+    "junit",
+    "mockmvc",
+    "maven"
+  ],
+  "engines": {
+    "yosr": ">=0.2.0 <0.3.0",
+    "java": ">=25"
+  },
+  "stack": {
+    "framework": "spring-boot",
+    "language": "java",
+    "includes": ["spring-web", "junit5", "mockmvc", "data-jpa", "postgresql"]
+  },
+  "packageManagers": {
+    "default": "maven",
+    "supported": ["maven"]
+  },
+  "variables": {
+    "authLabel": {
+      "fromOption": "auth",
+      "map": {
+        "none": "none (open API)",
+        "api-key": "single API key (X-API-Key header)"
+      }
+    },
+    "storageLabel": {
+      "fromOption": "database",
+      "map": {
+        "none": "memory only (no database)",
+        "postgres": "Postgres (Spring Data JPA)"
+      }
+    },
+    "databaseUrl": {
+      "fromOption": "database",
+      "map": {
+        "postgres": "postgresql://postgres:postgres@localhost:5432/postgres"
+      }
+    },
+    "deploy": {
+      "fromOption": "deploy",
+      "map": {
+        "none": "decide later",
+        "docker": "Docker (multi-stage, non-root)"
+      }
+    }
+  },
+  "options": [
+    {
+      "id": "projectName",
+      "type": "string",
+      "label": {
+        "cli": "Project name",
+        "wizard": "What should we call your project?"
+      },
+      "help": {
+        "cli": "Lowercase, digits and dashes, at most 30 characters. Maven coordinates stay com.yosr:app.",
+        "wizard": "A short name with no spaces. It labels the app, not the Maven artifact."
+      },
+      "pattern": "^(?!(?:system|spring|maven|java|gradle|tests|app)$)[a-z][a-z0-9-]*$",
+      "maxLength": 30
+    },
+    {
+      "id": "database",
+      "type": "enum",
+      "label": {
+        "cli": "Database",
+        "wizard": "Does your API need to save data?"
+      },
+      "default": "postgres",
+      "choices": [
+        {
+          "value": "postgres",
+          "label": {
+            "cli": "Postgres",
+            "wizard": "Yes, in a Postgres database"
+          },
+          "help": {
+            "cli": "Spring Data JPA; DATABASE_URL points at your server.",
+            "wizard": "A database server you run yourself or in Docker."
+          }
+        },
+        {
+          "value": "none",
+          "label": {
+            "cli": "None",
+            "wizard": "No, keep data in memory"
+          }
+        }
+      ],
+      "help": {
+        "cli": "Postgres through Spring Data JPA (default), or none to keep notes in memory.",
+        "wizard": "Pick Postgres for a real database, or none for an in-memory store."
+      }
+    },
+    {
+      "id": "auth",
+      "type": "enum",
+      "label": {
+        "cli": "Authentication",
+        "wizard": "Should callers prove who they are?"
+      },
+      "default": "none",
+      "choices": [
+        {
+          "value": "none",
+          "label": {
+            "cli": "None",
+            "wizard": "No, the API is open"
+          }
+        },
+        {
+          "value": "api-key",
+          "label": {
+            "cli": "API key",
+            "wizard": "Yes, with a shared API key"
+          },
+          "help": {
+            "cli": "X-API-Key header checked against API_KEY.",
+            "wizard": "Callers send a secret key with each request."
+          }
+        }
+      ],
+      "help": {
+        "cli": "One shared API key from the API_KEY environment variable, or an open API.",
+        "wizard": "An API key keeps strangers out; per-user sign-in is not part of this template."
+      }
+    },
+    {
+      "id": "deploy",
+      "type": "enum",
+      "label": {
+        "cli": "Deploy target",
+        "wizard": "How will the API run in production?"
+      },
+      "default": "none",
+      "choices": [
+        {
+          "value": "none",
+          "label": {
+            "cli": "None",
+            "wizard": "Decide later"
+          }
+        },
+        {
+          "value": "docker",
+          "label": {
+            "cli": "Docker",
+            "wizard": "Docker container + Compose"
+          }
+        }
+      ],
+      "help": {
+        "cli": "Dockerfile + Compose (with Postgres when database is postgres), or decide later.",
+        "wizard": "Docker runs the API the same way everywhere."
+      }
+    },
+    {
+      "id": "workflow",
+      "type": "enum",
+      "label": {
+        "cli": "Workflow",
+        "wizard": "How should agents track work?"
+      },
+      "help": {
+        "cli": "Local Markdown tracker, GitHub issue/PR templates, or neither.",
+        "wizard": "Local files under work/, GitHub templates only, or skip the tracker."
+      },
+      "default": "local",
+      "choices": [
+        {
+          "value": "local",
+          "label": {
+            "cli": "Local",
+            "wizard": "Markdown tracker under work/ (default)"
+          }
+        },
+        {
+          "value": "github",
+          "label": {
+            "cli": "GitHub",
+            "wizard": "Issue and PR templates (no API calls)"
+          }
+        },
+        {
+          "value": "none",
+          "label": {
+            "cli": "None",
+            "wizard": "No tracker files; keep zones only"
+          }
+        }
+      ]
+    },
+    {
+      "id": "ci",
+      "type": "boolean",
+      "label": {
+        "cli": "CI recipe",
+        "wizard": "Add a CI recipe that runs Yosr Seed gate?"
+      },
+      "help": {
+        "cli": "Opt-in GitHub Actions sample that runs a pinned yosr-seed gate (not @latest). Default off. Separate from --workflow (the work tracker).",
+        "wizard": "Writes a sample GitHub Actions workflow that runs the same gate as locally, with the CLI version pinned. Off by default. Not the Local/GitHub/None work tracker."
+      },
+      "default": false
+    }
+  ],
+  "constraints": [],
+  "aliases": {
+    "@domain/*": "src/main/java/com/yosr/app/features/*",
+    "@shared/*": "src/main/java/com/yosr/app/shared/*",
+    "@server/*": "src/main/java/com/yosr/app/core/*"
+  },
+  "features": [
+    {
+      "id": "data-jpa",
+      "description": "Spring Data JPA + Postgres: NoteEntity, JpaNoteStore, ddl-auto=create-drop in tests (no gate migrations).",
+      "when": {
+        "option": "database",
+        "equals": "postgres"
+      },
+      "replaces": [
+        "pom.xml",
+        "dependencies-lock.json",
+        "@server/AppConfig.java",
+        "@server/AppSettings.java",
+        "src/main/resources/application.yml",
+        "src/test/java/com/yosr/app/NotesApiTest.java"
+      ],
+      "patches": [
+        {
+          "op": "env",
+          "target": ".env.example",
+          "vars": [
+            {
+              "name": "DATABASE_URL",
+              "example": "__seed_databaseUrl__",
+              "description": "Postgres connection URL for Spring Data JPA"
+            }
+          ]
+        },
+        {
+          "op": "insert",
+          "target": "README.md",
+          "anchor": "readme-sections",
+          "source": "features/data-jpa/snippets/readme-db.md"
+        }
+      ]
+    },
+    {
+      "id": "errors-result",
+      "description": "Result-style notes service and controller.",
+      "when": {
+        "option": "style.errors.pattern",
+        "equals": "result"
+      },
+      "after": ["data-jpa"],
+      "replaces": [
+        "@domain/notes/NotesService.java",
+        "@domain/notes/NotesController.java",
+        "src/test/java/com/yosr/app/NotesServiceTest.java",
+        "@shared/Result.java"
+      ]
+    },
+    {
+      "id": "auth-api-key",
+      "description": "Single shared API key (X-API-Key vs API_KEY); /health stays open.",
+      "when": {
+        "option": "auth",
+        "equals": "api-key"
+      },
+      "after": ["data-jpa", "errors-result"],
+      "patches": [
+        {
+          "op": "insert",
+          "target": "src/main/resources/application.yml",
+          "anchor": "application-config",
+          "source": "features/auth-api-key/snippets/application-api-key.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "src/test/java/com/yosr/app/NotesApiTest.java",
+          "anchor": "notes-request-wrap",
+          "content": "    builder = builder.header(com.yosr.app.core.ApiKeyFilter.HEADER_NAME, \"test-api-key\");\n"
+        },
+        {
+          "op": "insert",
+          "target": "src/test/java/com/yosr/app/NotesApiTest.java",
+          "anchor": "test-class-annotations",
+          "content": "@org.springframework.test.context.TestPropertySource(properties = \"app.api-key=test-api-key\")\n"
+        },
+        {
+          "op": "env",
+          "target": ".env.example",
+          "vars": [
+            {
+              "name": "API_KEY",
+              "example": "change-me",
+              "description": "Shared API key for X-API-Key"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "id": "deploy-docker",
+      "description": "Multi-stage Dockerfile (temurin JDK → JRE, non-root) and Compose skeleton.",
+      "when": {
+        "option": "deploy",
+        "equals": "docker"
+      },
+      "patches": [
+        {
+          "op": "insert",
+          "target": "README.md",
+          "anchor": "readme-sections",
+          "source": "features/deploy-docker/snippets/readme-docker.md"
+        }
+      ]
+    },
+    {
+      "id": "deploy-docker-postgres",
+      "description": "Compose Postgres service wired to DATABASE_URL.",
+      "when": {
+        "all": [
+          { "option": "deploy", "equals": "docker" },
+          { "option": "database", "equals": "postgres" }
+        ]
+      },
+      "after": ["deploy-docker"],
+      "patches": [
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "compose-header",
+          "source": "features/deploy-docker-postgres/snippets/compose-header.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "app-env",
+          "source": "features/deploy-docker-postgres/snippets/app-env.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "app-config",
+          "source": "features/deploy-docker-postgres/snippets/app-config.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "services",
+          "source": "features/deploy-docker-postgres/snippets/postgres-service.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "compose-volumes",
+          "source": "features/deploy-docker-postgres/snippets/compose-volumes.yaml"
+        },
+        {
+          "op": "insert",
+          "target": "README.md",
+          "anchor": "readme-sections",
+          "source": "features/deploy-docker-postgres/snippets/readme-docker.md"
+        }
+      ]
+    },
+    {
+      "id": "deploy-docker-apikey",
+      "description": "Compose passes API_KEY into the app container.",
+      "when": {
+        "all": [
+          { "option": "deploy", "equals": "docker" },
+          { "option": "auth", "equals": "api-key" }
+        ]
+      },
+      "after": ["deploy-docker", "deploy-docker-postgres"],
+      "patches": [
+        {
+          "op": "insert",
+          "target": "compose.yaml",
+          "anchor": "app-env",
+          "content": "      API_KEY: ${API_KEY}"
+        }
+      ]
+    }
+  ],
+  "style": {
+    "ignore": [
+      "naming.files",
+      "naming.componentFiles",
+      "tests.naming",
+      "tests.location",
+      "data.fetching",
+      "forms.validation",
+      "lint.preset",
+      "ts.*",
+      "format.*",
+      "imports.*"
+    ],
+    "dimensions": [
+      {
+        "id": "layout",
+        "description": "Feature-based, layer-based, or flat packages under com.yosr.app.",
+        "default": "feature",
+        "values": {
+          "feature": {
+            "pathMap": {
+              "@domain": "src/main/java/com/yosr/app/features",
+              "@shared": "src/main/java/com/yosr/app/shared",
+              "@server": "src/main/java/com/yosr/app/core"
+            },
+            "rules": ["layout-feature"]
+          },
+          "layer": {
+            "pathMap": {
+              "@domain": "src/main/java/com/yosr/app/services",
+              "@shared": "src/main/java/com/yosr/app/shared",
+              "@server": "src/main/java/com/yosr/app/core"
+            },
+            "rules": ["layout-layer"]
+          },
+          "flat": {
+            "pathMap": {
+              "@domain": "src/main/java/com/yosr/app",
+              "@shared": "src/main/java/com/yosr/app/shared",
+              "@server": "src/main/java/com/yosr/app/core"
+            },
+            "rules": ["layout-flat"]
+          }
+        }
+      },
+      {
+        "id": "errors.pattern",
+        "description": "How services report expected failures: throw, or return a Result.",
+        "default": "throw",
+        "values": {
+          "throw": {
+            "rules": ["errors-throw"]
+          },
+          "result": {
+            "rules": ["errors-result"]
+          }
+        }
+      }
+    ]
+  },
+  "zones": [
+    {
+      "id": "domain-features",
+      "intent": "Domain logic for the API: one folder per feature with models, store, service, and controller. Follow notes and register new controllers under com.yosr.app.",
+      "paths": {
+        "create": ["@domain/**"],
+        "modify": ["@domain/**", "src/main/java/com/yosr/app/AppApplication.java"]
+      },
+      "context": ["@domain/notes/**", "AGENTS.md"],
+      "constraints": {
+        "maxFiles": 40
+      },
+      "tests": {
+        "required": true,
+        "paths": ["src/test/**/*NotesServiceTest.java"]
+      }
+    },
+    {
+      "id": "http-tests",
+      "intent": "In-process HTTP tests with MockMvc. No running server.",
+      "paths": {
+        "create": ["src/test/**"],
+        "modify": ["src/test/**"]
+      },
+      "context": ["src/test/java/com/yosr/app/NotesApiTest.java"],
+      "constraints": {
+        "maxFiles": 20
+      },
+      "tests": {
+        "required": false
+      }
+    },
+    {
+      "id": "core",
+      "intent": "App settings, DataSource, filters, and health. Keep feature logic out of core.",
+      "paths": {
+        "create": ["@server/**"],
+        "modify": ["@server/**"]
+      },
+      "constraints": {
+        "maxFiles": 20
+      },
+      "tests": {
+        "required": false
+      }
+    }
+  ],
+  "rules": {
+    "targets": ["agents-md", "claude-md", "cursor-rules"],
+    "fragments": [
+      {
+        "id": "project-overview",
+        "file": "rules/project-overview.md",
+        "title": "Project",
+        "order": 10,
+        "cursor": { "alwaysApply": true }
+      },
+      {
+        "id": "commands",
+        "file": "rules/commands.md",
+        "title": "Commands",
+        "order": 20,
+        "cursor": { "alwaysApply": true }
+      },
+      {
+        "id": "layout-feature",
+        "file": "rules/layout-feature.md",
+        "title": "Layout",
+        "order": 30,
+        "cursor": { "globs": ["src/**"] }
+      },
+      {
+        "id": "layout-layer",
+        "file": "rules/layout-layer.md",
+        "title": "Layout",
+        "order": 30,
+        "cursor": { "globs": ["src/**"] }
+      },
+      {
+        "id": "layout-flat",
+        "file": "rules/layout-flat.md",
+        "title": "Layout",
+        "order": 30,
+        "cursor": { "globs": ["src/**"] }
+      },
+      {
+        "id": "errors-throw",
+        "file": "rules/errors-throw.md",
+        "title": "Errors",
+        "order": 40,
+        "cursor": { "globs": ["src/**"] }
+      },
+      {
+        "id": "errors-result",
+        "file": "rules/errors-result.md",
+        "title": "Errors",
+        "order": 40,
+        "cursor": { "globs": ["src/**"] }
+      },
+      {
+        "id": "data-none",
+        "file": "rules/data-none.md",
+        "title": "Data",
+        "order": 50,
+        "when": { "option": "database", "equals": "none" },
+        "cursor": {
+          "globs": ["src/**/MemoryNoteStore.java", "src/**/NoteStore.java"]
+        }
+      },
+      {
+        "id": "data-jpa",
+        "file": "rules/data-jpa.md",
+        "title": "Data",
+        "order": 50,
+        "when": { "option": "database", "equals": "postgres" },
+        "cursor": {
+          "globs": [
+            "src/**/NoteEntity.java",
+            "src/**/JpaNoteStore.java",
+            "src/**/NoteRepository.java"
+          ]
+        }
+      },
+      {
+        "id": "auth-api-key",
+        "file": "rules/auth-api-key.md",
+        "title": "Auth",
+        "order": 60,
+        "when": { "option": "auth", "equals": "api-key" },
+        "cursor": {
+          "globs": ["src/**/ApiKeyFilter.java"]
+        }
+      }
+    ],
+    "toolsNote": "Format and build are enforced by tools, not prose: run `mvn spotless:check` and `mvn compile` (compiler `-Werror`). Fix the code; don't disable rules.",
+    "architectureNote": {
+      "source": "rules/architecture.md",
+      "target": "docs/architecture.md",
+      "folders": {
+        "app entry": "src/main/java/com/yosr/app/AppApplication.java",
+        "http tests": "src/test/java/com/yosr/app/"
+      }
+    }
+  },
+  "checks": {
+    "maxFixAttempts": 3,
+    "services": [
+      {
+        "id": "postgres",
+        "image": "postgres:18.6-alpine",
+        "env": {
+          "POSTGRES_PASSWORD": "postgres"
+        },
+        "when": {
+          "option": "database",
+          "equals": "postgres"
+        }
+      }
+    ],
+    "steps": [
+      {
+        "id": "install",
+        "kind": "install",
+        "run": {
+          "command": ["mvn", "-B", "-q", "dependency:resolve", "dependency-lock:check"]
+        },
+        "timeoutSec": 600
+      },
+      {
+        "id": "format",
+        "kind": "lint",
+        "run": {
+          "command": ["mvn", "-B", "-q", "spotless:check"]
+        },
+        "timeoutSec": 300
+      },
+      {
+        "id": "build",
+        "kind": "typecheck",
+        "run": {
+          "command": ["mvn", "-B", "-q", "compile"]
+        },
+        "timeoutSec": 600
+      },
+      {
+        "id": "test",
+        "kind": "test",
+        "run": {
+          "command": ["mvn", "-B", "test"]
+        },
+        "timeoutSec": 600
+      },
+      {
+        "id": "image",
+        "kind": "custom",
+        "run": {
+          "command": [
+            "docker",
+            "build",
+            "-t",
+            "__seed_projectName__:latest",
+            "."
+          ]
+        },
+        "timeoutSec": 900,
+        "required": false,
+        "when": {
+          "option": "deploy",
+          "equals": "docker"
+        },
+        "phases": ["handoff", "template-ci", "project-ci"]
+      }
+    ],
+    "report": {
+      "path": ".seed/report.md"
+    }
+  },
+  "matrix": {
+    "strategy": "pairwise",
+    "packageManagers": ["maven"],
+    "styleDimensions": ["layout", "errors.pattern"],
+    "include": [
+      {
+        "name": "defaults",
+        "options": {}
+      },
+      {
+        "name": "none",
+        "options": {
+          "database": "none"
+        }
+      },
+      {
+        "name": "kitchen-sink",
+        "options": {
+          "database": "postgres",
+          "auth": "api-key",
+          "deploy": "docker"
+        },
+        "style": {
+          "layout": "layer",
+          "errors.pattern": "result"
+        }
+      }
+    ]
+  },
+  "migrations": []
+}