Scaffolder duplicates templates/ boilerplate and a second manifest renderer
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- csharp, javascript, lua, python
- Ambito
- developer-experience, tooling
Direzione di ricerca
Start in mcp-server/tools/scaffold.py (_build_manifest, _scaffold_lua/_js/_csharp) and compare it with generate_manifest in mcp-server/tools/manifest_gen.py and manifest_common.py, then with the matching folders under templates/. Step one is golden-output tests for scaffold_resource and snapshot tests for generate_manifest, since no test suite exists yet. Done means one shared manifest renderer, scaffold output matching templates/<framework> after substitution, and a decision on NUI support.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
scaffold_resource_tool builds every file from inline Python strings and never reads templates/, and it has its own manifest renderer separate from generate_manifest. The copies have already drifted from the templates and from each other.
Where
mcp-server/tools/scaffold.py:15-33(FRAMEWORK_INIT_CLIENT/FRAMEWORK_INIT_SERVER)mcp-server/tools/scaffold.py:84-137(_build_manifest)mcp-server/tools/scaffold.py:140-256(_scaffold_lua,_scaffold_js,_scaffold_csharp)mcp-server/tools/manifest_gen.py:58-128(generate_manifest, second renderer; re-implementsgames_blockat 58-61)mcp-server/tools/manifest_common.py:4,:29-33(games_block),:47-51(substitute_variables, no callers)templates/,skills/resource-scaffolding/SKILL.md:110-116
Details
Drift already present between the scaffold output, generate_manifest, and templates/:
- The scaffolded C# csproj has no
HintPathfor CitizenFX.Core; the template has one. - C# manifest entries differ three ways (scaffold
Client/ClientMain.net.dll/Server/ServerMain.net.dll,generate_manifest{name}.net.dll, templateMyResource.net.dll). - Framework templates include
'@oxmysql/lib/MySQL.lua'and show player-data calls; scaffold output has neither. - Templates pin VORP/RSG to
rdr3and ESX/QB/Qbox/ox togta5; the scaffold accepts any game with any framework. - No NUI option exists although
templates/nui-viteandtemplates/nui-svelteare maintained, and CLAUDE.md says the scaffold supports "optional NUI".
manifest_common.py says it exists "to avoid duplication", yet both tools build the same header list and per-language script blocks separately. generate_manifest supports dependencies, scanned scripts and NUI; the scaffold supports none of them. substitute_variables exists for templating but has no callers, while docs/ROADMAP.md marks templating as shipped.
The functional bugs are tracked separately in "C# scaffold fails to compile; C# manifests reference DLLs that are never built" and "generate_manifest emits Lua tables without commas, mishandles scanned scripts".
Impact
Users get structurally different resources from the MCP tool and from the templates. Every template fix must be ported by hand into Python string literals with nothing checking it, and every manifest convention change must be made in two functions.
Suggested fix
Each step can ship on its own:
- Add golden-output tests for
scaffold_resourceacross language and framework, and snapshot tests forgenerate_manifest(with deps, scripts, has_nui). - Add
render_manifest(name, game, language, framework, author, description, deps=(), extra_scripts=(), has_nui=False)tomanifest_common.py, ported fromgenerate_manifest; makegenerate_manifestcall it (snapshots unchanged), then make the scaffold call it and delete_build_manifest. - Add
{{name}}/{{author}}placeholders totemplates/and have_scaffold_lua/_js/_csharpcopytemplates/<x>/throughsubstitute_variables, resolving the templates dir relative to__file__. Delete the inline strings. - Add optional parameters:
output_dir,nui: none|vanilla|react|svelte(overlaytemplates/nui-*),dry_run.
Acceptance criteria
- There is one manifest renderer used by both tools.
- Scaffold output for a framework matches
templates/<framework>after name/author substitution (enforced by a test). -
scaffold_resource_toolcan add NUI from the maintained templates, or CLAUDE.md stops claiming it. -
substitute_variablesis used or removed, and ROADMAP reflects reality.
Getting started
- Relevant files:
mcp-server/tools/scaffold.py,mcp-server/tools/manifest_gen.py,mcp-server/tools/manifest_common.py,templates/ - How to run checks: there is no test suite yet; run the MCP server with
cd mcp-server && pip install -r requirements.txt && python server.py, and CI checks live in.github/workflows/validate.yml - Related docs:
docs/ARCHITECTURE.md(Templates),skills/resource-scaffolding/SKILL.md
Filed by repo-audit/full-audit at 701824d. Severity: medium. Effort: M. audit-key: tech-debt|mcp-server/tools/scaffold.py|scaffold_resource
- Lingua principale
- Python
- Stelle
- 7
- Fork
- 4
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di TMHSDigital/CFX-Developer-Tools
-
help wanted severity: low tech-debt
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
TMHSDigital/CFX-Developer-Tools#79 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement help wanted severity: low
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
TMHSDigital/CFX-Developer-Tools#68 ·
I maintainer di solito rispondono entro 1 giorno
-
help wanted severity: low tech-debt
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
TMHSDigital/CFX-Developer-Tools#66 ·
I maintainer di solito rispondono entro 1 giorno
-
dependencies severity: low
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
TMHSDigital/CFX-Developer-Tools#62 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement severity: medium
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
TMHSDigital/CFX-Developer-Tools#58 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di TMHSDigital/CFX-Developer-Tools
Issue simili
-
A new VOLTTRON_HOME starts with agent isolation mode on (string comparison of a boolean default)Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
llm translation
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
FAIRmat-NFDI/sand#239 ·
I maintainer di solito rispondono entro 1 giorno
-
bug P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
coco-research/coco#539 ·
I maintainer di solito rispondono entro 1 giorno
-
dependencies
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
JustBeanie/hass-volcano-hybrid#34 ·
I maintainer di solito rispondono entro 1 giorno