在前端开发中，我们常常需要使用到第三方库和包，而 npm 是一个非常好的选择。在这篇文章中，我们将介绍如何使用 npm 包 @himenon/generator-node-lib 来生成一个 Node.js 的 Library 。
什么是 @himenon/generator-node-lib？
@himenon/generator-node-lib 是一个基于 Yeoman 的生成器，可以帮助我们快速生成一个 Node.js 的 Library 项目结构。它提供了一个标准的目录结构和一些常用的配置，使得我们能够更加专注于业务逻辑的开发。
安装 @himenon/generator-node-lib
我们可以使用 npm 安装 @himenon/generator-node-lib：
npm install -g @himenon/generator-node-lib
安装完成后，我们就可以使用 yo 命令来创建一个新的项目了。
使用 @himenon/generator-node-lib
在开始使用 @himenon/generator-node-lib 之前，我们需要确定一个项目名称，并选择一个项目路径。然后我们就可以使用以下命令在命令行中创建一个新项目：
yo @himenon/node-lib
执行上述命令后，@himenon/generator-node-lib 会开始引导我们完成一系列配置项，如下图所示：
- What do you want to call your library?：输入项目名称。
- What is the description of your library?：输入项目描述。
- What is your name?：输入作者名称。
- What is your email address?：输入作者邮箱。
- What API styles do you need?：选择 API 的风格。
- Do you plan to use TypeScript?：选择是否要使用 TypeScript。
- Do you need to support browser environment?：选择是否需要支持浏览器环境。
- Which version of Node.js do you need to support?：选择项目所需要支持的 Node.js 版本。
配置完成后，@himenon/generator-node-lib 将会自动生成项目的目录结构和一些基本配置文件。
项目目录结构
根据上述的配置项，@himenon/generator-node-lib 会生成以下的项目目录结构：
-- -------------------- ---- ------- - --- --- - --- -------- --- ---- - --- ------------- --- ------------- --- ------------- --- ------------ --- ---------- --- ----------- --- -------------- --- ------- --- ------------ --- ------------ --- ---------
- src：存放项目的源代码。
- test：存放项目的测试代码。
- .editorconfig：统一编辑器的代码样式。
- .eslintignore：eslint 检查时忽略的文件。
- .eslintrc.js：eslint 的配置文件。
- .gitignore：git 忽略的文件。
- .prettierrc：prettier 的配置文件。
- jest.config.js：jest 的配置文件。
- LICENSE：项目的许可证。
- node_modules：存放项目的依赖模块。
- package.json：项目的配置文件。
- README.md：项目的说明文件。
开始开发
我们可以在 src 目录下编写项目的源代码，并在 test 目录下编写项目的测试代码。
我们可以通过以下命令来运行测试：
npm test
我们也可以运行以下命令来将代码打包成发布版：
npm pack
这个命令将会生成一个 .tgz 后缀的压缩包，里面包含了我们的项目代码以及依赖。
总结
通过本文，我们了解了如何使用 @himenon/generator-node-lib 这个 npm 包来快速生成一个 Node.js 的 Library 项目结构。这个工具帮助我们约定了一个标准的目录结构和一些常用的配置项，使得我们能够快速构建一个项目，并专注于业务逻辑的开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067354890c4f72775839ff