跳至主要内容

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> 标记或标记语言则无效。