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

Pre-existing bugs found while reviewing #151

Abierto
  • ¿Algo no está bien?
#179 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
shell
Área
cli

Línea de trabajo

The five bugs sit in gh-md-toc: the HTTP status check in gh_toc_load (around L38), the stdin read loop (L421-425), the error output (L160-171), and the single-line sed in gh_toc_grab (L290). The issue says to wait for #151, which changes the stdin block and error output, so check that PR first. Done means each checkbox is fixed and reproduced on both Linux and macOS, with the issue's examples giving the expected output.

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

Descripción

Found while reviewing #151. All of these reproduce on current master (9e0a858), #151 doesn't introduce them. Line numbers refer to gh-md-toc at 9e0a858.

  • Remote URL ignores the HTTP status (gh_toc_load, L38). curl -s only fails on network errors, so ./gh-md-toc https://github.com/ekalinin/github-markdown-toc/blob/master/NOPE-404.md prints an empty TOC and exits 0.
  • stdin input is changed before it is sent (L423-425). while read -r input; do echo "$input" >> ... strips leading whitespace, drops a last line without a trailing newline, and echo swallows lines like -n. For printf '# A\n\n # indented code\n-n\n# Last' | ./gh-md-toc - the API gets only # A, an empty line and # indented code, so the indented code block becomes a heading and # Last is lost. cat > "$gh_tmp_md" would keep the input as is.
  • The stdin temp file is never removed (L421). Every gh-md-toc - run leaves a tmp.XXXXXX file with the input markdown in $TMPDIR.
  • Errors go to stdout (L160-171). The network and rate-limit errors are printed with plain echo, so ./gh-md-toc README.md > toc.md writes the error text into toc.md under the "Table of Contents" header. The exit code is 1, but the error ends up in the output file.
  • The rate-limit hint always points to token.txt (L168-169). It's printed even when GH_TOC_TOKEN is set, and in that case token.txt is ignored.
  • Single-line HTML gives an empty TOC on macOS (gh_toc_grab, L290). BSD sed's N on the last line quits without printing, so sed -e ':a' -e 'N' -e '$!ba' ... outputs nothing for one-line input. A document with only one heading renders to one line of HTML, so printf '# A\n' | ./gh-md-toc - prints an empty TOC on macOS, while printf '# A\n\n## B\n' works.

#151 changes the stdin block and the error output, so it's easier to fix these after it's merged.

Lenguaje dominante
Shell
Estrellas
3.3k
Forks
2.7k
Merge medio
3 h 21 min
PR fusionados (30 d)
10

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 ekalinin/github-markdown-toc

Todos los issues de ekalinin/github-markdown-toc

Issues similares

Más issues de Shell/Bash

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.