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

[ BUG ] --debug leaves an HTML dump in TMPDIR for remote documents

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
58/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
go
Ambito
cli

Direzione di ricerca

Inizia leggendo internal/core/usecase/localmd/localmd.go e internal/core/usecase/remotemd/remotemd.go, quindi esegui la riproduzione con TMPDIR dell’issue. Traccia l’interazione tra il dump di debug e la pulizia differita dei file temporanei e verifica che remote --debug non lasci più un dump orfano, preservando al contempo l’ispezionabilità prevista dell’output.

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

Descrizione

bug

Describe the bug

With --debug, a run against a remote URL leaves an orphaned ghtoc-remote-txt-*.debug.html file in the temporary directory. Nothing ever removes it, so the files accumulate.

RemoteMd downloads the document into a temporary file and delegates to LocalMd. In debug mode LocalMd writes its HTML dump next to the file it was handed, producing <temp>.debug.html. RemoteMd's deferred cleanup removes only the downloaded copy, not the dump.

The dump is also useless where it lands: it is named after a random temporary file, so there is no obvious way to connect it back to the URL that produced it.

To Reproduce

export TMPDIR=/tmp/ghtoc-dbg && mkdir -p "$TMPDIR"
gh-md-toc --debug https://raw.githubusercontent.com/ekalinin/github-markdown-toc.go/master/README.md > /dev/null
ls -1 "$TMPDIR"

Actual:

ghtoc-remote-txt-482196719.debug.html

Expected: nothing left in TMPDIR, or a dump the user can actually find.

Expected behavior

Two reasonable options, and the choice affects whether --debug stays useful for remote input:

  1. Remove it. RemoteMd deletes <temp>.debug.html alongside the temporary Markdown. Smallest change, but --debug then produces nothing inspectable for a remote document, which defeats the flag for that input type.
  2. Relocate it. Write the dump into the working directory under a name derived from the URL, for example README.md.debug.html. Keeps the flag useful and matches what already happens for local files, where the dump lands next to the document and is covered by the *.debug.html rule in .gitignore.

Environment (please complete the following information):

  • OS: macOS (darwin/arm64), reproduces on any platform
  • Version: reproduced at 2.0.1 and on current master

Additional context

Pre-existing, not introduced by any open pull request.

The same class of bug affected --skip-header, where the dump was named after an internal trimmed copy and stranded in TMPDIR the same way. That one is fixed in #79 by naming the dump after the document the user passed rather than after the internal temporary file. RemoteMd was deliberately left out of that change: its display path is a URL, not a filesystem path, so the same fix does not apply directly and the destination is a real decision rather than a mechanical one.

See internal/core/usecase/localmd/localmd.go (debug dump) and internal/core/usecase/remotemd/remotemd.go (temporary file cleanup).

Lingua principale
Go
Stelle
525
Fork
90
Merge medio
2g 1h
PR unite (30g)
1

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.go

Tutte le issue di ekalinin/github-markdown-toc.go

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.