Low-priority duplication and dead code in templates, examples and tool modules
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
- Ambito
- developer-experience, tooling
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
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.luaexamples/*/server/main.lua:1-15andexamples/*/client/main.lua:1-16(resolveFramework)mcp-server/tools/txadmin.py:15,:52-58,:80-88,:116-120,:165-174mcp-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.luadiffers only in the init and one player-data line; all sevenconfig.luafiles are byte-identical, as are the twonui-bridge.tsfiles. CI checks only that each manifest containsfx_version,gamesand'cerulean'. Drift has started in the games comments. - Example bridge. The first ~15 lines of three example server
main.luafiles 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 owntry/except TxAdminErrorblock, with no parameter or factory for a fake client. The "error key in result" check is repeated, andTxAdminConfigis imported but unused (txadmin.py:15). - Dead code.
substitute_variableshas no callers, whiledocs/ROADMAP.md:88marks templating as shipped.FRAMEWORK_INIT_SERVERis a verbatim copy ofFRAMEWORK_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.tsfiles 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 insnippets/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_variablesinto 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
- 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
-
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
-
enhancement severity: medium
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
TMHSDigital/CFX-Developer-Tools#57 ·
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