From 656b34011a482544a9ebb4116332c044834bdbbf Mon Sep 17 00:00:00 2001 From: Corey Sciuto Date: Sun, 1 Oct 2023 05:57:15 -0400 Subject: [PATCH] Repairing setext heading support, certain uses of backticks after GitHub API format changes (#145) * Fix parsing of HTML returned from raw API Github must have changed something on their end, the HTML seems to have changed a little. * Adding some tests for setext header support * Fixing the formatter * Putting all the tests in the same directory * Closer, but span tag doesn't work in some cases * Fixed span issue * Broke test formatting * fixing local tests - remote is busted, formatting seems very different. --------- Co-authored-by: Jon Burgess --- gh-md-toc | 19 +- tests/{ => test directory}/test_backquote.md | 0 .../test directory/test_filepathwithspace.md | 9 +- tests/test directory/test_nonenglishchars.md | 451 ++++++++++++++++++ tests/{ => test directory}/test_plussign.md | 0 .../test_setextwithformatting.md | 44 ++ tests/tests.bats | 30 +- 7 files changed, 538 insertions(+), 15 deletions(-) rename tests/{ => test directory}/test_backquote.md (100%) create mode 100644 tests/test directory/test_nonenglishchars.md rename tests/{ => test directory}/test_plussign.md (100%) create mode 100644 tests/test directory/test_setextwithformatting.md diff --git a/gh-md-toc b/gh-md-toc index 2abb7be..471a3ca 100755 --- a/gh-md-toc +++ b/gh-md-toc @@ -218,6 +218,11 @@ gh_toc(){ # $2 - number of spaces used to indent. # gh_toc_grab() { + + href_regex="/href=\"[^\"]+?\"/" + lefttext_regex="/()(.*)([^<]* is on the new line, then move it on the prev line # for example: @@ -265,6 +271,9 @@ gh_toc_grab() { # became: The command foo1 sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' | + # Sometimes a line can start with . Fix that. + sed -e ':a' -e 'N' -e '$!ba' -e 's/\n - -- [Title](#title) - - [This is test for file path with space](#this-is-test-for-file-path-with-space) - - - - +* [Title](#title) + * [This is test for file path with space](#this-is-test-for-file-path-with-space) Blabla... diff --git a/tests/test directory/test_nonenglishchars.md b/tests/test directory/test_nonenglishchars.md new file mode 100644 index 0000000..7677f58 --- /dev/null +++ b/tests/test directory/test_nonenglishchars.md @@ -0,0 +1,451 @@ +[ Languages: [English](README.md), [Español](README-es.md), [Português](README-pt.md), [中文](README-zh.md) ] + + +# 命令行的艺术 + +[![Join the chat at https://gitter.im/jlevy/the-art-of-command-line](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jlevy/the-art-of-command-line?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +- [必读](#必读) +- [基础](#基础) +- [日常使用](#日常使用) +- [文件及数据处理](#文件及数据处理) +- [系统调试](#系统调试) +- [一行代码](#一行代码) +- [冷门但有用](#冷门但有用) +- [更多资源](#更多资源) +- [免责声明](#免责声明) +- [授权条款](#授权条款) + + +![curl -s 'https://raw.githubusercontent.com/jlevy/the-art-of-command-line/master/README.md' | egrep -o '`\w+`' | tr -d '`' | cowsay -W50](cowsay.png) + +熟练使用命令行是一种常常被忽视或被认为难以掌握的技能，但实际上，它可以提高你作为工程师的灵活性以及生产力。本文是一份我在 Linux 上工作时发现的一些关于命令行的使用的小技巧的摘要。这些小技巧有基础的、相当复杂的甚至晦涩难懂的。这篇文章并不长，但当你能够熟练掌握这里列出的所有技巧时，你就学会了很多关于命令行的东西了。 + +这里的大部分内容 +[首次](http://www.quora.com/What-are-some-lesser-known-but-useful-Unix-commands) +[出现](http://www.quora.com/What-are-the-most-useful-Swiss-army-knife-one-liners-on-Unix) +于 [Quora](http://www.quora.com/What-are-some-time-saving-tips-that-every-Linux-user-should-know)，但考虑到这里的人们都具有学习的天赋且乐于接受别人的建议，使用 Github 来做这件事是更佳的选择。如果你在本文中发现了错误或者存在可以改善的地方，请果断提交 Issue 或 Pull Request！(当然在提交前请看一下必读节和已有的 PR/issue）。 + + +## 必读 + +涵盖范围： + +- 这篇文章对刚接触命令行的新手以及具有命令行使用经验的人都有用处。本文致力于做到覆盖面广（尽量包括一切重要的内容），具体（给出最常见的具体的例子）以及简洁（避免一些不必要的东西以及一些偏题的可以在其他地方翻阅到文献的东西）。 每个小技巧在某个特定情境下都是基本的或能够显著地节约时间。 +- 本文为 Linux 所写，但很多内容（并非所有的）同样适用于 MacOS 甚至 Cygwin。 +- 本文关注于交互式 Bash，尽管很多技巧适用于其他 shell 或 Bash 脚本。 +- 本文包括了“标准的”Unix 命令和需要安装特定包的命令，只要它们足够重要。 + +注意事项： + +- 为了能在一页内展示尽量多的东西，一些具体的信息会被间接的包含在引用页里。聪明机智的你如果掌握了使用 Google 搜索引擎的基本思路与命令，那么你将可以查阅到更多的详细信息。使用 `apt-get`／`yum`／`dnf`／`pacman`／`pip`／`brew`（以及其它合适的包管理器）来安装新程序。 +- 使用 [Explainshell](http://explainshell.com/) 去获取相关命令、参数、管道等内容的解释。 + + +## 基础 + +- 学习 Bash 的基础知识。具体来说，输入 `man bash` 并至少全文浏览一遍; 它很简单并且不长。其他的 shell 可能很好用，但 Bash 功能强大且几乎所有情况下都是可用的 （ *只*学习 zsh，fish 或其他的 shell 的话，在你自己的电脑上会显得很方便，但在很多情况下会限制你，比如当你需要在服务器上工作时）。 + +- 学习并掌握至少一个基于文本的编辑器。通常 Vim （`vi`） 会是你最好的选择。 + +- 学会如何使用 `man` 命令去阅读文档。学会使用 `apropos` 去查找文档。了解有些命令并不对应可执行文件，而是Bash内置的，可以使用 `help` 和 `help -d` 命令获取帮助信息。 + +- 学会使用 `>` 和 `<` 来重定向输出和输入，学会使用 `|` 来重定向管道。了解标准输出 stdout 和标准错误 stderr。 + +- 学会使用通配符 `*` （或许再算上 `?` 和 `{`...`}`） 和引用以及引用中 `'` 和 `"` 的区别。 + +- 熟悉 Bash 任务管理工具：`&`，**ctrl-z**，**ctrl-c**，`jobs`，`fg`，`bg`，`kill` 等。 + +- 了解 `ssh`，以及基本的无密码认证，`ssh-agent`，`ssh-add` 等。 + +- 学会基本的文件管理：`ls` 和 `ls -l` （了解 `ls -l` 中每一列代表的意义），`less`，`head`，`tail` 和 `tail -f` （甚至 `less +F`），`ln` 和 `ln -s` （了解硬链接与软链接的区别），`chown`，`chmod`，`du` （硬盘使用情况概述：`du -hk *`）。 关于文件系统的管理，学习 `df`，`mount`，`fdisk`，`mkfs`，`lsblk`。 + +- 学习基本的网络管理：`ip` 或 `ifconfig`，`dig`。 + +- 熟悉正则表达式，以及 `grep`／`egrep` 里不同参数的作用，例如 `-i`，`-o`，`-A`，和 `-B`。 + +- 学会使用 `apt-get`，`yum`，`dnf` 或 `pacman` （取决于你使用的 Linux 发行版）来查找或安装包。确保你的环境中有 `pip` 来安装基于 Python 的命令行工具 （部分程序使用 `pip` 来安装会很简单）。 + + +## 日常使用 + +- 在 Bash 中，可以使用 **Tab** 自动补全参数，使用 **ctrl-r** 搜索命令行历史。 + +- 在 Bash 中，使用 **ctrl-w** 删除你键入的最后一个单词，使用 **ctrl-u** 删除整行，使用 **alt-b** 和 **alt-f** 按单词移动，使用 **ctrl-k** 从光标处删除到行尾，使用 **ctrl-l** 清屏。键入 `man readline` 查看 Bash 中的默认快捷键，内容很多。例如 **alt-.** 循环地移向前一个参数，以及 **alt-*** 展开通配符。 + +- 你喜欢的话，可以键入 `set -o vi` 来使用 vi 风格的快捷键。 + +- 键入 `history` 查看命令行历史记录。其中有许多缩写，例如 `!$`（最后键入的参数）和 `!!`（最后键入的命令），尽管通常被 **ctrl-r** 和 **alt-.** 取代。 + +- 回到上一个工作路径：`cd -` + +- 如果你输入命令的时候改变了主意，按下 **alt-#** 在行首添加 `#`（将你输入的命令视为注释），并回车。这样做的话，之后你可以很方便的利用命令行历史回到你刚才输入到一半的命令。 + +- 使用 `xargs` （ 或 `parallel`）。他们非常给力。注意到你可以控制每行参数个数（`-L`）和最大并行数（`-P`）。如果你不确定它们是否会按你想的那样工作，先使用 `xargs echo` 查看一下。此外，使用 `-I{}` 会很方便。例如： +```bash + find . -name '*.py' | xargs grep some_function + cat hosts | xargs -I{} ssh root@{} hostname +``` + +- `pstree -p` 有助于展示进程树。 + +- 使用 `pgrep` 和 `pkill` 根据名字查找进程或发送信号。 + +- 了解你可以发往进程的信号的种类。比如，使用 `kill -STOP [pid]` 停止一个进程。使用 `man 7 signal` 查看详细列表。 + +- 使用 `nohup` 或 `disown` 使一个后台进程持续运行。 + +- 使用 `netstat -lntp` 或 `ss -plat` 检查哪些进程在监听端口（默认是检查 TCP 端口; 使用参数 `-u` 检查 UDP 端口）。 + +- 有关打开套接字和文件，请参阅 `lsof`。 + +- 在 Bash 脚本中，使用 `set -x` 去调试输出，尽可能的使用严格模式，使用 `set -e` 令脚本在发生错误时退出而不是继续运行，使用 `set -o pipefail` 严谨地对待错误（尽管问题可能很微妙）。当牵扯到很多脚本时，使用 `trap`。 + +- 在 Bash 脚本中，子 shell（使用括号`(...)`）是一种便捷的方式去组织参数。一个常见的例子是临时地移动工作路径，代码如下： +```bash + # do something in current dir + (cd /some/other/dir && other-command) + # continue in original dir +``` + +- 在 Bash 中，注意到其中有许多形式的扩展。检查变量是否存在：`${name:?error message}`。例如，当 Bash 脚本需要一个参数时，可以使用这样的代码 `input_file=${1:?usage: $0 input_file}`。数学表达式：`i=$(( (i + 1) % 5 ))`。序列：`{1..10}`。 截断字符串：`${var%suffix}` 和 `${var#prefix}`。例如，假设 `var=foo.pdf`，那么 `echo ${var%.pdf}.txt` 将输出 `foo.txt`。 + +- 通过使用 `<(some command)` 可以将输出视为文件。例如，对比本地文件 `/etc/hosts` 和一个远程文件： +```sh + diff /etc/hosts <(ssh somehost cat /etc/hosts) +``` + +- 了解 Bash 中的“here documents”，例如 `cat <logfile 2>&1`。通常，为了保证命令不会在标准输入里残留一个打开了的文件句柄导致你当前所在的终端无法操作，添加 ` foo: + rename 's/\.bak$//' *.bak + # Full rename of filenames，directories，and contents foo -> bar: + repren --full --preserve-case --from foo --to bar . +``` + +- 使用 `shuf` 从一个文件中随机选取行。 + +- 了解 `sort` 的参数。明白键的工作原理（`-t` 和 `-k`）。例如，注意到你需要 `-k1，1` 来仅按第一个域来排序，而 `-k1` 意味着按整行排序。稳定排序（`sort -s`）在某些情况下很有用。例如，以第二个域为主关键字，第一个域为次关键字进行排序，你可以使用 `sort -k1，1 | sort -s -k2，2`。处理可读性数字（例如 `du -h` 的输出）的时候使用 `sort -h` 。 + +- 如果你想在 Bash 命令行中写 tab 制表符，按下 **ctrl-v** **[Tab]** 或键入 `$'\t'` （后者可能更好，因为你可以复制粘贴它）。 + +- 标准的源代码对比及合并工具是 `diff` 和 `patch`。使用 `diffstat` 查看变更总览数据。注意到 `diff -r` 对整个文件夹有效。使用 `diff -r tree1 tree2 | diffstat` 查看变更总览数据。 + +- 对于二进制文件，使用 `hd` 使其以十六进制显示以及使用 `bvi` 来编辑二进制。 + +- 同样对于二进制文件，使用 `strings`（包括 `grep` 等等）允许你查找一些文本。 + +- 二进制文件对比（Delta 压缩），使用 `xdelta3`。 + +- 使用 `iconv` 更改文本编码。而更高级的用法，可以使用 `uconv`，它支持一些高级的 Unicode 功能。例如，这条命令将所有元音字母转为小写并移除了： +```sh + uconv -f utf-8 -t utf-8 -x '::Any-Lower; ::Any-NFD; [:Nonspacing Mark:] >; ::Any-NFC; ' < input.txt > output.txt +``` + +- 拆分文件，查看 `split`（按大小拆分）和 `csplit`（按模式拆分）。 + +- 使用 `zless`，`zmore`，`zcat` 和 `zgrep`对压缩过的文件进行操作。 + + +## 系统调试 + +- `curl` 和 `curl -I` 可以便捷地被应用于 web 调试中，它们的好兄弟 `wget` 也可以，或者是更潮的 [`httpie`](https://github.com/jakubroztocil/httpie)。 + +- 使用 `iostat`、`netstat`、`top` （`htop` 更佳）和 `dstat` 去获取硬盘、cpu 和网络的状态。熟练掌握这些工具可以使你快速的对系统的当前状态有一个大概的认识。 + +- 若要对系统有一个深度的总体认识，使用 [`glances`](https://github.com/nicolargo/glances)。它在一个终端窗口中向你提供一些系统级的数据。这对于快速的检查各个子系统非常有帮助。 + +- 若要了解内存状态，运行并理解 `free` 和 `vmstat` 的输出。尤其注意“cached”的值，它指的是 Linux 内核用来作为文件缓存的内存大小，因此它与空闲内存无关。 + +- Java 系统调试则是一件截然不同的事，一个可以用于 Oracle 的 JVM 或其他 JVM 上的调试的小技巧是你可以运行 `kill -3 ` 同时一个完整的栈轨迹和堆概述（包括 GC 的细节）会被保存到标准输出/日志文件。 + +- 使用 `mtr` 去跟踪路由，用于确定网络问题。 + +- 用 `ncdu` 来查看磁盘使用情况，它比常用的命令，如 `du -sh *`，更节省时间。 + +- 查找正在使用带宽的套接字连接或进程，使用 `iftop` 或 `nethogs`。 + +- `ab` 工具（捆绑于 Apache）可以简单粗暴地检查 web 服务器的性能。对于更复杂的负载测试，使用 `siege`。 + +- `wireshark`，`tshark` 和 `ngrep` 可用于复杂的网络调试。 + +- 了解 `strace` 和 `ltrace`。这俩工具在你的程序运行失败、挂起甚至崩溃，而你却不知道为什么或你想对性能有个总体的认识的时候是非常有用的。注意 profile 参数（`-c`）和附加到一个运行的进程参数 （`-p`）。 + +- 了解使用 `ldd` 来检查共享库。 + +- 了解如何运用 `gdb` 连接到一个运行着的进程并获取它的堆栈轨迹。 + +- 学会使用 `/proc`。它在调试正在出现的问题的时候有时会效果惊人。比如：`/proc/cpuinfo`，`/proc/xxx/cwd`，`/proc/xxx/exe`，`/proc/xxx/fd/`，`/proc/xxx/smaps`。 + +- 当调试一些之前出现的问题的时候，`sar` 非常有用。它展示了 cpu、内存以及网络等的历史数据。 + +- 关于更深层次的系统分析以及性能分析，看看 `stap`（[SystemTap](https://sourceware.org/systemtap/wiki)），[`perf`](http://en.wikipedia.org/wiki/Perf_(Linux))，以及[`sysdig`](https://github.com/draios/sysdig)。 + +- 查看你当前使用的 Linux 发行版（大部分发行版有效）：`lsb_release -a` + +- 无论什么东西工作得很欢乐时试试 `dmesg` （可能是硬件或驱动问题）。 + + +## 一行代码 + +一些命令组合的例子： + +- 当你需要对文本文件做集合交、并、差运算时，结合使用 `sort`/`uniq` 很有帮助。假设 `a` 与 `b` 是两内容不同的文件。这种方式效率很高，并且在小文件和上G的文件上都能运用 （`sort` 不被内存大小约束，尽管在 `/tmp` 在一个小的根分区上时你可能需要 `-T` 参数），参阅前文中关于 `LC_ALL` 和 `sort` 的 `-u` 参数的部分。 +```sh + cat a b | sort | uniq > c # c is a union b + cat a b | sort | uniq -d > c # c is a intersect b + cat a b b | sort | uniq -u > c # c is set difference a - b +``` + +- 使用 `grep . *` 来阅读检查目录下所有文件的内容，例如检查一个充满配置文件的目录比如 `/sys`、`/proc`、`/etc`。 + +- 计算文本文件第三列中所有数的和（可能比同等作用的 Python 代码快三倍且代码量少三倍）： +```sh + awk '{ x += $3 } END { print x }' myfile +``` + +- 如果你想在文件树上查看大小\日期，这可能看起来像递归版的 `ls -l` 但比 `ls -lR` 更易于理解： +```sh + find . -type f -ls +``` + +- 尽可能的使用 `xargs` 或 `parallel`。注意到你可以控制每行参数个数（`-L`）和最大并行数（`-P`）。如果你不确定它们是否会按你想的那样工作，先使用 `xargs echo` 查看一下。此外，使用 `-I{}` 会很方便。例如： +```sh + find . -name '*.py' | xargs grep some_function + cat hosts | xargs -I{} ssh root@{} hostname +``` + +- 假设你有一个类似于 web 服务器日志文件的文本文件，并且一个确定的值只会出现在某些行上，假设一个 `acct_id` 参数在URI中。如果你想计算出每个 `acct_id` 值有多少次请求，使用如下代码： +```sh + cat access.log | egrep -o 'acct_id=[0-9]+' | cut -d= -f2 | sort | uniq -c | sort -rn +``` + +- 运行这个函数从这篇文档中随机获取一条小技巧（解析 Markdown 文件并抽取项目）： +```sh + function taocl() { + curl -s https://raw.githubusercontent.com/jlevy/the-art-of-command-line/master/README.md | + pandoc -f markdown -t html | + xmlstarlet fo --html --dropdtd | + xmlstarlet sel -t -v "(html/body/ul/li[count(p)>0])[$RANDOM mod last()+1]" | + xmlstarlet unesc | fmt -80 + } +``` + + +## 冷门但有用 + +- `expr`：计算表达式或正则匹配 + +- `m4`：简单地宏处理器 + +- `yes`：多次打印字符串 + +- `cal`：漂亮的日历 + +- `env`：执行一个命令（脚本文件中很有用） + +- `printenv`：打印环境变量（调试时或在使用脚本文件时很有用） + +- `look`：查找以特定字符串开头的单词 + +- `cut`、`paste` 和 `join`：数据修改 + +- `fmt`：格式化文本段落 + +- `pr`：将文本格式化成页/列形式 + +- `fold`：包裹文本中的几行 + +- `column`：将文本格式化成多列或表格 + +- `expand` 和 `unexpand`：制表符与空格之间转换 + +- `nl`：添加行号 + +- `seq`：打印数字 + +- `bc`：计算器 + +- `factor`：分解因数 + +- `gpg`：加密并签名文件 + +- `toe`：terminfo entries 列表 + +- `nc`：网络调试及数据传输 + +- `socat`：套接字代理，与 `netcat` 类似 + +- `slurm`：网络可视化 + +- `dd`：文件或设备间传输数据 + +- `file`：确定文件类型 + +- `tree`：以树的形式显示路径和文件，类似于递归的 `ls` + +- `stat`：文件信息 + +- `tac`：反向输出文件 + +- `shuf`：文件中随机选取几行 + +- `comm`：一行一行的比较排序过的文件 + +- `pv`：监视通过管道的数据 + +- `hd` 和 `bvi`：保存或编辑二进制文件 + +- `strings`：从二进制文件中抽取文本 + +- `tr`：转换字母 + +- `iconv` 或 `uconv`：简易的文件编码 + +- `split` 和 `csplit`：分割文件 + +- `units`：将一种计量单位转换为另一种等效的计量单位（参阅 `/usr/share/units/definitions.units`） + +- `7z`：高比例的文件压缩 + +- `ldd`：动态库信息 + +- `nm`：提取 obj 文件中的符号 + +- `ab`：性能分析 web 服务器 + +- `strace`：系统调用调试 + +- `mtr`：更好的网络调试跟踪工具 + +- `cssh`：可视化的并发 shell + +- `rsync`：通过 ssh 同步文件和文件夹 + +- `wireshark` 和 `tshark`：抓包和网络调试工具 + +- `ngrep`：网络层的 grep + +- `host` 和 `dig`：DNS 查找 + +- `lsof`：列出当前系统打开文件的工具以及查看端口信息 + +- `dstat`：系统状态查看 + +- [`glances`](https://github.com/nicolargo/glances)：高层次的多子系统总览 + +- `iostat`：CPU 和硬盘状态 + +- `htop`：top 的加强版 + +- `last`：登入记录 + +- `w`：查看处于登录状态的用户 + +- `id`：用户/组 ID 信息 + +- `sar`：系统历史数据 + +- `iftop` 或 `nethogs`：套接字及进程的网络利用 + +- `ss`：套接字数据 + +- `dmesg`：引导及系统错误信息 + +- `hdparm`：SATA/ATA 磁盘更改及性能分析 + +- `lsb_release`：Linux 发行版信息 + +- `lsblk`：列出块设备信息：以树形展示你的磁盘以及磁盘分区信息 + +- `lshw`，`lscpu`，`lspci`，`lsusb` 和 `dmidecode`：查看硬件信息，包括 CPU、BIOS、RAID、显卡、USB设备等 + +- `fortune`，`ddate` 和 `sl`： 额，这主要取决于你是否认为蒸汽火车和莫名其妙的名人名言是否“有用” + + +## 更多资源 + +- [awesome-shell](https://github.com/alebcay/awesome-shell)： 一份精心组织的命令行工具及资源的列表。 +- [Strict mode](http://redsymbol.net/articles/unofficial-bash-strict-mode/)： 为了编写更好的脚本文件。 + + +## 免责声明 + +除去特别微小的任务，记录下这些代码以便他人查看。责任往往伴随着能力，*可以*做并不意味着应该做。 + + +## 授权条款 + +[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/) + +本文使用授权协议 [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)。 \ No newline at end of file diff --git a/tests/test_plussign.md b/tests/test directory/test_plussign.md similarity index 100% rename from tests/test_plussign.md rename to tests/test directory/test_plussign.md diff --git a/tests/test directory/test_setextwithformatting.md b/tests/test directory/test_setextwithformatting.md new file mode 100644 index 0000000..8dd78e4 --- /dev/null +++ b/tests/test directory/test_setextwithformatting.md @@ -0,0 +1,44 @@ +Title one +========= + + +* [Title one](#title-one) + * [This is test for setext-style without formatting](#this-is-test-for-setext-style-without-formatting) +* [Title two](#title-two) + * [This is test for setext-style with formatting](#this-is-test-for-setext-style-with-formatting) +* [Title three](#title-three) + * [This is a regression test for atx-style](#this-is-a-regression-test-for-atx-style) +* [Title four is a particularly long title because of wrapping](#title-four-is-a-particularly-long-title-because-of-wrapping) + * [This is a test for long titles](#this-is-a-test-for-long-titles) + + +Blabla... + +## This is test for setext-style without formatting + +Blabla... + +*Title `two`* +============= + +Blabla... + +## This is test for setext-style with formatting + +Blabla... + +# Title `three` + +Blabla... + +## This is a regression test for atx-style + +Blabla... + +# Title four is a particularly long title because of wrapping + +Blabla... + +## This is a test for long titles + +Blabla... \ No newline at end of file diff --git a/tests/tests.bats b/tests/tests.bats index ee525b9..81638d8 100755 --- a/tests/tests.bats +++ b/tests/tests.bats @@ -154,6 +154,16 @@ test_help() { } @test "TOC for non-english chars, #6, #10" { + run $BATS_TEST_DIRNAME/../gh-md-toc tests/test\ directory/test_nonenglishchars.md + assert_success + + assert_equal "${lines[2]}" "* [命令行的艺术](#命令行的艺术)" + assert_equal "${lines[3]}" " * [必读](#必读)" + assert_equal "${lines[4]}" " * [基础](#基础)" + assert_equal "${lines[5]}" " * [日常使用](#日常使用)" +} + +@test "TOC for non-english chars (remote load), #6, #10" { run $BATS_TEST_DIRNAME/../gh-md-toc \ https://github.com/ekalinin/envirius/blob/f939d3b6882bfb6ecb28ef7b6e62862f934ba945/README.ru.md assert_success @@ -185,7 +195,7 @@ test_help() { } @test "TOC for text with backquote, #13" { - run $BATS_TEST_DIRNAME/../gh-md-toc tests/test_backquote.md + run $BATS_TEST_DIRNAME/../gh-md-toc tests/test\ directory/test_backquote.md assert_success assert_equal "${lines[2]}" "* [The command foo1](#the-command-foo1)" @@ -196,16 +206,30 @@ test_help() { } @test "TOC for text with plus signs, #100" { - run $BATS_TEST_DIRNAME/../gh-md-toc tests/test_plussign.md + run $BATS_TEST_DIRNAME/../gh-md-toc tests/test\ directory/test_plussign.md assert_success assert_equal "${lines[2]}" "* [C vs C++](#c-vs-c)" } @test "Toc for file path with space, #136" { - run $BATS_TEST_DIRNAME/../gh-md-toc --insert tests/test\ directory/test_filepathwithspace.md + run $BATS_TEST_DIRNAME/../gh-md-toc --no-backup --hide-footer tests/test\ directory/test_filepathwithspace.md assert_success assert_equal "${lines[2]}" "* [Title](#title)" assert_equal "${lines[3]}" " * [This is test for file path with space](#this-is-test-for-file-path-with-space)" +} + +@test "Toc for setext heading with formatting, #145" { + run $BATS_TEST_DIRNAME/../gh-md-toc --no-backup --hide-footer tests/test\ directory/test_setextwithformatting.md + assert_success + + assert_equal "${lines[2]}" "* [Title one](#title-one)" + assert_equal "${lines[3]}" " * [This is test for setext-style without formatting](#this-is-test-for-setext-style-without-formatting)" + assert_equal "${lines[4]}" "* [Title two](#title-two)" + assert_equal "${lines[5]}" " * [This is test for setext-style with formatting](#this-is-test-for-setext-style-with-formatting)" + assert_equal "${lines[6]}" "* [Title three](#title-three)" + assert_equal "${lines[7]}" " * [This is a regression test for atx-style](#this-is-a-regression-test-for-atx-style)" + assert_equal "${lines[8]}" "* [Title four is a particularly long title because of wrapping](#title-four-is-a-particularly-long-title-because-of-wrapping)" + assert_equal "${lines[9]}" " * [This is a test for long titles](#this-is-a-test-for-long-titles)" } \ No newline at end of file