eslint-plugin-package-json 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/configs/recommended.d.mts +1 -0
- package/lib/configs/recommended.d.ts +1 -0
- package/lib/configs/recommended.js +1 -0
- package/lib/configs/recommended.js.map +1 -1
- package/lib/configs/recommended.mjs +1 -0
- package/lib/configs/recommended.mjs.map +1 -1
- package/lib/rules/order-properties.js +1 -1
- package/lib/rules/order-properties.js.map +1 -1
- package/lib/rules/order-properties.mjs +1 -1
- package/lib/rules/order-properties.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/configs/recommended.ts"],"sourcesContent":["import * as parserJsonc from \"jsonc-eslint-parser\";\n\nimport { plugin, recommendedRuleSettings } from \"../plugin.js\";\n\nconst recommended = {\n\tfiles: [\"**/package.json\"],\n\tlanguageOptions: {\n\t\tparser: parserJsonc,\n\t},\n\tplugins: {\n\t\tget \"package-json\"() {\n\t\t\treturn plugin;\n\t\t},\n\t},\n\trules: recommendedRuleSettings,\n};\n\nexport default recommended;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA6B;AAE7B,oBAAgD;AAEhD,MAAM,cAAc;AAAA,EACnB,OAAO,CAAC,iBAAiB;AAAA,EACzB,iBAAiB;AAAA,IAChB,QAAQ;AAAA,EACT;AAAA,EACA,SAAS;AAAA,IACR,IAAI,iBAAiB;AACpB,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EACA,OAAO;AACR;AAEA,IAAO,sBAAQ;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/configs/recommended.ts"],"sourcesContent":["import * as parserJsonc from \"jsonc-eslint-parser\";\n\nimport { plugin, recommendedRuleSettings } from \"../plugin.js\";\n\nconst recommended = {\n\tfiles: [\"**/package.json\"],\n\tlanguageOptions: {\n\t\tparser: parserJsonc,\n\t},\n\tname: \"package-json/recommended\",\n\tplugins: {\n\t\tget \"package-json\"() {\n\t\t\treturn plugin;\n\t\t},\n\t},\n\trules: recommendedRuleSettings,\n};\n\nexport default recommended;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA6B;AAE7B,oBAAgD;AAEhD,MAAM,cAAc;AAAA,EACnB,OAAO,CAAC,iBAAiB;AAAA,EACzB,iBAAiB;AAAA,IAChB,QAAQ;AAAA,EACT;AAAA,EACA,MAAM;AAAA,EACN,SAAS;AAAA,IACR,IAAI,iBAAiB;AACpB,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EACA,OAAO;AACR;AAEA,IAAO,sBAAQ;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/configs/recommended.ts"],"sourcesContent":["import * as parserJsonc from \"jsonc-eslint-parser\";\n\nimport { plugin, recommendedRuleSettings } from \"../plugin.js\";\n\nconst recommended = {\n\tfiles: [\"**/package.json\"],\n\tlanguageOptions: {\n\t\tparser: parserJsonc,\n\t},\n\tplugins: {\n\t\tget \"package-json\"() {\n\t\t\treturn plugin;\n\t\t},\n\t},\n\trules: recommendedRuleSettings,\n};\n\nexport default recommended;\n"],"mappings":"AAAA,YAAY,iBAAiB;AAE7B,SAAS,QAAQ,+BAA+B;AAEhD,MAAM,cAAc;AAAA,EACnB,OAAO,CAAC,iBAAiB;AAAA,EACzB,iBAAiB;AAAA,IAChB,QAAQ;AAAA,EACT;AAAA,EACA,SAAS;AAAA,IACR,IAAI,iBAAiB;AACpB,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EACA,OAAO;AACR;AAEA,IAAO,sBAAQ;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/configs/recommended.ts"],"sourcesContent":["import * as parserJsonc from \"jsonc-eslint-parser\";\n\nimport { plugin, recommendedRuleSettings } from \"../plugin.js\";\n\nconst recommended = {\n\tfiles: [\"**/package.json\"],\n\tlanguageOptions: {\n\t\tparser: parserJsonc,\n\t},\n\tname: \"package-json/recommended\",\n\tplugins: {\n\t\tget \"package-json\"() {\n\t\t\treturn plugin;\n\t\t},\n\t},\n\trules: recommendedRuleSettings,\n};\n\nexport default recommended;\n"],"mappings":"AAAA,YAAY,iBAAiB;AAE7B,SAAS,QAAQ,+BAA+B;AAEhD,MAAM,cAAc;AAAA,EACnB,OAAO,CAAC,iBAAiB;AAAA,EACzB,iBAAiB;AAAA,IAChB,QAAQ;AAAA,EACT;AAAA,EACA,MAAM;AAAA,EACN,SAAS;AAAA,IACR,IAAI,iBAAiB;AACpB,aAAO;AAAA,IACR;AAAA,EACD;AAAA,EACA,OAAO;AACR;AAEA,IAAO,sBAAQ;","names":[]}
|
|
@@ -106,8 +106,8 @@ const rule = (0, import_createRule.createRule)({
|
|
|
106
106
|
message: "Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.",
|
|
107
107
|
node: context.sourceCode.ast
|
|
108
108
|
});
|
|
109
|
+
break;
|
|
109
110
|
}
|
|
110
|
-
break;
|
|
111
111
|
}
|
|
112
112
|
}
|
|
113
113
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/rules/order-properties.ts"],"sourcesContent":["import type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport detectIndent from \"detect-indent\";\nimport detectNewline from \"detect-newline\";\nimport sortObjectKeys from \"sort-object-keys\";\nimport { sortOrder } from \"sort-package-json\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst standardOrderLegacy = [\n\t\"name\",\n\t\"version\",\n\t\"private\",\n\t\"publishConfig\",\n\t\"description\",\n\t\"main\",\n\t\"exports\",\n\t\"browser\",\n\t\"files\",\n\t\"bin\",\n\t\"directories\",\n\t\"man\",\n\t\"scripts\",\n\t\"repository\",\n\t\"keywords\",\n\t\"author\",\n\t\"license\",\n\t\"bugs\",\n\t\"homepage\",\n\t\"config\",\n\t\"dependencies\",\n\t\"devDependencies\",\n\t\"peerDependencies\",\n\t\"optionalDependencies\",\n\t\"bundledDependencies\",\n\t\"engines\",\n\t\"os\",\n\t\"cpu\",\n];\n\ntype Order = \"legacy\" | \"sort-package-json\" | string[];\n\ntype Options = [{ order: Order }?];\n\nexport const rule = createRule<Options>({\n\tcreate(context) {\n\t\treturn {\n\t\t\t\"Program:exit\"() {\n\t\t\t\tconst { ast, text } = context.sourceCode;\n\n\t\t\t\tconst options = {\n\t\t\t\t\torder: \"sort-package-json\",\n\t\t\t\t\t...context.options[0],\n\t\t\t\t} satisfies Options[0];\n\n\t\t\t\tconst requiredOrder =\n\t\t\t\t\toptions.order === \"legacy\"\n\t\t\t\t\t\t? standardOrderLegacy\n\t\t\t\t\t\t: options.order === \"sort-package-json\"\n\t\t\t\t\t\t\t? sortOrder\n\t\t\t\t\t\t\t: options.order;\n\n\t\t\t\tconst json = JSON.parse(text) as Record<string, unknown>;\n\t\t\t\tconst orderedSource = sortObjectKeys(json, [\n\t\t\t\t\t...requiredOrder,\n\t\t\t\t\t...Object.keys(json),\n\t\t\t\t]);\n\t\t\t\tconst orderedKeys = Object.keys(orderedSource);\n\n\t\t\t\tconst { properties } = ast.body[0].expression;\n\n\t\t\t\tfor (let i = 0; i < properties.length; i += 1) {\n\t\t\t\t\tif (\n\t\t\t\t\t\t(properties[i].key as JsonAST.JSONStringLiteral)\n\t\t\t\t\t\t\t.value !== orderedKeys[i]\n\t\t\t\t\t) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessage:\n\t\t\t\t\t\t\t\t\"Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.\",\n\t\t\t\t\t\t\tnode: context.sourceCode.ast,\n\t\t\t\t\t\t});\n\t\t\t\t\t
|
|
1
|
+
{"version":3,"sources":["../../src/rules/order-properties.ts"],"sourcesContent":["import type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport detectIndent from \"detect-indent\";\nimport detectNewline from \"detect-newline\";\nimport sortObjectKeys from \"sort-object-keys\";\nimport { sortOrder } from \"sort-package-json\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst standardOrderLegacy = [\n\t\"name\",\n\t\"version\",\n\t\"private\",\n\t\"publishConfig\",\n\t\"description\",\n\t\"main\",\n\t\"exports\",\n\t\"browser\",\n\t\"files\",\n\t\"bin\",\n\t\"directories\",\n\t\"man\",\n\t\"scripts\",\n\t\"repository\",\n\t\"keywords\",\n\t\"author\",\n\t\"license\",\n\t\"bugs\",\n\t\"homepage\",\n\t\"config\",\n\t\"dependencies\",\n\t\"devDependencies\",\n\t\"peerDependencies\",\n\t\"optionalDependencies\",\n\t\"bundledDependencies\",\n\t\"engines\",\n\t\"os\",\n\t\"cpu\",\n];\n\ntype Order = \"legacy\" | \"sort-package-json\" | string[];\n\ntype Options = [{ order: Order }?];\n\nexport const rule = createRule<Options>({\n\tcreate(context) {\n\t\treturn {\n\t\t\t\"Program:exit\"() {\n\t\t\t\tconst { ast, text } = context.sourceCode;\n\n\t\t\t\tconst options = {\n\t\t\t\t\torder: \"sort-package-json\",\n\t\t\t\t\t...context.options[0],\n\t\t\t\t} satisfies Options[0];\n\n\t\t\t\tconst requiredOrder =\n\t\t\t\t\toptions.order === \"legacy\"\n\t\t\t\t\t\t? standardOrderLegacy\n\t\t\t\t\t\t: options.order === \"sort-package-json\"\n\t\t\t\t\t\t\t? sortOrder\n\t\t\t\t\t\t\t: options.order;\n\n\t\t\t\tconst json = JSON.parse(text) as Record<string, unknown>;\n\t\t\t\tconst orderedSource = sortObjectKeys(json, [\n\t\t\t\t\t...requiredOrder,\n\t\t\t\t\t...Object.keys(json),\n\t\t\t\t]);\n\t\t\t\tconst orderedKeys = Object.keys(orderedSource);\n\n\t\t\t\tconst { properties } = ast.body[0].expression;\n\n\t\t\t\tfor (let i = 0; i < properties.length; i += 1) {\n\t\t\t\t\tif (\n\t\t\t\t\t\t(properties[i].key as JsonAST.JSONStringLiteral)\n\t\t\t\t\t\t\t.value !== orderedKeys[i]\n\t\t\t\t\t) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessage:\n\t\t\t\t\t\t\t\t\"Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.\",\n\t\t\t\t\t\t\tnode: context.sourceCode.ast,\n\t\t\t\t\t\t});\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t};\n\t},\n\n\tmeta: {\n\t\tdocs: {\n\t\t\tcategory: \"Best Practices\",\n\t\t\tdescription:\n\t\t\t\t\"Package properties must be declared in standard order\",\n\t\t\trecommended: true,\n\t\t},\n\t\tfixable: \"code\",\n\t\tschema: [\n\t\t\t{\n\t\t\t\tproperties: {\n\t\t\t\t\torder: {\n\t\t\t\t\t\tanyOf: [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tenum: [\"legacy\", \"sort-package-json\"],\n\t\t\t\t\t\t\t\ttype: [\"string\"],\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\titems: {\n\t\t\t\t\t\t\t\t\ttype: [\"string\"],\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\ttype: [\"array\"],\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t],\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\ttype: \"object\",\n\t\t\t},\n\t\t],\n\t},\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,2BAAyB;AACzB,4BAA0B;AAC1B,8BAA2B;AAC3B,+BAA0B;AAE1B,wBAA2B;AAE3B,MAAM,sBAAsB;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD;AAMO,MAAM,WAAO,8BAAoB;AAAA,EACvC,OAAO,SAAS;AACf,WAAO;AAAA,MACN,iBAAiB;AAChB,cAAM,EAAE,KAAK,KAAK,IAAI,QAAQ;AAE9B,cAAM,UAAU;AAAA,UACf,OAAO;AAAA,UACP,GAAG,QAAQ,QAAQ,CAAC;AAAA,QACrB;AAEA,cAAM,gBACL,QAAQ,UAAU,WACf,sBACA,QAAQ,UAAU,sBACjB,qCACA,QAAQ;AAEb,cAAM,OAAO,KAAK,MAAM,IAAI;AAC5B,cAAM,oBAAgB,wBAAAA,SAAe,MAAM;AAAA,UAC1C,GAAG;AAAA,UACH,GAAG,OAAO,KAAK,IAAI;AAAA,QACpB,CAAC;AACD,cAAM,cAAc,OAAO,KAAK,aAAa;AAE7C,cAAM,EAAE,WAAW,IAAI,IAAI,KAAK,CAAC,EAAE;AAEnC,iBAAS,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;AAC9C,cACE,WAAW,CAAC,EAAE,IACb,UAAU,YAAY,CAAC,GACxB;AACD,oBAAQ,OAAO;AAAA,cACd,IAAI,OAAO;AACV,sBAAM,EAAE,QAAQ,KAAK,QAAI,qBAAAC,SAAa,IAAI;AAC1C,sBAAM,gBAAgB,KAAK,SAAS,IAAI,IACrC,OACA;AACH,sBAAM,UAAU,sBAAAC,QAAc,SAAS,IAAI;AAC3C,oBAAI,SACH,KAAK;AAAA,kBACJ;AAAA,kBACA;AAAA,kBACA,SAAS,QAAQ,MAAO;AAAA,gBACzB,IAAI;AACL,oBAAI,YAAY,QAAQ;AACvB,2BAAS,OAAO,QAAQ,OAAO,OAAO;AAAA,gBACvC;AAEA,uBAAO,MAAM;AAAA,kBACZ,QAAQ,WAAW;AAAA,kBACnB;AAAA,gBACD;AAAA,cACD;AAAA,cACA,SACC;AAAA,cACD,MAAM,QAAQ,WAAW;AAAA,YAC1B,CAAC;AACD;AAAA,UACD;AAAA,QACD;AAAA,MACD;AAAA,IACD;AAAA,EACD;AAAA,EAEA,MAAM;AAAA,IACL,MAAM;AAAA,MACL,UAAU;AAAA,MACV,aACC;AAAA,MACD,aAAa;AAAA,IACd;AAAA,IACA,SAAS;AAAA,IACT,QAAQ;AAAA,MACP;AAAA,QACC,YAAY;AAAA,UACX,OAAO;AAAA,YACN,OAAO;AAAA,cACN;AAAA,gBACC,MAAM,CAAC,UAAU,mBAAmB;AAAA,gBACpC,MAAM,CAAC,QAAQ;AAAA,cAChB;AAAA,cACA;AAAA,gBACC,OAAO;AAAA,kBACN,MAAM,CAAC,QAAQ;AAAA,gBAChB;AAAA,gBACA,MAAM,CAAC,OAAO;AAAA,cACf;AAAA,YACD;AAAA,UACD;AAAA,QACD;AAAA,QACA,MAAM;AAAA,MACP;AAAA,IACD;AAAA,EACD;AACD,CAAC;","names":["sortObjectKeys","detectIndent","detectNewline"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/rules/order-properties.ts"],"sourcesContent":["import type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport detectIndent from \"detect-indent\";\nimport detectNewline from \"detect-newline\";\nimport sortObjectKeys from \"sort-object-keys\";\nimport { sortOrder } from \"sort-package-json\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst standardOrderLegacy = [\n\t\"name\",\n\t\"version\",\n\t\"private\",\n\t\"publishConfig\",\n\t\"description\",\n\t\"main\",\n\t\"exports\",\n\t\"browser\",\n\t\"files\",\n\t\"bin\",\n\t\"directories\",\n\t\"man\",\n\t\"scripts\",\n\t\"repository\",\n\t\"keywords\",\n\t\"author\",\n\t\"license\",\n\t\"bugs\",\n\t\"homepage\",\n\t\"config\",\n\t\"dependencies\",\n\t\"devDependencies\",\n\t\"peerDependencies\",\n\t\"optionalDependencies\",\n\t\"bundledDependencies\",\n\t\"engines\",\n\t\"os\",\n\t\"cpu\",\n];\n\ntype Order = \"legacy\" | \"sort-package-json\" | string[];\n\ntype Options = [{ order: Order }?];\n\nexport const rule = createRule<Options>({\n\tcreate(context) {\n\t\treturn {\n\t\t\t\"Program:exit\"() {\n\t\t\t\tconst { ast, text } = context.sourceCode;\n\n\t\t\t\tconst options = {\n\t\t\t\t\torder: \"sort-package-json\",\n\t\t\t\t\t...context.options[0],\n\t\t\t\t} satisfies Options[0];\n\n\t\t\t\tconst requiredOrder =\n\t\t\t\t\toptions.order === \"legacy\"\n\t\t\t\t\t\t? standardOrderLegacy\n\t\t\t\t\t\t: options.order === \"sort-package-json\"\n\t\t\t\t\t\t\t? sortOrder\n\t\t\t\t\t\t\t: options.order;\n\n\t\t\t\tconst json = JSON.parse(text) as Record<string, unknown>;\n\t\t\t\tconst orderedSource = sortObjectKeys(json, [\n\t\t\t\t\t...requiredOrder,\n\t\t\t\t\t...Object.keys(json),\n\t\t\t\t]);\n\t\t\t\tconst orderedKeys = Object.keys(orderedSource);\n\n\t\t\t\tconst { properties } = ast.body[0].expression;\n\n\t\t\t\tfor (let i = 0; i < properties.length; i += 1) {\n\t\t\t\t\tif (\n\t\t\t\t\t\t(properties[i].key as JsonAST.JSONStringLiteral)\n\t\t\t\t\t\t\t.value !== orderedKeys[i]\n\t\t\t\t\t) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessage:\n\t\t\t\t\t\t\t\t\"Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.\",\n\t\t\t\t\t\t\tnode: context.sourceCode.ast,\n\t\t\t\t\t\t});\n\t\t\t\t\t
|
|
1
|
+
{"version":3,"sources":["../../src/rules/order-properties.ts"],"sourcesContent":["import type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport detectIndent from \"detect-indent\";\nimport detectNewline from \"detect-newline\";\nimport sortObjectKeys from \"sort-object-keys\";\nimport { sortOrder } from \"sort-package-json\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst standardOrderLegacy = [\n\t\"name\",\n\t\"version\",\n\t\"private\",\n\t\"publishConfig\",\n\t\"description\",\n\t\"main\",\n\t\"exports\",\n\t\"browser\",\n\t\"files\",\n\t\"bin\",\n\t\"directories\",\n\t\"man\",\n\t\"scripts\",\n\t\"repository\",\n\t\"keywords\",\n\t\"author\",\n\t\"license\",\n\t\"bugs\",\n\t\"homepage\",\n\t\"config\",\n\t\"dependencies\",\n\t\"devDependencies\",\n\t\"peerDependencies\",\n\t\"optionalDependencies\",\n\t\"bundledDependencies\",\n\t\"engines\",\n\t\"os\",\n\t\"cpu\",\n];\n\ntype Order = \"legacy\" | \"sort-package-json\" | string[];\n\ntype Options = [{ order: Order }?];\n\nexport const rule = createRule<Options>({\n\tcreate(context) {\n\t\treturn {\n\t\t\t\"Program:exit\"() {\n\t\t\t\tconst { ast, text } = context.sourceCode;\n\n\t\t\t\tconst options = {\n\t\t\t\t\torder: \"sort-package-json\",\n\t\t\t\t\t...context.options[0],\n\t\t\t\t} satisfies Options[0];\n\n\t\t\t\tconst requiredOrder =\n\t\t\t\t\toptions.order === \"legacy\"\n\t\t\t\t\t\t? standardOrderLegacy\n\t\t\t\t\t\t: options.order === \"sort-package-json\"\n\t\t\t\t\t\t\t? sortOrder\n\t\t\t\t\t\t\t: options.order;\n\n\t\t\t\tconst json = JSON.parse(text) as Record<string, unknown>;\n\t\t\t\tconst orderedSource = sortObjectKeys(json, [\n\t\t\t\t\t...requiredOrder,\n\t\t\t\t\t...Object.keys(json),\n\t\t\t\t]);\n\t\t\t\tconst orderedKeys = Object.keys(orderedSource);\n\n\t\t\t\tconst { properties } = ast.body[0].expression;\n\n\t\t\t\tfor (let i = 0; i < properties.length; i += 1) {\n\t\t\t\t\tif (\n\t\t\t\t\t\t(properties[i].key as JsonAST.JSONStringLiteral)\n\t\t\t\t\t\t\t.value !== orderedKeys[i]\n\t\t\t\t\t) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessage:\n\t\t\t\t\t\t\t\t\"Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.\",\n\t\t\t\t\t\t\tnode: context.sourceCode.ast,\n\t\t\t\t\t\t});\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t};\n\t},\n\n\tmeta: {\n\t\tdocs: {\n\t\t\tcategory: \"Best Practices\",\n\t\t\tdescription:\n\t\t\t\t\"Package properties must be declared in standard order\",\n\t\t\trecommended: true,\n\t\t},\n\t\tfixable: \"code\",\n\t\tschema: [\n\t\t\t{\n\t\t\t\tproperties: {\n\t\t\t\t\torder: {\n\t\t\t\t\t\tanyOf: [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tenum: [\"legacy\", \"sort-package-json\"],\n\t\t\t\t\t\t\t\ttype: [\"string\"],\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\titems: {\n\t\t\t\t\t\t\t\t\ttype: [\"string\"],\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\ttype: [\"array\"],\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t],\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\ttype: \"object\",\n\t\t\t},\n\t\t],\n\t},\n});\n"],"mappings":"AAEA,OAAO,kBAAkB;AACzB,OAAO,mBAAmB;AAC1B,OAAO,oBAAoB;AAC3B,SAAS,iBAAiB;AAE1B,SAAS,kBAAkB;AAE3B,MAAM,sBAAsB;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD;AAMO,MAAM,OAAO,WAAoB;AAAA,EACvC,OAAO,SAAS;AACf,WAAO;AAAA,MACN,iBAAiB;AAChB,cAAM,EAAE,KAAK,KAAK,IAAI,QAAQ;AAE9B,cAAM,UAAU;AAAA,UACf,OAAO;AAAA,UACP,GAAG,QAAQ,QAAQ,CAAC;AAAA,QACrB;AAEA,cAAM,gBACL,QAAQ,UAAU,WACf,sBACA,QAAQ,UAAU,sBACjB,YACA,QAAQ;AAEb,cAAM,OAAO,KAAK,MAAM,IAAI;AAC5B,cAAM,gBAAgB,eAAe,MAAM;AAAA,UAC1C,GAAG;AAAA,UACH,GAAG,OAAO,KAAK,IAAI;AAAA,QACpB,CAAC;AACD,cAAM,cAAc,OAAO,KAAK,aAAa;AAE7C,cAAM,EAAE,WAAW,IAAI,IAAI,KAAK,CAAC,EAAE;AAEnC,iBAAS,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;AAC9C,cACE,WAAW,CAAC,EAAE,IACb,UAAU,YAAY,CAAC,GACxB;AACD,oBAAQ,OAAO;AAAA,cACd,IAAI,OAAO;AACV,sBAAM,EAAE,QAAQ,KAAK,IAAI,aAAa,IAAI;AAC1C,sBAAM,gBAAgB,KAAK,SAAS,IAAI,IACrC,OACA;AACH,sBAAM,UAAU,cAAc,SAAS,IAAI;AAC3C,oBAAI,SACH,KAAK;AAAA,kBACJ;AAAA,kBACA;AAAA,kBACA,SAAS,QAAQ,MAAO;AAAA,gBACzB,IAAI;AACL,oBAAI,YAAY,QAAQ;AACvB,2BAAS,OAAO,QAAQ,OAAO,OAAO;AAAA,gBACvC;AAEA,uBAAO,MAAM;AAAA,kBACZ,QAAQ,WAAW;AAAA,kBACnB;AAAA,gBACD;AAAA,cACD;AAAA,cACA,SACC;AAAA,cACD,MAAM,QAAQ,WAAW;AAAA,YAC1B,CAAC;AACD;AAAA,UACD;AAAA,QACD;AAAA,MACD;AAAA,IACD;AAAA,EACD;AAAA,EAEA,MAAM;AAAA,IACL,MAAM;AAAA,MACL,UAAU;AAAA,MACV,aACC;AAAA,MACD,aAAa;AAAA,IACd;AAAA,IACA,SAAS;AAAA,IACT,QAAQ;AAAA,MACP;AAAA,QACC,YAAY;AAAA,UACX,OAAO;AAAA,YACN,OAAO;AAAA,cACN;AAAA,gBACC,MAAM,CAAC,UAAU,mBAAmB;AAAA,gBACpC,MAAM,CAAC,QAAQ;AAAA,cAChB;AAAA,cACA;AAAA,gBACC,OAAO;AAAA,kBACN,MAAM,CAAC,QAAQ;AAAA,gBAChB;AAAA,gBACA,MAAM,CAAC,OAAO;AAAA,cACf;AAAA,YACD;AAAA,UACD;AAAA,QACD;AAAA,QACA,MAAM;AAAA,MACP;AAAA,IACD;AAAA,EACD;AACD,CAAC;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "eslint-plugin-package-json",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
|
|
5
5
|
"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
"knip": "^5.0.0",
|
|
99
99
|
"lint-staged": "^15.2.0",
|
|
100
100
|
"markdownlint": "^0.34.0",
|
|
101
|
-
"markdownlint-cli": "^0.
|
|
101
|
+
"markdownlint-cli": "^0.41.0",
|
|
102
102
|
"npm-package-json-lint": "^7.1.0",
|
|
103
103
|
"npm-package-json-lint-config-default": "^6.0.0",
|
|
104
104
|
"prettier": "^3.2.4",
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
"eslint": ">=8.0.0",
|
|
116
116
|
"jsonc-eslint-parser": "^2.0.0"
|
|
117
117
|
},
|
|
118
|
-
"packageManager": "pnpm@
|
|
118
|
+
"packageManager": "pnpm@9.1.3",
|
|
119
119
|
"engines": {
|
|
120
120
|
"node": ">=18"
|
|
121
121
|
},
|