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

Aperta Adatta ai principianti
#100 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

@mafujahmedridoy22-commits ci sta già lavorando.

Dal 14/11/2026.

  • #137 di @mafujahmedridoy22-commits — aperta
  • #138 di @vortsghost2025 — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
tooling

Direzione di ricerca

Inizia da src/lint/rules/missing-onready.ts ed esamina hasOnready e la logica di rilevamento e correzione; poi leggi i casi correlati in test/fixes.test.ts e test/rules.test.ts. Esegui npm run build && npm test come indicato nell’issue. Il lavoro è completato quando vengono gestiti i commenti tra @onready e var, le dichiarazioni esportate non ricevono correzioni e rimangono identiche byte per byte, e le dichiarazioni semplici continuano a essere corrette.

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

Descrizione

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

Lingua principale
TypeScript
Stelle
0
Fork
6
Merge medio
1g 21h
PR unite (30g)
8

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/godot-correctness-mcp

Tutte le issue di TMHSDigital/godot-correctness-mcp

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.