Markdown 中的 Table 一键排序

[simonguo]

背景

在 Markdown 中我们经常会用到表格 , 但是手动排版太麻烦了，特别是表格排序。

在我们的开源项目 React Suite 中，组件的 API 文档，会用到大量的表格, 在写的时候随心所欲的写，发布上线，然后有人反应，包括我自己也觉得没有排序的表格，阅读起来太不爽了。

那怎么办？改呗。 本来想让新来的同事去改的， 然后再一看文档，80 个左右的组件再加上中英文两个版本，有 160 个左右的表格需要改，每一个表格如果要人工调整是很痛苦的。交给新同事太残忍了，还是自己写个工具解决吧。

本来想找个现成的工具，但是没找到，然后看了看类似的表格的格式化 VS Code 的插件，然后随手就改了改，写了一个可以排序的小插件，希望可以帮到您。

效果

格式化前大概长成这个样子，乱七八糟。

| name | email | description |
| -- | -- | --- |
| zhang | [e-mail]  | zhang  |
| wang | [e-mail]   | wang |
| li | [e-mail]   | li  |
| amity | [e-mail]  | amity  |
| batman | [e-mail] | batman |

格式后，就整齐了，同时 name 一列按照字母排序了。

| name   | email        | description |
| ------ | ------------ | ----------- |
| amity  | [e-mail]  | amity       |
| batman | [e-mail] | batman      |
| li     | [e-mail]     | li          |
| wang   | [e-mail]   | wang        |
| zhang  | [e-mail]  | zhang       |

表格的格式我用的是prettier,它提供很方便的 API。

安装

在 VS Code Extensions 中搜索: Markdown Table Sort

• VS Code 安装地址
• 源码地址

[simonguo]

@Daath 只是格式化距离的话，已经有很多插件了，甚至有些编辑器就带这样的功能。prettier 也是支持格式化。 我没必要再去写一个这样的工具。
这个扩展的名字就叫 Markdown Table Sort， 目的就是解决排序问题。

@quinoa42 排序同样可以做成 TableFormat 的一部分，当把 md 中的 Table 抽象在一个数组对象中以后，有什么复杂的排序不能做

[Daath]

@simonguo 恩恩。刚才在 vs 插件上已经找到了 prettier，之前没有接触过 vs 的，没怎么去搜过。哈哈，谢谢啦