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

Pre-existing bugs found while reviewing #151

Aperta
  • Qualcosa non va?
#179 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
shell
Ambito
cli

Direzione di ricerca

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.

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

Descrizione

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.

Lingua principale
Shell
Stelle
3.3k
Fork
2.7k
Merge medio
3h 21m
PR unite (30g)
10

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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

Tutte le issue di ekalinin/github-markdown-toc

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.