Ship question-type screenshots as a release asset (and regenerate them)
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
- 领域
- build-system, release
调研方向
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.
rangehas 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
- Regenerate all screenshots against the current registry (
uv run codegen --screenshots). - Release asset
formtransform-screenshots-<version>.tar.gz, next tocdl-survey-types-*andformtransform-fixtures-*, with amanifest.json:
Width/height let consumers reserve layout space.{ "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" } } } }enginemakes clear the XLSForm shot is Enketo (the engine behind KoboToolbox web forms), not the Kobo UI itself. - 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
rangedid. - 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.pngand/xlsform.png, and addlimesurveySrc,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,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
CorrelAid/formtransform 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 54/100
CorrelAid/formtransform#212 ·
维护者通常 1 天内回复
查看 CorrelAid/formtransform 的全部 Issue
相似的 Issue
-
Cleanup Setup可能已有人在做 @AlexanderKaran 今天认领。 未关闭documentation enhancement
难度 2/5 1-3 小时 新手友好度 64/100
e18e/framework-tracker#769 ·
维护者通常 1 天内回复
-
bug v2
难度 1/5 1 小时以内 新手友好度 88/100
modelcontextprotocol/servers#5483 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 84/100
XiaomiMiMo/MiMo-Code#2783 ·
维护者通常 1 天内回复
-
area: web bug
难度 2/5 1-3 小时 新手友好度 76/100
kinqsradio/orbyn-engineering#227 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
joeldesante/TurfBuilder#258 ·
维护者通常 1 天内回复