Ship question-type screenshots as a release asset (and regenerate them)

已关闭
#171 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
typescript

调研方向

Start with uv run codegen --screenshots and the existing screenshots/<slug>/{limesurvey,xlsform}.png outputs, then inspect how cdl-survey-types-* and formtransform-fixtures-* release assets are generated. Add the versioned tarball and manifest.json, and implement the completeness check for registered entities and PNGs. Done means current-registry screenshots are regenerated, packaged as a release asset, and stale or missing files are detected without Docker.

由索引模型根据 Issue 内容生成。

描述

screenshots/<slug>/{limesurvey,xlsform}.png render each registry type as a respondent sees it. Nothing consumes them yet, but the survey site wants exactly these: its fragetypen page has LimeSurvey and KoboToolbox tabs per example that currently say "Screenshot folgt" (CorrelAid/cdl-wp-eins, QuestionTypeBlock.astro). qwacback's examples are the registry fixtures (e.g. qwacback single_choice = registry/entities/select_one/fixtures/xlsform.json, pinned at v0.7.1), so the screenshots match them one to one.

Site-side proposal: CorrelAid/cdl-wp-eins#33.

State today

  • Last generated in the initial commit (2026-08-05). The registry has changed a lot since, up to v0.7.1.
  • range has no screenshots.
  • Not in the npm package or the release assets. The only way to get them is the repo tree on main, which isn't versioned.

Proposal

  1. Regenerate all screenshots against the current registry (uv run codegen --screenshots).
  2. Release asset formtransform-screenshots-<version>.tar.gz, next to cdl-survey-types-* and formtransform-fixtures-*, with a manifest.json:
    {
      "version": "0.7.1",
      "types": {
        "select_one": {
          "limesurvey": { "file": "select_one/limesurvey.png", "width": 1930, "height": 758, "engine": "LimeSurvey", "theme": "fruity_twentythree" },
          "xlsform":    { "file": "select_one/xlsform.png",    "width": 1296, "height": 450, "engine": "Enketo" }
        }
      }
    }
    
    Width/height let consumers reserve layout space. engine makes clear the XLSForm shot is Enketo (the engine behind KoboToolbox web forms), not the Kobo UI itself.
  3. Completeness check (in codegen or CI, cheap, no Docker): every registry entity (types, variants, composites) has both PNGs, and no PNG exists for a slug that isn't registered. That keeps them from going stale silently, the way range did.
  4. Optional: note the registry version a screenshot was rendered from in the manifest, so a consumer can warn when it's older than the entity.

Consumers (planned)

  • qwacback already pulls formtransform assets at its pinned version. It would unpack this tarball, serve /api/examples/{type}/limesurvey.png and /xlsform.png, and add limesurveySrc, koboSrc, dimensions and alt text to the example response. Example and screenshot then always come from the same registry version. Keyed by registry slug, which fits CorrelAid/qwacback#49.
  • cdl-wp-eins renders what qwacback returns (CorrelAid/cdl-wp-eins#33).
主要语言
TypeScript
星标
0
派生
0
平均合并
54 分钟
30 天内合并 PR
43

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

CorrelAid/formtransform 的其他 Issue

查看 CorrelAid/formtransform 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。