当你开发一个 Node.js 项目时，你需要使用 package.json 文件来管理你的依赖和脚本。这个文件会随着你的项目增长而变得越来越复杂。为了保持 package.json 的可读性，我们可以使用 sort-package-json 这个 NPM 包来自动排序它的属性。
安装
你可以通过以下命令安装 sort-package-json：
npm install --save-dev sort-package-json
使用方法
在安装完成后，你可以直接运行以下命令来对 package.json 文件进行排序：
npx sort-package-json
这个命令会将 package.json 文件中的属性按照字母顺序排序，并且使每个属性之间保持一个空行间距。注意，npx 命令是在不安装全局依赖的情况下执行本地安装的工具包。
如果你想在构建前自动排序 package.json，你可以在 package.json 文件中添加一个 scripts 属性，如下所示：
{ "name": "my-project", "version": "1.0.0", "scripts": { "build": "sort-package-json && webpack" } }
在运行 npm run build 命令时，sort-package-json 将会在构建前自动对 package.json 进行排序。
高级用法
sort-package-json 提供了一些选项来定制排序的行为。你可以在 package.json 文件中添加一个 sort-package-json 属性，并在其中指定选项。
以下是可用选项的列表：
indent: 指定缩进宽度，默认为 2。order: 指定属性的排序顺序，可以是一个字符串数组。默认情况下，属性将按字母顺序排序。keepUnspecified: 指定是否保留未指定的属性。如果设置为true，则未指定的属性将按照它们出现的顺序排列。如果设置为false（默认值），则未指定的属性将被忽略。
以下是一个完整的 sort-package-json 配置示例：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------------- - --------- -- -------- - ------- ---------- -------------- --------- --- -- ------------------ ---- - -展开代码
这个配置会使用四个空格作为缩进并按照以下顺序对属性进行排序：name、version、description、author，其余的属性按照它们出现的顺序排列。如果你想要完全自定义排序规则，你可以传递一个函数作为 order 选项的值。
结论
sort-package-json 是一个非常实用的工具，它可以使 package.json 文件更加易读、易维护。当你的项目变得越来越复杂时，使用这个工具可以让你专注于开发而不是维护。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/53877
