概述
在前端开发中，我们经常需要使用 npm 包来完成一些常用的工具类和组件的开发，而手动生成 package.json 文件是一件比较繁琐的事情，因此，npm 的社区为我们提供了一个非常方便的工具——generator-package-json。
generator-package-json 可以在创建一个新的 npm 包时，自动生成一个规范的 package.json 文件，省去了手动填写的麻烦。本文将详细介绍 generator-package-json 的使用方法，并附有示例代码。
安装
在使用 generator-package-json 之前，需要先安装 Yeoman 和 generator-package-json：
npm install -g yo generator-package-json
使用方法
在命令行中运行以下命令：
yo package-json
接着会出现一些关于项目的问题，例如项目名称、作者、描述、license 等，依次按照提示填写即可，如果不知道该填什么，可以直接回车默认值。
最后，generator-package-json 会在当前目录下生成一个 package.json 文件。
注意：在执行命令之前，需要保证当前目录为空，否则无法生成
package.json文件。
可选项
generator-package-json 提供了许多可选的配置项，可以在生成 package.json 文件时进行设置。完整的配置项列表可以在 官方文档 中找到。
下面介绍一些常用的配置项：
includeDefaults
这个配置项控制是否包含默认配置项，可以设置为 true 或 false，默认为 true。如果设置为 false，则只包含手动设置的配置项。
示例：
yo package-json --no-includeDefaults
或者在 ~/.yo-rc.json 文件中进行配置：
{
"package-json": {
"includeDefaults": false
}
}save
这个配置项控制生成 package.json 文件之后是否自动执行一次 npm install，可以设置为 true 或 false，默认为 true。
示例：
yo package-json --no-save
或者在 ~/.yo-rc.json 文件中进行配置：
{
"package-json": {
"save": false
}
}示例代码
下面我们来看一个完整的示例。首先，创建一个目录并进入：
mkdir my-package && cd my-package
然后运行 yo package-json 命令：
yo package-json
按照提示填写信息，生成 package.json 文件：
-- -------------------- ---- -------
-
------- -------------
---------- --------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
-------------- ---
------- -----------
----------- ---
--------- ---
---------- -----
-此时，我们可以在该目录下再运行一次 npm init 命令来比较生成的 package.json 文件：
npm init
填写完信息后，生成的 package.json 文件如下：
-- -------------------- ---- -------
-
------- -------------
---------- --------
-------------- ---
------- -----------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
----------- ---
--------- ---
---------- -----
-可以看到，两个 package.json 文件完全一致。因此，我们可以在创建新的 npm 包时使用 generator-package-json，让它来自动生成标准的 package.json 文件，省去手动填写的烦恼。
总结
generator-package-json 可以为我们的前端开发带来很大的便利，让我们可以更加专注于业务代码的编写，而不用花费太多的时间和精力在手动填写 package.json 文件上。
在实际使用中，如果我们有一些常用的配置项，可以将这些配置项写入 ~/.yo-rc.json 文件中，这样每次执行 yo package-json 命令时，就可以自动使用这些配置项。
希望本文对大家的前端开发有所帮助，更多关于 generator-package-json 的细节请参考官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005553c81e8991b448d26ff