Framework knowledge is spread across 6+ tables in 4 modules plus templates

Đang mở
#52 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
lua, python
Lĩnh vực
devtools, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

severity: medium tech-debt

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_CLIENT and FRAMEWORK_INIT_SERVER, byte-identical)
  • mcp-server/tools/detect_framework.py:14-43 (MANIFEST_SIGNALS, CODE_SIGNALS), :58-65 (scores / evidence literals)
  • 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 scores literal raises KeyError in detect_framework; one missing from FRAMEWORK_INIT_* produces an empty init line with no error.
  • FRAMEWORK_INIT_SERVER is a verbatim duplicate of FRAMEWORK_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

  1. Tests first: validate_inputs accepts every framework; detect_framework returns each framework for a minimal fixture workspace; the scaffold emits each framework's init line.
  2. Add a FRAMEWORKS: dict[str, Framework] registry in manifest_common.py, where Framework is a dataclass (id, dependency, init_lua, games, manifest_signals, code_signals).
  3. Derive VALID_FRAMEWORKS, FRAMEWORK_DEPS and the error message from it (keep the old names as aliases).
  4. Point the scaffold at FRAMEWORKS[fw].init_lua and delete both INIT dicts.
  5. Build detect_framework's scores/evidence and signals from the registry.
  6. Enforce games in validate_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

Ngôn ngữ chính
Python
Star
7
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/CFX-Developer-Tools

Tất cả issue của TMHSDigital/CFX-Developer-Tools

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.