中文 Markdown 編寫格式規(guī)范的命令行工具 lint-md

wdzgege 發(fā)布于2019-08-23 13:48 / 854人閱讀

摘要：用于檢查中文編寫格式規(guī)范的命令行工具，基于開發(fā)，且方便集成。忽略不檢查該規(guī)則警告，但不阻斷錯誤，且阻斷通過來忽略文件和目錄，語法。

lint-md

用于檢查中文 markdown 編寫格式規(guī)范的命令行工具，基于 AST 開發(fā)，且方便集成 ci。Cli tool to lint your markdown file for Chinese.

安裝

npm i -g lint-md

使用

Usage:   [options]

lint your markdown files

Options:
  -v, --version                  output the version number
  -c, --config [configure-file]  use the configure file, default .lintmdrc
  -h, --help                     output usage information

Example:

lint-md README.md Document.md

檢查類型

檢查規(guī)則來源于 chinese-document-style-guide.

規(guī)則	詳細描述	解決辦法
space-round-alphabet	中文與英文之間需要增加空格	對應提示的位置增加空格
space-round-number	中文與數(shù)字之間需要增加空格	對應提示的位置增加空格
no-empty-code-lang	代碼語言不能為空	在代碼塊語法上增加語言
no-empty-url	鏈接和圖片地址不能為空	填寫完整的 url，或者不使用鏈接和圖片語法
no-empty-list	List 內(nèi)容不能為空	List 語法中，填寫內(nèi)容
no-empty-code	代碼塊內(nèi)容不能為空	刪除空的代碼塊，或者填充代碼內(nèi)容
no-empty-blockquote	blockquote 內(nèi)容不能為空	刪除空的 blockquote，或者填充內(nèi)容
no-special-characters	文本中不能有特殊字符	可能是復制出來的特殊字符，刪除特殊字符即可
use-standard-ellipsis	使用標準規(guī)范的省略號	使用標準規(guī)范的省略號‘……’ / ‘...’
no-fullwidth-number	不能用全角數(shù)字	注意輸入法切換為半角輸入
no-space-in-emphasis	emphasis 內(nèi)容前后不能有空格	刪除 emphasis 內(nèi)容中的前后空格即可
no-space-in-link	link 內(nèi)容前后不能有空格	刪除 link 內(nèi)容中的前后空格即可
no-multiple-space-blockquote	blockquote 語法不能包含有多個空格	刪除 blockquote 內(nèi)容中多余的空格
no-trailing-punctuation	標題不能以標點符號結尾	刪除標題最后的標點符號

目前僅僅檢查了比較通用的類型，歡迎 pull request，在 rules 中增加自己的規(guī)則，開發(fā)約束：

規(guī)則主要針對于中文 markdown 的編寫規(guī)范

使用類 babel plugin 的方式來進行規(guī)則檢查，一個插件對應一個規(guī)則

規(guī)則名稱對應和插件文件名保持一致

先提 issue 進行討論

AST 工具，使用其中的 markdown AST 輔助開發(fā)插件

配置

默認所有的規(guī)則都是 error 類型，但是可以通過配置來指定規(guī)則類型。示例 .lintmdrc ：

{
  "excludeFiles": [],
  "rules": {
    "no-empty-code": 1
  }
}

通過 rules 來配置規(guī)則的等級。

0：ignore 忽略不檢查該規(guī)則

1：warning 警告，但不阻斷 ci

2：error 錯誤，且阻斷 ci

通過 excludeFiles 來忽略文件和目錄，glob 語法。

ci 集成

Travis

在 .travis.yml 文件中配置以下內(nèi)容。

language: node_js
node_js:
  - "10"
before_install:
  - npm i -g lint-md
script: lint-md README.md

lint-stage

在 package.json 中增加以下配置。

"lint-staged": {
  "src/**/*.{md,markdown}": [
    "lind-md"
  ]
}

License

MIT@hustcc.

GPU云服務器云服務器 linux命令行格式命令行工具 php命令行工具服務器格式化命令行

文章版權歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/99581.html

一個前端程序猿的Sublime Text3的自我修養(yǎng)

摘要：效果如下配置方法參考下的配置方法完美支持提供了比默認更好的語法高亮，而且他完美支持。語法高亮默認安裝的對的支持讓人抓狂，幀動畫別開玩笑了你只會看到一片白色的純文本一樣的代碼。事實上不光，我建議用完全替代原來的來完成語法高亮。文章轉(zhuǎn)載自本人的博客《三省吾身丶丶》點擊查看喜歡的話請瘋狂的推薦吧！ ^_^ 本文章會在本人有插件或者設置更新時，進行不定時更新偷懶了，圖片地址直接設置的博客...

KunMinX 2019-08-22 10:59 評論0 收藏0
【持續(xù)集成你的項目】為你的項目創(chuàng)建自動化測試和代碼覆蓋率測試

摘要：單元測試中，代碼覆蓋率經(jīng)常被用來衡量測試好壞的指標。執(zhí)行的結果和導出的結果都可以在的下看到接下來就是把這些文件到上，就會自動構建，然后開始單元測試，并把測試結果中的代碼覆蓋率發(fā)送到。本文以PHP項目作為例子所需要擁有(準備)的： Github賬號一個項目看著篇幅挺大的，難免有什么遺漏，如果文中有錯誤的地方，還請各位斧正！謝謝。因為本來篇幅就大，所以就沒配圖了，如果有很多人反...

Jeff 2019-06-27 13:42 評論0 收藏0
可參照的規(guī)范化標準

摘要：編碼規(guī)范譯代碼標準中文版譯文編寫高質(zhì)量的代碼從命名入手中文排版一個可配置的更適合閱讀的中文文章樣式庫中文網(wǎng)頁重設與排版一致化瀏覽器排版效果，構建最適合中文閱讀的網(wǎng)頁排版。盡信書，不如無書 - 《孟子》這是精辟透脫的讀書法，要求讀者善于獨立思考問題 - 百科但你苦苦尋找一種可行的規(guī)范化文案的時候，不如集大家之廣益，好則取之。編碼規(guī)范 PHP Standard Recomme...

Freelander 2019-07-01 12:14 評論0 收藏0
【效率專精系列】善用API統(tǒng)一描述語言提升RestAPI開發(fā)效率

摘要：其標準為前身是，提供強大的在線編輯功能，包括語法高亮錯誤提示自動完成實時預覽，并且支持用戶以格式撰寫導入導出轉(zhuǎn)換文檔。團隊內(nèi)部RestAPI開發(fā)采用設計驅(qū)動開發(fā)的模式，即使用API設計文檔解耦前端和后端的開發(fā)過程，雙方只在聯(lián)調(diào)與測試時耦合。在實際開發(fā)和與前端合作的過程中，受限于眾多因素的影響，開發(fā)效率還有進一步提高的空間。本文的目的是優(yōu)化工具鏈支持，減少一部分重復和枯燥的勞動。現(xiàn)狀...

tianyu 2019-08-16 10:42 評論0 收藏0
Sublime Text3配置使用教程整理

摘要：安裝完添加如下配置可自動在保存文件的時候格式化中文輸入法不能跟隨光標嗎試試這個插件吧目前只支持和裝完之后，寫作時右下角顯示語法為，可以按，直接就會生成，并在瀏覽器中顯示。 Win平臺上已經(jīng)打造了便攜版的Sublime Text3,但是，現(xiàn)在折騰Ubuntu不能同步過來使用了，寒假在家休息，整理一下安裝過程好了：安裝sublime 在sublime text官網(wǎng)選擇合適的版本安裝。 u...

Martin91 2019-08-19 17:38 評論0 收藏0