什么是 eslint-plugin-json？
eslint-plugin-json 是一个用于检查 JSON 文件语法和格式的 ESLint 插件。它可以在编写 JSON 文件时帮助你遵循一致的代码风格，并捕获常见的错误。
安装
使用 npm 进行安装：
npm install --save-dev eslint-plugin-json
配置
在你的 ESLint 配置文件中添加 json 插件：
{ "plugins": [ "json" ] }
规则
eslint-plugin-json 提供了以下规则：
json/sort-package-json
该规则要求按照从上到下的顺序排列 package.json 中的字段，并按照一定的规则分组。
例如，下面是一个符合该规则的 package.json 文件：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------- --- --------- ---------- ------ ----------- - ----- --------- -- ------------- - ------- ------ ------ ---------------------------------------- -- ------- - ------ ------------------------------------------- -- ----------- -------------------------------------------- --------------- - --------- ---------- -- ------------------ - --------- --------- -- ---------- - ------- ------- --- ------- ------- ----- -- - -展开代码
json/no-unused-properties
该规则要求删除未使用的属性。例如，下面的 JSON 对象包含一个未使用的属性 unused：
{ "used": true, "unused": false }
json/undefined-properties
该规则要求在访问未定义的属性时抛出错误。例如，下面的代码将抛出错误：
{ "foo": { "bar": true } } console.log(foo.baz); // Error: Property 'baz' is undefined
示例
在你的项目根目录中创建一个名为 example.json 的文件，并添加以下内容：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------- --- --------- ---------- ------ ----------- - ----- --------- -- ------------- - ------- ------ ------ ---------------------------------------- -- ------- - ------ ------------------------------------------- -- ----------- -------------------------------------------- --------------- - --------- ---------- -- ------------------ - --------- --------- -- ---------- - ------- ------- --- ------- ------- ----- -- -- --------- ----- -展开代码
然后，在你的 ESLint 配置文件中添加以下规则：
-- -------------------- ---- ------- - ---------- - ------ -- -------- - ------------------------- --------- - ------------- ----- -------------------------------- ------------ ------------- - - ---------- ------------- -------- --------- --------- ----------- ------- - - --- ---------------------------- ------- ---------------------------- ------- - -展开代码
最后，运行 ESLint 检查 example.json 文件：
eslint example.json
你将会看到类似于以下的输出：
$ eslint example.json example.json 1:1 error Unexpected token { json/undefined-properties ✖ 1 problem (1 error, 0 warnings)
总结
eslint-plugin-json 是一个非常有用的工具
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42312
