跳至主要內容

GitHub 上的 nycrc 設定

根據 GitHub 上 .nycrc 設定檔 中儲存的閾值,建立程式碼覆蓋率徽章。

路徑參數
user 字串 必要

範例:yargs

repo 字串 必要

範例:yargs

查詢參數
config 字串

範例:.nycrc

preferredThreshold 字串

可能的值: [branches, lines, functions]

範例:lines

style 字串

可能的值: [flat, flat-square, plastic, for-the-badge, social]

如果未指定,此徽章的預設樣式為 "flat"。

範例:flat

logo 字串

來自 simple-icons 的圖示縮略名。您可以點擊 simple-icons 上的圖示標題來複製縮略名,或者可以在 simple-icons 儲存庫的 slugs.md 檔案中找到它們。更多資訊

範例:appveyor

logoColor 字串

圖示的顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。支援 simple-icons 圖示,但不支援自訂圖示。

範例:violet

logoSize 字串

透過設定 auto 使圖示能夠自適應調整大小。對於某些較寬的圖示(例如 amdamg)很有用。支援 simple-icons 圖示,但不支援自訂圖示。

範例:auto

label 字串

覆寫預設的左側文字(空格或特殊字元需要 URL 編碼!)

範例:healthiness

labelColor 字串

左側部分的背景顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。

範例:abcdef

color 字串

右側部分的背景顏色(支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色)。

範例:fedcba

cacheSeconds 字串

HTTP 快取存留時間(規則會被應用以推斷每個徽章的預設值,任何低於預設值的值都會被忽略)。

範例:3600

link 字串[]

指定點擊徽章的左側/右側時應執行的操作。請注意,這僅在使用 <object> HTML 標籤整合徽章時有效,但在使用 <img> 標籤或標記語言時無效。