[Feature] Warn about headings that skip a level

Đang mở
  • Có gì không ổn?
#97 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, go
Lĩnh vực
backend, cli

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Go
Star
525
Fork
89
Merge trung bình
6 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ekalinin/github-markdown-toc.go

Tất cả issue của ekalinin/github-markdown-toc.go

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.