• <dd id="3gzlp"></dd>

    <li id="3gzlp"><acronym id="3gzlp"></acronym></li>

    <span id="3gzlp"></span>

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

    MIT
    JavaScript 查看源碼»
    跨平臺
    2018-11-23
    小薇

    lint-md

    用于檢查中文 markdown 編寫格式規范的命令行工具,基于 AST 開發,且方便集成 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

    檢查類型

    檢查規則來源于 chinese-document-style-guide.

    規則詳細描述解決辦法
    space-round-alphabet中文與英文之間需要增加空格對應提示的位置增加空格
    space-round-number中文與數字之間需要增加空格對應提示的位置增加空格
    no-empty-code-lang代碼語言不能為空在代碼塊語法上增加語言
    no-empty-url鏈接和圖片地址不能為空填寫完整的 url,或者不使用鏈接和圖片語法
    no-empty-listList 內容不能為空List 語法中,填寫內容
    no-empty-code代碼塊內容不能為空刪除空的代碼塊,或者填充代碼內容
    no-empty-blockquoteblockquote 內容不能為空刪除空的 blockquote,或者填充內容
    no-special-characters文本中不能有特殊字符可能是復制出來的特殊字符,刪除特殊字符即可
    use-standard-ellipsis使用標準規范的省略號使用標準規范的省略號‘……’ / ‘...’
    no-fullwidth-number不能用全角數字注意輸入法切換為半角輸入

    目前僅僅檢查了比較通用的類型,歡迎 pull request,在 rules 中增加自己的規則,開發約束:

    • 規則主要針對于中文 markdown 的編寫規范

    • 使用類 babel plugin 的方式來進行規則檢查,一個插件對應一個規則

    • 規則名稱對應和插件文件名保持一致

    • 先提 issue 進行討論

    • AST 工具,使用其中的 markdown AST 輔助開發插件

    配置

    默認所有的規則都是 error 類型,但是可以通過配置來指定規則類型。示例 .lintmdrc :

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

    通過 rules 來配置規則的等級。

    • 0:ignore 忽略不檢查該規則

    • 1:warning 警告,但不阻斷 ci

    • 2:error 錯誤,且阻斷 ci

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

    ci 集成

    • Travis

    在 .travis.yml 文件中配置以下內容。

    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.

    的碼云指數為
    超過 的項目
    加載中
    此軟件有 3 條評論,請先登錄后再查看。

    中文 markdown 格式校驗 lint-md v0.1.0,支持 --fix 參數

    用于檢查中文 markdown 編寫格式規范的命令行工具,基于 AST 開發,且方便集成 ci;同時提供 API 方法調用。Cli tool to lint your markdown file for Chinese. 安裝 npm i -g lint-md 使用 ...

    2018/12/30 22:36

    中文 markdown 格式校驗 lint-md v0.0.6,支持 API 調用

    lint-md 用于檢查中文 markdown 編寫格式規范的命令行工具,基于 AST 開發,且方便集成 ci;同時提供 API 方法調用。Cli tool to lint your markdown file for Chinese. 安裝 npm i -g lint-...

    2018/12/14 09:26

    沒有更多內容

    加載失敗,請刷新頁面

    沒有更多內容

    暫無問答

    lint 工具

    用lint工具檢查項目,需要在sdk的tool目錄下運行,或者配置好環境變量,并生成html報告: lint?<project?directory>?--html?<filename> 也可以右鍵項目,點Android Tools里的Run Lint。...

    2015/04/10 10:41
    23
    0
    PC-Lint

    This file contains the text of the FlexeLint/PC-lint error messages. It is to be used in conjunction with licensed FlexeLint/PC-lint software. Copyright (C) 1985-2008 Gimpel Sof...

    2019/06/25 20:44
    30
    0
    Lint檢查選項

    一、lint檢查可以通過tools:ignore忽略 lint –list Valid issue categories: issue id 種類 Correctness Correctness:Messages Security Performance Usability:Typography Usability:Icons...

    2019/08/12 16:37
    42
    0
    pc_lint的使用

    http://wenku.baidu.com/view/6cad39b469dc5022aaea005e.html

    2012/01/04 20:44
    38
    0
    Android Lint使用分析

    這篇文章介紹關于Android代碼優化工具之Android Lint的使用總結。Android Lint是ADT版本16提供的Android代碼優化工具,它能夠幫助程序員快速方便的發現代碼中的不足之處,并盡可能給予你提供...

    2015/12/29 22:36
    32
    0
    自定義 Lint 規則簡介

    上個月,筆者在巴黎 Droidcon 的 BarCamp 研討會上聆聽了 Matthew Compton 關于編寫自己的 Lint 規則的講話。深受啟發之后,筆者想就此話題做進一步的探索。...

    2016/02/26 17:17
    50
    3

    沒有更多內容

    加載失敗,請刷新頁面

    返回頂部
    頂部
    聚看影院