亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

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

wdzgege / 901人閱讀

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

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ī)則 詳細(xì)描述 解決辦法
space-round-alphabet 中文與英文之間需要增加空格 對應(yīng)提示的位置增加空格
space-round-number 中文與數(shù)字之間需要增加空格 對應(yīng)提示的位置增加空格
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 文本中不能有特殊字符 可能是復(fù)制出來的特殊字符，刪除特殊字符即可
use-standard-ellipsis 使用標(biāo)準(zhǔn)規(guī)范的省略號 使用標(biāo)準(zhǔn)規(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 語法不能包含有多個(gè)空格 刪除 blockquote 內(nèi)容中多余的空格
no-trailing-punctuation 標(biāo)題不能以標(biāo)點(diǎn)符號結(jié)尾 刪除標(biāo)題最后的標(biāo)點(diǎn)符號 
目前僅僅檢查了比較通用的類型，歡迎 pull request，在 rules 中增加自己的規(guī)則，開發(fā)約束：

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

使用類 babel plugin 的方式來進(jìn)行規(guī)則檢查，一個(gè)插件對應(yīng)一個(gè)規(guī)則

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

先提 issue 進(jìn)行討論

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

配置

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

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

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

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

1：warning 警告，但不阻斷 ci

2：error 錯(cuò)誤，且阻斷 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.

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

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

相關(guān)文章

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

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

    KunMinX 評論0 收藏0

  • 【持續(xù)集成你的項(xiàng)目】為你的項(xiàng)目創(chuàng)建自動(dòng)化測試和代碼覆蓋率測試

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

    Jeff 評論0 收藏0

  • 可參照的規(guī)范化標(biāo)準(zhǔn)

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

    Freelander 評論0 收藏0

  • 【效率專精系列】善用API統(tǒng)一描述語言提升RestAPI開發(fā)效率

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

    tianyu 評論0 收藏0

  • Sublime Text3配置使用教程整理

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

    Martin91 評論0 收藏0

發(fā)表評論

0條評論

最新活動(dòng)
閱讀需要支付1元查看
<