介绍
在前端开发中，我们经常需要使用 npm 包来实现我们的代码需求。而如果要将自己的代码封装成一个 npm 包供他人使用，该怎么做呢？这时就需要使用到一个强大的工具：yeoman generator。
其中，@azz/generator-npm-package 是一款基于 yeoman 的脚手架工具，旨在帮助开发者快速创建自己的 npm 包。它具有自动生成文档、自动打包发布等功能，能够让你更专注于代码开发。
在本篇文章中，我们将介绍如何使用 @azz/generator-npm-package 工具创建一个完整的 npm 包，并向你展示工具的强大之处。
安装
首先，我们需要将 @azz/generator-npm-package 安装到我们的开发环境中。可以在全局或者局部安装，这里我们以全局安装为例。
npm install -g @azz/generator-npm-package
使用
1. 创建项目
在终端中输入以下命令，进入想要创建 npm 包的目录中，并执行以下代码：
yo @azz/npm-package
然后，你会看到一个交互式的命令行界面，让你输入一些关于 npm 包的基本信息：
? Your full name: [你的名字] ? Your email address: [你的邮箱地址] ? Package name: [npm 包的名称] ? Package description: [npm 包的描述] ? Package version: [npm 包的版本号] ? Package license: [npm 包的许可证类型] ...
输入完成后，脚手架工具会根据你的输入相关信息，自动生成一个符合 npm 包开发规范的目录结构和文件。
2. 开发
在目录结构中，你可以看到 src 目录下有一个 index.js 文件，这是你的主要代码文件。你可以在这里编写你的代码，并在 package.json 文件中配置相应的依赖。
在 src 目录下新建 test.js 文件，编写测试代码。当你使用 npm test 命令时就可以执行这个测试脚本。
3. 发布
当你完成了你的代码编写，并测试通过后，你需要将你的 npm 包发布到 npm 官网上，供其他人使用。
首先，确保你已经有了 npm 账号，并在控制台中登录。然后，在你的本地终端中进入 npm 包的根目录，并执行以下命令：
npm login npm publish
当你执行完 publish 命令后，你的 npm 包就已经上传到了 npm 官网上了。其他人就可以通过 npm install 命令来安装你的 npm 包了。
4. 自动生成文档
@azz/generator-npm-package 工具还支持自动生成文档。你只需要在你的代码注释中使用特定的语法，并在 package.json 文件中配置相应的依赖和命令，就可以让脚手架工具自动生成文档。
在 index.js 文件中，使用以下语法编写注释：
-- -------------------- ---- ------- --- - ------------ ---- -- - -------- ---- ------- --- --- -- --- -------- - ------ -------- ---- - --- ----- ------ -- ---- - ------ -------- ---- - --- ------ ------ -- ---- - -------- -------- --- --- -- --- --- -------- -- -------- --------- ----- - ------ ---- - ----- -
然后，在 package.json 文件中，在 devDependencies 中添加以下依赖：
"documentation": "^12.2.0"
在 scripts 中添加命令：
"docs": "documentation build src/index.js -f md -o docs/README.md"
执行 npm run docs 命令，脚手架工具就会自动将代码注释解析成文档，并生成到 docs/README.md 文件中。
结语
通过本文的介绍，相信大家已经了解了如何使用 @azz/generator-npm-package 工具创建一个完整的 npm 包，并且在开发过程中自动化生成文档。
使用脚手架工具能够让我们更快地创建项目，并且优化我们的开发流程，提高开发效率。在实际的开发中，我们可以根据自己的需要选择相应的脚手架工具，以及在工具使用过程中遇到的问题，都可以通过开源社区来寻求帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005725a81e8991b448e87ce