在前端开发过程中，我们通常需要使用 npm 来管理我们的项目依赖。而 package.json 文件就是 npm 项目的核心文件，它记录了项目的依赖、脚本、许可证等信息。但是在编写 package.json 文件时，由于格式较为严格，有时容易出现错误。为了解决这个问题，我们可以使用一个 npm 包——format-package-json。
安装
使用 npm 可以很方便地安装 format-package-json：
npm install -g format-package-json
-g 参数表示全局安装，这样就可以在命令行中直接使用 format-package-json 命令。
使用
使用 format-package-json 很简单，只需在项目目录下执行以下命令即可：
format-package-json
这样就会自动检查并格式化 package.json 文件。如果 package.json 文件已经符合规范，format-package-json 不会做任何修改。如果有错误或不符合规范的地方，format-package-json 会自动修复并输出相应的提示信息。
除了直接在命令行中使用 format-package-json，你还可以将它加入到 npm scripts 中，从而更方便地与其他命令一起运行：
{ "scripts": { "format": "format-package-json" } }
这样就可以使用 npm run format 来格式化 package.json 文件了。
配置
format-package-json 还提供了一些配置选项，以便更好地满足个人需求。你可以在 package.json 文件中创建一个 formatPackageJson 字段来指定这些选项：
-- -------------------- ---- ------- - -------------------- - --------- -- ------------------- ----- ----------------------- ----- ---------------------- ----- ------ ---- - -展开代码
以上配置选项的含义如下：
- indent：缩进空格数，默认值为 4。
- sortDependencies：按照字母顺序排序 dependencies。
- sortPeerDependencies：按照字母顺序排序 peerDependencies。
- sortDevDependencies：按照字母顺序排序 devDependencies。
- eol：行尾换行符，可选值为 "\n" 和 "\r\n"，默认值为 "\n"。
示例代码
下面是一个示例 package.json 文件：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------- --- --------- ------- ----------- --------------- - -------- ---------- --------- ---------- -- ------------------ - ---------- ---------- --------- --------- -- ---------- - -------- -------- --------- ------- ------- ------- ------- -- -- --------- ----- ----- ---------- ----- -展开代码
如果我们使用 format-package-json 检查并格式化这个文件，它会自动将 dependencies、devDependencies 按照字母顺序排序，并将缩进空格数修改为 2。最终的 package.json 文件如下：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------- --- --------- ------- ----------- --------------- - --------- ----------- -------- --------- -- ------------------ - --------- ---------- ---------- --------- -- ---------- - -------- -------- --------- ------- ------- ------- ------- -- -- --------- ----- ----- ---------- ----- -展开代码
结语
format-package-json 是一个非常方便的 npm 包，可以帮助我们处理 package.json 文件中的格式问题
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46126
