Nodejs badge-cli

Node.js Badge CLI

badge-cli 是一个简单的命令行工具，用于生成并插入 npm 包的版本徽章到你的项目文档中。它使用了 badge.fury.io 这个服务来获取和展示 npm 包的最新版本信息。

安装

首先，你需要全局安装 badge-cli：

npm install -g badge-cli

这一步会将 badge-cli 添加到你的系统路径中，这样你就可以从任何地方调用它。

使用

一旦安装完成，你可以通过以下命令生成一个徽章链接：

badge -n badge-cli

这将会输出一个 Markdown 链接，指向 badge.fury.io 上的 badge-cli 的 npm 版本信息：

[![npm version](https://badge.fury.io/js/badge-cli.svg)](http://badge.fury.io/js/badge-cli)

如果你想将这个徽章直接添加到你的 README.md 文件中，可以使用重定向操作符 >>：

badge -n badge-cli >> README.md

这将会把徽章链接追加到 README.md 文件的末尾。生成的 Markdown 看起来像这样：

[![npm version](https://badge.fury.io/js/badge-cli.svg)](http://badge.fury.io/js/badge-cli)

实现原理

badge-cli 工具的工作原理相对简单。它主要依赖于 badge.fury.io 提供的 API 来获取指定 npm 包的版本信息，并生成相应的 Markdown 链接。

下面是 badge-cli 的核心逻辑简化版：

const { execSync } = require('child_process');
const fs = require('fs');

function generateBadge(packageName) {
    const url = `https://badge.fury.io/js/${packageName}.svg`;
    const markdownLink = `[![npm version](${url})](${url.replace('.svg', '')})`;

    return markdownLink;
}

function main() {
    const packageName = process.argv[2]; // 从命令行参数中获取包名
    if (!packageName) {
        console.error('Usage: badge -n <package-name>');
        process.exit(1);
    }

    const badgeMarkdown = generateBadge(packageName);

    // 如果有文件重定向，则写入文件
    if (process.stdout.isTTY) {
        console.log(badgeMarkdown);
    } else {
        process.stdout.write(badgeMarkdown);
    }
}

main();

这个脚本从命令行参数中读取包名，然后生成对应的 Markdown 链接，并将其输出到终端或重定向到指定的文件中。

源码

如果你对 badge-cli 的内部实现感兴趣，可以查看其 GitHub 仓库：i5ting/badge-cli

希望这个简短的介绍能帮助你理解如何使用 badge-cli 来生成和管理 npm 包的版本徽章！