Framework knowledge is spread across 6+ tables in 4 modules plus templates
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
Rechercherichtung
Start with mcp-server/tools/manifest_common.py (FRAMEWORK_DEPS, VALID_FRAMEWORKS and the error string), then compare FRAMEWORK_INIT_CLIENT and FRAMEWORK_INIT_SERVER in mcp-server/tools/scaffold.py and the scores/evidence literals in mcp-server/tools/detect_framework.py. The issue proposes a single framework registry, with tests written first for validation, detection and scaffold output. Done means those modules derive from one registry and a newly registered framework works without edits elsewhere; there is no test suite yet, so the first step is adding one.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Summary
The list of supported frameworks and what each one means is repeated in at least six tables across four Python modules, plus tool docstrings and one directory per framework under templates/. None reference each other, so adding or changing a framework requires about nine coordinated edits and a partial edit fails silently.
Where
mcp-server/tools/manifest_common.py:12-19(FRAMEWORK_DEPS),:23(VALID_FRAMEWORKS),:43(hand-written error string)mcp-server/tools/scaffold.py:15-33(FRAMEWORK_INIT_CLIENTandFRAMEWORK_INIT_SERVER, byte-identical)mcp-server/tools/detect_framework.py:14-43(MANIFEST_SIGNALS,CODE_SIGNALS),:58-65(scores/evidenceliterals)mcp-server/server.py:45, 86, 108(framework lists in tool docstrings)templates/<framework>/,templates/vorp/fxmanifest.lua:2(game compatibility only in comments)
Details
- A framework missing from the
scoresliteral raisesKeyErrorindetect_framework; one missing fromFRAMEWORK_INIT_*produces an empty init line with no error. FRAMEWORK_INIT_SERVERis a verbatim duplicate ofFRAMEWORK_INIT_CLIENT.- Game compatibility (VORP/RSG are RedM-only, Qbox/ESX/QB/ox are FiveM-only) exists only in template comments and is not enforced (see "Reject invalid framework/game combinations and offer a multi-framework bridge").
Impact
Maintainability: adding a framework (for example a new RedM core) means touching about nine places, and missed spots produce wrong output rather than errors.
Suggested fix
- Tests first:
validate_inputsaccepts every framework;detect_frameworkreturns each framework for a minimal fixture workspace; the scaffold emits each framework's init line. - Add a
FRAMEWORKS: dict[str, Framework]registry inmanifest_common.py, whereFrameworkis a dataclass (id,dependency,init_lua,games,manifest_signals,code_signals). - Derive
VALID_FRAMEWORKS,FRAMEWORK_DEPSand the error message from it (keep the old names as aliases). - Point the scaffold at
FRAMEWORKS[fw].init_luaand delete both INIT dicts. - Build
detect_framework'sscores/evidenceand signals from the registry. - Enforce
gamesinvalidate_inputs.
Acceptance criteria
- Framework metadata lives in one registry; other modules derive from it.
- Adding a framework to the registry is enough for validation, scaffold init, manifest dependency and detection (plus a template directory).
- Tests cover every registered framework.
Getting started
- Relevant files:
mcp-server/tools/manifest_common.py,mcp-server/tools/scaffold.py,mcp-server/tools/detect_framework.py,mcp-server/server.py - 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:
skills/framework-detection/SKILL.md
Filed by repo-audit/full-audit at 701824d. Severity: medium. Effort: M. audit-key: tech-debt|mcp-server/tools/manifest_common.py|VALID_FRAMEWORKS
- Vorherrschende Sprache
- Python
- Sterne
- 7
- Forks
- 4
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TMHSDigital/CFX-Developer-Tools
-
help wanted severity: low tech-debt
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
TMHSDigital/CFX-Developer-Tools#79 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement help wanted severity: low
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
TMHSDigital/CFX-Developer-Tools#68 ·
Maintainer antworten meist innerhalb von 1 Tag
-
help wanted severity: low tech-debt
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
TMHSDigital/CFX-Developer-Tools#66 ·
Maintainer antworten meist innerhalb von 1 Tag
-
dependencies severity: low
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100
TMHSDigital/CFX-Developer-Tools#62 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement severity: medium
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
TMHSDigital/CFX-Developer-Tools#58 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in TMHSDigital/CFX-Developer-Tools
Ähnliche Issues
-
hive size:simple
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
A new VOLTTRON_HOME starts with agent isolation mode on (string comparison of a boolean default)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
painted-porch/marcus#977 ·
Maintainer antworten meist innerhalb von 1 Tag
-
llm translation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
FAIRmat-NFDI/sand#239 ·
Maintainer antworten meist innerhalb von 1 Tag