前言
作为前端工程师，使用 npm 包是我们非常常见的一种操作，而使用 badges 也是我们在开发过程中经常用到的。那么，有没有一种方式可以更加方便地生成 shields badges 呢？答案是肯定的，shields-badges-urls 就是一个不错的选择。
什么是 shields-badges-urls
shields-badges-urls 是一个 node.js 模块，可以方便地生成 shields badges，包括以下类型：
- version
- downloads
- npm
- github
- travis
- codecov
安装和使用
shields-badges-urls 可以通过 npm 安装：
npm install shields-badges-urls --save
使用方法很简单，只需要引入该模块，然后调用相应的方法生成相应的 badges，代码如下：
-- -------------------- ---- ------- ----- ------- - ------------------------------- -- ------- ----- ----- ------------ - ---------------------- ----------------------- -- --------- ----- ----- -------------- - ------------------------ ----------------------- -- --- ----- ----- -------- - ----------------------------------- -- ------ ----- ----- ----------- - ----------------------- ----------------------- -- ------ ----- ----- ----------- - ----------------------------- -- ------- ----- ----- ------------ - ------------------------------
其中，version、downloads、npm、github、travis、codecov 六个方法分别对应生成版本号、下载量、npm、github、travis、codecov 的 badges，具体用法请参考以下说明：
version
版本号 badge。用于在 README、文档中展示当前 npm 包的版本号。
shields.version('npm', 'package name', 'optional label');例：
const versionBadge = shields.version('npm', 'shields-badges-urls', 'version');downloads
下载量 badge。用于在 README、文档中展示当前 npm 包的下载量。
shields.downloads('npm', 'package name', 'optional label');例：
const downloadsBadge = shields.downloads('npm', 'shields-badges-urls', 'downloads');npm
npm badge。用于在 README、文档中展示当前 npm 包的信息，包括版本号、下载量等等。
shields.npm('package name', 'optional label');例：
const npmBadge = shields.npm('shields-badges-urls', 'npm');github
github badge。用于在 README、文档中展示当前 github 仓库的信息，包括 stars、forks 等等。
shields.github('type', 'owner/repo', 'optional label');例：
const githubBadge = shields.github('stars', 'shields-badges-urls', 'github');travis
travis badge。用于在 README、文档中展示当前项目的 CI 状态。
shields.travis('owner/repo', 'optional label');例：
const travisBadge = shields.travis('shields-io/shields', 'ci status');codecov
codecov badge。用于在 README、文档中展示当前项目的测试覆盖率。
shields.codecov('owner/repo', 'optional label');例：
const codecovBadge = shields.codecov('shields-io/shields', 'test coverage');指导意义
使用 shields-badges-urls 生成 badges 可以让我们的文档更加整洁、美观，同时也提高项目的可读性和可信度。同时，shields-badges-urls 也提供了多种类型的 badges，可以满足我们不同的需求。
在使用 badges 的同时，我们也要注意选择合适的内容和字体颜色，使得 badges 更加突出、易于辨识。此外，badges 也并不是项目中必不可少的，我们应该根据项目特点选择是否使用。
结语
shields-badges-urls 是一个非常方便的 npm 包，可以更加方便地生成 badges。在使用 badges 的同时，我们也要注意选择合适的内容和字体颜色，使得 badges 更加突出、易于辨识。希望本文对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664b81e8991b448e2693