Low-priority duplication and dead code in templates, examples and tool modules
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Refactorisation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- github-actions, lua, python, typescript
- Domaine
- developer-experience, tooling
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Python
- Étoiles
- 7
- Forks
- 4
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de TMHSDigital/CFX-Developer-Tools
-
help wanted severity: low tech-debt
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
TMHSDigital/CFX-Developer-Tools#79 ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement help wanted severity: low
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
TMHSDigital/CFX-Developer-Tools#68 ·
Les mainteneurs répondent en général sous 1 jour
-
dependencies severity: low
Difficulté 3/5 1-2 jours Accessibilité débutants 65/100
TMHSDigital/CFX-Developer-Tools#62 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement severity: medium
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
TMHSDigital/CFX-Developer-Tools#58 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement severity: medium
Difficulté 4/5 3-5 jours Accessibilité débutants 42/100
TMHSDigital/CFX-Developer-Tools#57 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de TMHSDigital/CFX-Developer-Tools
Issues similaires
-
hive size:simple
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
A new VOLTTRON_HOME starts with agent isolation mode on (string comparison of a boolean default)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
painted-porch/marcus#977 ·
Les mainteneurs répondent en général sous 1 jour
-
llm translation
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
FAIRmat-NFDI/sand#239 ·
Les mainteneurs répondent en général sous 1 jour