missing-onready --fix writes @onready @export, and misses @onready above a comment

Ouverte Adaptée aux débutants
#100 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

@mafujahmedridoy22-commits y travaille déjà.

Depuis le 14/11/2026.

  • #137 par @mafujahmedridoy22-commits — ouverte
  • #138 par @vortsghost2025 — ouverte

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
88/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript
Domaine
tooling

Piste de recherche

Commence par src/lint/rules/missing-onready.ts et examine hasOnready, ainsi que la logique de détection et de correction ; lis ensuite les cas associés dans test/fixes.test.ts et test/rules.test.ts. Exécute npm run build && npm test comme indiqué dans l’issue. Le travail est terminé lorsque les commentaires entre @onready et var sont pris en charge, que les déclarations exportées ne reçoivent aucune correction et restent identiques octet pour octet, et que les déclarations simples sont toujours corrigées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

bug good first issue severity: medium

Summary

The machine-applicable fix for missing-onready writes wrong code in two cases. gdcorrect lint --fix writes it to user files.

  1. On an exported member, @export var x: Node = $X becomes @onready @export var x: Node = $X. Godot warns on @onready combined with @export (ONREADY_WITH_EXPORT). The initializer then runs after the inspector value is applied and overwrites it, so the designer's assignment is silently lost. A test currently asserts this rewrite as correct.
  2. When a comment sits between a standalone @onready line and the var, the rule does not see the annotation. It reports a false positive, and --fix adds a second @onready.

Where

  • src/lint/rules/missing-onready.ts:29 (hasOnready: the previousNamedSibling walk stops at the first comment node)
  • src/lint/rules/missing-onready.ts:42-55 (finding and fix are emitted regardless of @export* annotations)
  • test/fixes.test.ts:24-29 (expects @onready @export var other: Node = $Other)

Details

@onready
# the player sprite
var a: Node = $A          # flagged; --fix -> "@onready var a ..." (second @onready)

@export var c: Node = $C  # --fix -> "@onready @export var c ..."

Tree-sitter comments are named nodes, so s.type === "annotation" || s.type === "annotations" ends the loop at the comment.

Impact

--fix is described as applying only machine-applicable fixes. Here it changes runtime behaviour (exported values overwritten at _ready) or produces a redundant annotation, in files the user did not review.

Steps to reproduce

  1. Put either snippet above in a project script.
  2. Run gdcorrect lint <project> --fix, then inspect the file.

Suggested fix

  • In hasOnready, skip comment siblings while walking backwards.
  • When the declaration carries any @export* annotation, attach no fix. Either keep the finding with a message suggesting an exported NodePath or no initializer, or skip it.
  • Update test/fixes.test.ts to expect no fix for exported members.

Acceptance criteria

  • @onready / comment / var a = $A is not flagged.
  • @export var n: Node = $N and @export_* variants have no fix, and --fix leaves those lines byte-identical.
  • Plain var n: Node = $N is still fixed.

Getting started

  • Relevant files: src/lint/rules/missing-onready.ts, test/fixes.test.ts, test/rules.test.ts
  • How to run tests: npm run build && npm test

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: S. audit-key: bug|src/lint/rules/missing-onready.ts|missingOnready.fix

Langage dominant
TypeScript
Étoiles
0
Forks
6
Merge moyen
1 j 21 h
PR mergées (30 j)
8

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/godot-correctness-mcp

Toutes les issues de TMHSDigital/godot-correctness-mcp

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.