npm 包 badgin 使用教程

介绍

badgin 是一个简单易用的 npm 包，它可以帮助我们快速生成 badge 图标。使用 badge 图标可以方便地在文档、博客、github README 等地方展示项目和代码的状态和信息。

安装

你可以通过 npm 安装 badgin，如下所示：

npm install --save badgin

使用

1. 基本使用

在代码中使用 badgin 需要指定徽章的类型（type）和徽章的值（value）。以生成一个 color 徽章为例：

var badgin = require('badgin');

console.log(badgin('color', 'green'));

运行上述代码，你将会得到一个绿色的徽章，如下所示：

1. 高级使用

badgin 还支持特殊的徽章类型和自定义 SVG 徽章。

特殊的徽章类型包括：

• coverage：测试覆盖率，value 范围为 0 到 100。
• code-quality：代码质量，value 范围为 A+、A、B、C、D，对应不同的颜色和图案。
• size：代码大小，value 为文件大小，以 KB 为单位。

以生成一个 coverage 徽章为例：

var badgin = require('badgin');

console.log(badgin('coverage', 85));

运行上述代码，你将会得到一个覆盖率为 85% 的徽章，如下所示：

自定义 SVG 徽章需要指定 SVG 路径和颜色。以一个自定义的徽章为例：

var badgin = require('badgin');

console.log(badgin('custom', 'my-badge.svg', '#f00'));

运行上述代码，你将会得到一个 SVG 徽章，如下所示：

结束语

badgin 是一个方便实用的 npm 包，通过它我们可以轻松创建各种类型的徽章并展示在我们的文档和项目中。在实际使用中，我们可以通过 badgin 的 API 进行更加高级的自定义和拓展，以满足我们的需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedabcdb5cbfe1ea0610869