Low-priority duplication and dead code in templates, examples and tool modules

Aperta
#66 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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
github-actions, lua, python, typescript

Direzione di ricerca

Start with mcp-server/tools/txadmin.py, where each of the four tools builds its own TxAdminClient() inside a try/except block, and with mcp-server/tools/manifest_common.py (substitute_variables, which has no callers). Then check mcp-server/tools/scaffold.py for the duplicate FRAMEWORK_INIT_SERVER and FRAMEWORK_INIT_CLIENT dicts, and .github/workflows/validate.yml for the existing manifest check. Done means the txAdmin tools accept an injectable client, the dead helper and unused import are gone, and CI fails when template or example bridge blocks drift.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

help wanted severity: low tech-debt

Summary

A collection of low-priority duplication and dead code: seven near-identical framework templates with no consistency check, a framework bridge copied into six example files, four txAdmin tools that repeat the same client/try/render block with no test seam, and unused or half-wired helpers in the manifest and scaffold modules.

Where

  • templates/{esx,qbcore,qbox,oxcore,vorp,rsg,standalone}/ (manifests, client/main.lua, config.lua)
  • templates/nui-vite/web/src/nui-bridge.ts, templates/nui-svelte/web/src/nui-bridge.ts, templates/nui-*/client/main.lua
  • examples/*/server/main.lua:1-15 and examples/*/client/main.lua:1-16 (resolveFramework)
  • mcp-server/tools/txadmin.py:15, :52-58, :80-88, :116-120, :165-174
  • mcp-server/tools/manifest_common.py:47-51 (substitute_variables), mcp-server/tools/scaffold.py:25-33 (FRAMEWORK_INIT_SERVER)
  • docs/ROADMAP.md:88

Details

  • Framework templates. The seven framework manifests differ only in the games comment, description and dependency lines; client/main.lua differs only in the init and one player-data line; all seven config.lua files are byte-identical, as are the two nui-bridge.ts files. CI checks only that each manifest contains fx_version, games and 'cerulean'. Drift has started in the games comments.
  • Example bridge. The first ~15 lines of three example server main.lua files are byte-identical (resolveFramework(), ESX and QB only, standalone fallback), and so are the first lines of three client files. Each example then hand-writes parallel ESX/QB helpers for money, inventory and notifications.
  • txAdmin seam. Each of the four tool functions constructs TxAdminClient() inside its own try/except TxAdminError block, with no parameter or factory for a fake client. The "error key in result" check is repeated, and TxAdminConfig is imported but unused (txadmin.py:15).
  • Dead code. substitute_variables has no callers, while docs/ROADMAP.md:88 marks templating as shipped. FRAMEWORK_INIT_SERVER is a verbatim copy of FRAMEWORK_INIT_CLIENT.

Impact

Convention changes must be applied by hand to 7-9 template files or 6 example files with nothing flagging a missed copy, and those files are copy-paste targets for users. The destructive txAdmin tools cannot be unit-tested without monkeypatching the module.

Suggested fix

  • Templates: keep them as plain copyable files, but add a CI check that shared parts are identical across framework templates after masking known per-framework lines, and that the nui-bridge.ts files match. If the scaffold renders from templates, optionally generate the framework dirs from a registry and fail CI on drift.
  • Examples: keep them self-contained. Mark the bridge with -- BEGIN framework-bridge / -- END framework-bridge, add a CI check that the marked blocks are identical, and put the canonical version in snippets/lua/framework-bridge.lua.
  • txAdmin: add _call(method, path, *, body=None, query=None, client_factory=TxAdminClient) that returns the result or an error string, route the four tools through it, and drop the unused import.
  • Dead code: wire substitute_variables into the scaffold or delete it and untick the roadmap item; collapse the two INIT dicts into one.

Acceptance criteria

  • CI fails if shared template parts or the example bridge blocks drift.
  • txAdmin tools accept an injectable client and share one call helper.
  • No unused helper, duplicate dict, or unused import remains in the listed modules, and ROADMAP matches.

Getting started

  • Relevant files: templates/, examples/, mcp-server/tools/txadmin.py, mcp-server/tools/manifest_common.py, mcp-server/tools/scaffold.py, .github/workflows/validate.yml
  • 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: examples/README.md, docs/ROADMAP.md

Filed by repo-audit/full-audit at 701824d. Severity: low. Effort: M. audit-key: tech-debt|templates/esx/fxmanifest.lua|duplication

Lingua principale
Python
Stelle
7
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/CFX-Developer-Tools

Tutte le issue di TMHSDigital/CFX-Developer-Tools

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.