[Feature] Warn about headings that skip a level

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github, go
Ambito
backend, cli

Direzione di ricerca

Read the TOC generation and filtering paths for --depth and --start-depth, along with the implementation of --numbered outline referenced in the issue. Decide whether to warn for every skipped level or only cases affected by indentation, and what link the warning should use. Done means warnings go to stderr for the retained entries, with each input checked independently and the TOC output and exit code unchanged.

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

Descrizione

enhancement

Is your feature request related to a problem? Please describe.

When a heading skips a level (# Title followed by ### Skipped), GitHub can render its
TOC entry as text of the parent entry, on one line. The TOC is built without any notice.
The same request for the Bash version is ekalinin/github-markdown-toc#75, and it is
implemented there in ekalinin/github-markdown-toc#187.

Here it depends on the indent. TOCs rendered by the GitHub Markdown API:

Headings Indent Rendered
# Title two, then ### Skipped 2 (default) a nested list, as expected
# Title two, then ### Skipped 3 one item: Title two * Skipped
# Title, then #### Deep 2 (default) one item: Title * Deep

Describe the solution you'd like

The same warning as in the Bash version. For every TOC entry whose heading level is
greater than the level of its parent plus 1, print to stderr:

Warning: heading 'Skipped' (level 3) skips a level after 'Title two' (level 1), see https://github.com/ekalinin/github-markdown-toc/issues/75

Behavior in the Bash version:

  • The TOC does not change: on stdout and in the file with --insert. The warning never
    goes to stdout or into the file, and the exit code stays the same.
  • The parent of an entry is the nearest previous TOC entry with a lower level, as for
    --numbered outline (#92).
  • One line per such entry, in document order. An entry without a parent gets no warning.
  • It applies to every input. With several inputs each document is checked on its own,
    and each line starts with the input as given on the command line, followed by : .
  • With --depth, only the entries kept by --depth are checked, and the parent is taken
    among them.

Additional context

  • Here entries are also dropped by --start-depth. The check should use only the entries
    that stay in the TOC, as with --depth.
  • To decide: warn on every skipped level, as the Bash version does, or only when the
    indent makes GitHub render the entry as text (see the table above).
  • To decide: the link in the message points to the issue of the Bash version.
Lingua principale
Go
Stelle
525
Fork
89
Merge medio
6m
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.