简介
@ngryman/generator-library 是一款 Node.js 模块，用于生成可重用 JavaScript 库或插件的脚手架工具。该工具基于 Yeoman 框架构建，包括了一系列的脚手架模板和工具，使用户能够快速创建自己的 JavaScript 库或插件。本篇文章将会详细介绍该 npm 包的安装和使用教程。
安装
首先，我们需要安装 Node.js 和 npm。安装完成后，在任意目录下打开命令行，输入以下命令进行全局安装：
npm install -g yo @ngryman/generator-library
创建项目
首先，我们需要进入一个你想要生成 JavaScript 库或插件的目录：
cd your-project-directory
然后，执行以下命令：
yo @ngryman/library
执行完该命令后，我们需要回答一些问题，让工具了解我们需要创建的库或插件的类型和名称。当你回答完最后一个问题后，@ngryman/generator-library 会在当前目录下创建一个新的项目文件夹，并生成一些必要的文件。
生成文档
在项目目录下执行以下命令：
npm run generate-docs
该命令会自动生成 docs 目录，其中包含有关如何使用和文档化的详细信息。可以使用其中的模板作为您的项目初始文档，并在项目继续开发过程中进行更新。
单元测试
@ngryman/generator-library 还集成了一些单元测试工具，以验证您的代码是否按预期工作。在项目目录下执行以下命令：
npm test
该命令会运行测试套件，并输出测试结果。
编写代码
在 src 目录下创建你的 JavaScript 代码，并运行以下命令进行构建：
npm run build
该命令将会把 src 目录下的代码转换为浏览器可用的 JavaScript 代码并输出到 dist 目录下，您可以在该目录下找到您的库或插件。
发布
当您准备好发布您的库或插件时，您可以使用以下命令进行发布：
npm publish
该命令将您的库或插件发布到 npm 仓库供他人使用。
示例代码
以下是一个非常简单的示例，用于获取一条随机狗的图片链接：
import axios from 'axios';
async function getRandomDogImageUrl() {
const response = await axios.get('https://dog.ceo/api/breeds/image/random');
return response.data.message;
}
export default getRandomDogImageUrl;总结
现在，我们已经学会了如何使用 @ngryman/generator-library 创建一个可重用的 JavaScript 库或插件，并且已经学会了如何编写代码、自动生成文档和运行单元测试。希望这篇文章对于初学者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e24489c