Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Pre-existing bugs found while reviewing #151

未关闭
  • 哪里不对？
#179 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
30/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
shell
领域
cli

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Shell
星标
3.3k
派生
2.7k
平均合并
1 小时 7 分钟
30 天内合并 PR
9

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

ekalinin/github-markdown-toc 的其他 Issue

查看 ekalinin/github-markdown-toc 的全部 Issue

相似的 Issue

更多 Shell/Bash Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。