npm 包 shield-cli 使用教程

在前端开发中，我们经常需要在项目的 README.md 文件中显示一些项目状态和信息，比如测试和部署状态、代码量和版本号等。这些信息一般都用一个“badge”来呈现，而这个 badge 通常是由 Shields.io 提供的。shield-cli 是一个可以让你在命令行中生成这些 badges 的 npm 包，下面是使用教程。

安装

使用 npm 安装 shield-cli:

--- ------- -- ----------

使用

命令行界面

像在终端中使用 ls、cd 等命令一样，使用下面的命令输入各种信息，然后就能在终端中生成 badge 了！

------ --------------- ------------------- ---------------

如果你想生成一个更复杂的 badge, 请使用下面的命令：

------ -- ------- -- --------- -- ------- -- ------- ------------- ----------------------- -------------------------

接下来，我们来详细说明一下这些参数：

• --label or -l：要显示的 label 文字，比如 "build" 或 "Coverage"
• --message or -m：要显示的信息，比如 "passing" 或 "80%"
• --color or -c：要显示的颜色，可以选以下几种（大小写不敏感）： brightgreen, green, yellowgreen, yellow, orange, red, blue, gray, lightgrey
• --style or -s：可选参数，logo 的风格，比如 flat 或 square 等，默认是 flat
• --logo：可选参数，需要放在 badge 左边的 logo！目前只支持 base64 图片和图片链接，需要使用 javascript: URL。
• --logoWidth：可选参数，logo 宽度，只有在指定 --logo 参数时才有用。
• --logoHeight：可选参数，logo 高度，只有在指定 --logo 参数时才有用。

示例

下面是一些使用 shield-cli 的示例。

生成一个默认的 badge：

------ ------------- ----------------- -------------- 

生成一个标有 logo 的 badge：

------ ------------- ----------------- -------------- ----------------------------------------------

生成一个有自定义大小的 logo 的 badge：

------ -- ----- -- ------- -- ------------- -- ------ ---------------------------------------------- -------------- ---------------

结论

shield-cli 是一个非常好用的 npm 包，可以让我们在项目中方便地生成各种 badge，便于管理和展示项目状态和信息。希望本篇文章能对您有所帮助。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055eac81e8991b448dc259