eslint-plugin-package-json 0.13.1 → 0.15.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 +25 -23
- package/lib/rules/order-properties.js.map +1 -1
- package/lib/rules/order-properties.mjs +25 -23
- package/lib/rules/order-properties.mjs.map +1 -1
- package/package.json +6 -6
|
@@ -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":[]}
|
|
@@ -84,30 +84,32 @@ const rule = (0, import_createRule.createRule)({
|
|
|
84
84
|
const orderedKeys = Object.keys(orderedSource);
|
|
85
85
|
const { properties } = ast.body[0].expression;
|
|
86
86
|
for (let i = 0; i < properties.length; i += 1) {
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
const endCharacters = text.endsWith("\n") ? "\n" : "";
|
|
92
|
-
const newline = import_detect_newline.default.graceful(text);
|
|
93
|
-
let result = JSON.stringify(
|
|
94
|
-
orderedSource,
|
|
95
|
-
null,
|
|
96
|
-
type === "tab" ? " " : indent
|
|
97
|
-
) + endCharacters;
|
|
98
|
-
if (newline === "\r\n") {
|
|
99
|
-
result = result.replace(/\n/g, newline);
|
|
100
|
-
}
|
|
101
|
-
return fixer.replaceText(
|
|
102
|
-
context.sourceCode.ast,
|
|
103
|
-
result
|
|
104
|
-
);
|
|
105
|
-
},
|
|
106
|
-
message: "Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.",
|
|
107
|
-
node: context.sourceCode.ast
|
|
108
|
-
});
|
|
109
|
-
break;
|
|
87
|
+
const property = properties[i].key;
|
|
88
|
+
const { value } = property;
|
|
89
|
+
if (value === orderedKeys[i]) {
|
|
90
|
+
continue;
|
|
110
91
|
}
|
|
92
|
+
context.report({
|
|
93
|
+
fix(fixer) {
|
|
94
|
+
const { indent, type } = (0, import_detect_indent.default)(text);
|
|
95
|
+
const endCharacters = text.endsWith("\n") ? "\n" : "";
|
|
96
|
+
const newline = import_detect_newline.default.graceful(text);
|
|
97
|
+
let result = JSON.stringify(
|
|
98
|
+
orderedSource,
|
|
99
|
+
null,
|
|
100
|
+
type === "tab" ? " " : indent
|
|
101
|
+
) + endCharacters;
|
|
102
|
+
if (newline === "\r\n") {
|
|
103
|
+
result = result.replace(/\n/g, newline);
|
|
104
|
+
}
|
|
105
|
+
return fixer.replaceText(
|
|
106
|
+
context.sourceCode.ast,
|
|
107
|
+
result
|
|
108
|
+
);
|
|
109
|
+
},
|
|
110
|
+
loc: properties[i].loc,
|
|
111
|
+
message: `Package top-level property "${value}" is not ordered in the npm standard way. Run the ESLint auto-fixer to correct.`
|
|
112
|
+
});
|
|
111
113
|
}
|
|
112
114
|
}
|
|
113
115
|
};
|
|
@@ -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\
|
|
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\tconst property = properties[i]\n\t\t\t\t\t\t.key as JsonAST.JSONStringLiteral;\n\t\t\t\t\tconst { value } = property;\n\n\t\t\t\t\tif (value === orderedKeys[i]) {\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t},\n\t\t\t\t\t\tloc: properties[i].loc,\n\t\t\t\t\t\tmessage: `Package top-level property \"${value}\" is not ordered in the npm standard way. Run the ESLint auto-fixer to correct.`,\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,gBAAM,WAAW,WAAW,CAAC,EAC3B;AACF,gBAAM,EAAE,MAAM,IAAI;AAElB,cAAI,UAAU,YAAY,CAAC,GAAG;AAC7B;AAAA,UACD;AAEA,kBAAQ,OAAO;AAAA,YACd,IAAI,OAAO;AACV,oBAAM,EAAE,QAAQ,KAAK,QAAI,qBAAAC,SAAa,IAAI;AAC1C,oBAAM,gBAAgB,KAAK,SAAS,IAAI,IACrC,OACA;AACH,oBAAM,UAAU,sBAAAC,QAAc,SAAS,IAAI;AAC3C,kBAAI,SACH,KAAK;AAAA,gBACJ;AAAA,gBACA;AAAA,gBACA,SAAS,QAAQ,MAAO;AAAA,cACzB,IAAI;AACL,kBAAI,YAAY,QAAQ;AACvB,yBAAS,OAAO,QAAQ,OAAO,OAAO;AAAA,cACvC;AAEA,qBAAO,MAAM;AAAA,gBACZ,QAAQ,WAAW;AAAA,gBACnB;AAAA,cACD;AAAA,YACD;AAAA,YACA,KAAK,WAAW,CAAC,EAAE;AAAA,YACnB,SAAS,+BAA+B,KAAK;AAAA,UAC9C,CAAC;AAAA,QACF;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"]}
|
|
@@ -51,30 +51,32 @@ const rule = createRule({
|
|
|
51
51
|
const orderedKeys = Object.keys(orderedSource);
|
|
52
52
|
const { properties } = ast.body[0].expression;
|
|
53
53
|
for (let i = 0; i < properties.length; i += 1) {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
const endCharacters = text.endsWith("\n") ? "\n" : "";
|
|
59
|
-
const newline = detectNewline.graceful(text);
|
|
60
|
-
let result = JSON.stringify(
|
|
61
|
-
orderedSource,
|
|
62
|
-
null,
|
|
63
|
-
type === "tab" ? " " : indent
|
|
64
|
-
) + endCharacters;
|
|
65
|
-
if (newline === "\r\n") {
|
|
66
|
-
result = result.replace(/\n/g, newline);
|
|
67
|
-
}
|
|
68
|
-
return fixer.replaceText(
|
|
69
|
-
context.sourceCode.ast,
|
|
70
|
-
result
|
|
71
|
-
);
|
|
72
|
-
},
|
|
73
|
-
message: "Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.",
|
|
74
|
-
node: context.sourceCode.ast
|
|
75
|
-
});
|
|
76
|
-
break;
|
|
54
|
+
const property = properties[i].key;
|
|
55
|
+
const { value } = property;
|
|
56
|
+
if (value === orderedKeys[i]) {
|
|
57
|
+
continue;
|
|
77
58
|
}
|
|
59
|
+
context.report({
|
|
60
|
+
fix(fixer) {
|
|
61
|
+
const { indent, type } = detectIndent(text);
|
|
62
|
+
const endCharacters = text.endsWith("\n") ? "\n" : "";
|
|
63
|
+
const newline = detectNewline.graceful(text);
|
|
64
|
+
let result = JSON.stringify(
|
|
65
|
+
orderedSource,
|
|
66
|
+
null,
|
|
67
|
+
type === "tab" ? " " : indent
|
|
68
|
+
) + endCharacters;
|
|
69
|
+
if (newline === "\r\n") {
|
|
70
|
+
result = result.replace(/\n/g, newline);
|
|
71
|
+
}
|
|
72
|
+
return fixer.replaceText(
|
|
73
|
+
context.sourceCode.ast,
|
|
74
|
+
result
|
|
75
|
+
);
|
|
76
|
+
},
|
|
77
|
+
loc: properties[i].loc,
|
|
78
|
+
message: `Package top-level property "${value}" is not ordered in the npm standard way. Run the ESLint auto-fixer to correct.`
|
|
79
|
+
});
|
|
78
80
|
}
|
|
79
81
|
}
|
|
80
82
|
};
|
|
@@ -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\
|
|
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\tconst property = properties[i]\n\t\t\t\t\t\t.key as JsonAST.JSONStringLiteral;\n\t\t\t\t\tconst { value } = property;\n\n\t\t\t\t\tif (value === orderedKeys[i]) {\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\tconst { indent, type } = detectIndent(text);\n\t\t\t\t\t\t\tconst endCharacters = text.endsWith(\"\\n\")\n\t\t\t\t\t\t\t\t? \"\\n\"\n\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\tconst newline = detectNewline.graceful(text);\n\t\t\t\t\t\t\tlet result =\n\t\t\t\t\t\t\t\tJSON.stringify(\n\t\t\t\t\t\t\t\t\torderedSource,\n\t\t\t\t\t\t\t\t\tnull,\n\t\t\t\t\t\t\t\t\ttype === \"tab\" ? \"\\t\" : indent,\n\t\t\t\t\t\t\t\t) + endCharacters;\n\t\t\t\t\t\t\tif (newline === \"\\r\\n\") {\n\t\t\t\t\t\t\t\tresult = result.replace(/\\n/g, newline);\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\tcontext.sourceCode.ast,\n\t\t\t\t\t\t\t\tresult,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t},\n\t\t\t\t\t\tloc: properties[i].loc,\n\t\t\t\t\t\tmessage: `Package top-level property \"${value}\" is not ordered in the npm standard way. Run the ESLint auto-fixer to correct.`,\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,gBAAM,WAAW,WAAW,CAAC,EAC3B;AACF,gBAAM,EAAE,MAAM,IAAI;AAElB,cAAI,UAAU,YAAY,CAAC,GAAG;AAC7B;AAAA,UACD;AAEA,kBAAQ,OAAO;AAAA,YACd,IAAI,OAAO;AACV,oBAAM,EAAE,QAAQ,KAAK,IAAI,aAAa,IAAI;AAC1C,oBAAM,gBAAgB,KAAK,SAAS,IAAI,IACrC,OACA;AACH,oBAAM,UAAU,cAAc,SAAS,IAAI;AAC3C,kBAAI,SACH,KAAK;AAAA,gBACJ;AAAA,gBACA;AAAA,gBACA,SAAS,QAAQ,MAAO;AAAA,cACzB,IAAI;AACL,kBAAI,YAAY,QAAQ;AACvB,yBAAS,OAAO,QAAQ,OAAO,OAAO;AAAA,cACvC;AAEA,qBAAO,MAAM;AAAA,gBACZ,QAAQ,WAAW;AAAA,gBACnB;AAAA,cACD;AAAA,YACD;AAAA,YACA,KAAK,WAAW,CAAC,EAAE;AAAA,YACnB,SAAS,+BAA+B,KAAK;AAAA,UAC9C,CAAC;AAAA,QACF;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.15.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": {
|
|
@@ -82,7 +82,7 @@
|
|
|
82
82
|
"cspell": "^8.3.2",
|
|
83
83
|
"eslint": "^8.56.0",
|
|
84
84
|
"eslint-doc-generator": "^1.6.2",
|
|
85
|
-
"eslint-plugin-deprecation": "^
|
|
85
|
+
"eslint-plugin-deprecation": "^3.0.0",
|
|
86
86
|
"eslint-plugin-eslint-comments": "^3.2.0",
|
|
87
87
|
"eslint-plugin-jsdoc": "^48.0.2",
|
|
88
88
|
"eslint-plugin-jsonc": "^2.12.2",
|
|
@@ -98,9 +98,9 @@
|
|
|
98
98
|
"knip": "^5.0.0",
|
|
99
99
|
"lint-staged": "^15.2.0",
|
|
100
100
|
"markdownlint": "^0.34.0",
|
|
101
|
-
"markdownlint-cli": "^0.
|
|
102
|
-
"npm-package-json-lint": "^
|
|
103
|
-
"npm-package-json-lint-config-default": "^
|
|
101
|
+
"markdownlint-cli": "^0.41.0",
|
|
102
|
+
"npm-package-json-lint": "^8.0.0",
|
|
103
|
+
"npm-package-json-lint-config-default": "^7.0.0",
|
|
104
104
|
"prettier": "^3.2.4",
|
|
105
105
|
"prettier-plugin-curly": "^0.2.0",
|
|
106
106
|
"prettier-plugin-packagejson": "^2.4.9",
|
|
@@ -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.3.0",
|
|
119
119
|
"engines": {
|
|
120
120
|
"node": ">=18"
|
|
121
121
|
},
|