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

Aberta Para iniciantes
#100 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

@mafujahmedridoy22-commits já está trabalhando nisso.

Desde 14/11/2026.

  • #137 de @mafujahmedridoy22-commits — aberto
  • #138 de @vortsghost2025 — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
88/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
tooling

Direção de pesquisa

Comece por src/lint/rules/missing-onready.ts e examine hasOnready e a lógica de detecção e correção; depois, leia os casos relacionados em test/fixes.test.ts e test/rules.test.ts. Execute npm run build && npm test conforme listado na issue. O trabalho estará concluído quando comentários entre @onready e var forem tratados, declarações exportadas não receberem correção e permanecerem idênticas byte a byte, e declarações simples continuarem sendo corrigidas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
0
Forks
6
Merge médio
1d 21h
PRs com merge (30d)
8

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/godot-correctness-mcp

Todas as issues de TMHSDigital/godot-correctness-mcp

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.