Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

types.ts: LoopCliConfig.logger docstring says 'VerboseLogger instance' but LoggerSpec accepts any Logger

Aperta Adatta ai principianti
  • Qualcosa non va?
#78 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
92/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia in src/types.ts, nel docstring di LoopCliConfig.logger, quindi confronta la formulazione con la definizione di LoggerSpec in src/loggers.ts e con il README o il comportamento di createLogger menzionati nell'issue. Aggiorna la documentazione in modo da descrivere qualsiasi implementazione di Logger, l'opzione 'verbose' e undefined; il lavoro è terminato quando il commento non implica più che sia accettato solo VerboseLogger.

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

Descrizione

bug S4

Observed behavior

The docstring on LoopCliConfig.logger in src/types.ts reads:

/**
 * Controls verbose diagnostic logging to stderr. Accepts a concrete
 * `VerboseLogger` instance, the string `'verbose'` (which creates an
 * enabled logger), or `undefined` (quiet, the default).
 */
readonly logger?: LoggerSpec;

This says the field accepts a VerboseLogger instance. But LoggerSpec in src/loggers.ts is defined as:

export type LoggerSpec = Logger | 'verbose' | undefined;

Any object implementing the Logger interface is accepted, not just VerboseLogger. The README and createLogger implementation both treat the field as Logger | 'verbose' | undefined, so callers writing custom loggers will hit no runtime problem; they just see misleading documentation that suggests they have to use VerboseLogger.

Expected behavior

The docstring should describe the field as accepting any Logger implementation (with VerboseLogger mentioned as the built-in option), the string 'verbose', or undefined.

Minimal reproduction

Open src/types.ts and inspect the comment block on the logger field of LoopCliConfig (around line 103), then compare with the LoggerSpec definition in src/loggers.ts.

Suggested fix

Update the docstring to refer to Logger (the public interface) rather than VerboseLogger. For example:

Controls verbose diagnostic logging to stderr. Accepts a concrete
`Logger` instance, the string `'verbose'` (which creates an enabled
`VerboseLogger`), or `undefined` (quiet, the default).
Lingua principale
TypeScript
Stelle
2
Fork
1
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 joewalker/loop-the-loop

Tutte le issue di joewalker/loop-the-loop

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.