Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#78 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
92/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Empieza en src/types.ts, en el docstring de LoopCliConfig.logger, y compara su redacción con la definición de LoggerSpec en src/loggers.ts y con el README o el comportamiento de createLogger mencionados en el issue. Actualiza la documentación para describir cualquier implementación de Logger, la opción 'verbose' y undefined; el trabajo estará terminado cuando el comentario ya no implique que solo se acepta VerboseLogger.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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).
Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de joewalker/loop-the-loop

Todos los issues de joewalker/loop-the-loop

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.