npm 包 mos-plugin-shields 使用教程

阅读时长 4 分钟读完

介绍

mos-plugin-shields 是一个用于在 Markdown 文件中自动生成徽章(badge)的 Mos 插件。徽章是一种常见的视觉元素,可以展示项目的状态或者属性,例如构建状态、测试覆盖率等。

使用 mos-plugin-shields 可以方便地生成徽章,并且可以将其集成到 Mos 构建流程中。

安装

在使用 mos-plugin-shields 之前,需要先安装它。可以通过 npm 进行安装:

安装完成后,在 Mos 配置文件中引入该插件:

使用方法

mos-plugin-shields 支持两种类型的徽章:静态徽章和动态徽章。静态徽章是指不会随时间变化而改变内容的徽章;动态徽章则是指内容可能会随时间变化而改变的徽章。

静态徽章

要生成静态徽章,可以使用以下格式:

其中,各个参数的含义如下:

  • <LABEL>:徽章标签,表示徽章的名称。
  • <MESSAGE>:徽章消息,表示徽章的内容。
  • <COLOR>:徽章颜色,表示徽章的背景颜色。可以使用预设的颜色名,也可以使用 RGB 或者 HEX 值。

例如,要生成一个标签为“Version”的静态徽章,内容为“1.0.0”,背景颜色为绿色,可以使用以下代码:

动态徽章

要生成动态徽章,可以使用以下格式:

其中,各个参数的含义如下:

  • <LABEL>:徽章标签,表示徽章的名称。
  • <QUERY>:查询字符串,表示从 JSON 数据中提取数据的方式。
  • <URL>:JSON 数据的地址。
  • <COLOR>:徽章颜色,表示徽章的背景颜色。可以使用预设的颜色名,也可以使用 RGB 或者 HEX 值。

例如,要生成一个标签为“Downloads”的动态徽章,内容为 npm 包的下载次数,背景颜色为绿色,可以使用以下代码:

其中,$.downloads.total 表示从 JSON 数据中提取 total 字段的值。

示例代码

以下是一个使用 mos-plugin-shields 生成徽章的示例:

纠错
反馈