背景
在 Markdown 中我們經常會用到表格 , 但是手動排版太麻煩了,特別是表格排序。
在我們的開源專案 React Suite 中,元件的 API 文件,會用到大量的表格, 在寫的時候隨心所欲的寫,釋出上線,然後有人反應,包括我自己也覺得沒有排序的表格,閱讀起來太不爽了。
那怎麼辦?改唄。 本來想讓新來的同事去改的, 然後再一看文件,80 個左右的元件再加上中英文兩個版本,有 160 個左右的表格需要改,每一個表格如果要人工調整是很痛苦的。交給新同事太殘忍了,還是自己寫個工具解決吧。
本來想找個現成的工具,但是沒找到,然後看了看類似的表格的格式化 VS Code 的外掛,然後隨手就改了改,寫了一個可以排序的小外掛,希望可以幫到您。
效果
格式化前大概長成這個樣子,亂七八糟。
| name | email | description |
| -- | -- | --- |
| zhang | zhang@a.com | zhang |
| wang | wang@a.com | wang |
| li | li@a.com | li |
| amity | amity@a.com | amity |
| batman | batman@a.com | batman |
複製程式碼
格式後,就整齊了,同時 name
一列按照字母排序了。
| name | email | description |
| ------ | ------------ | ----------- |
| amity | amity@a.com | amity |
| batman | batman@a.com | batman |
| li | li@a.com | li |
| wang | wang@a.com | wang |
| zhang | zhang@a.com | zhang |
複製程式碼
表格的格式我用的是prettier
,它提供很方便的 API。
安裝
在 VS Code Extensions 中搜尋: Markdown Table Sort