sku 15.7.1 → 15.8.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # sku
 
+## 15.8.0
+
+### Minor Changes
+
+- lint|format: Enforce sorted keys in package.json ([#1480](https://github.com/seek-oss/sku/pull/1480))
+
+  ESLint will now warn if the keys in package.json are not sorted. Running `sku format` will automatically fix the sort order.
+
+  If you need to, you can disable this rule by using `dangerouslySetESLintConfig` in your sku config (not recommended):
+
+  ```ts
+  const config = {
+    ...,
+    dangerouslySetESLintConfig: (esLintConfig) => [
+      ...esLintConfig,
+      {
+        files: ['**/package.json'],
+        rules: {
+          'package-json/sort': 'off',
+        },
+      },
+    ],
+  }
+  ```
+
 ## 15.7.1
 
 ### Patch Changes

package/dist/config/eslint/jsonFiles.mjs

@@ -0,0 +1,12 @@
+import { jsonProcessor, packageJsonPlugin } from "./plugins/package-json.mjs";
+
+//#region src/config/eslint/jsonFiles.ts
+const createJsonFilesConfig = () => [{
+	plugins: { "package-json": packageJsonPlugin },
+	files: ["**/package.json"],
+	rules: { "package-json/sort": "warn" },
+	processor: jsonProcessor
+}];
+
+//#endregion
+export { createJsonFilesConfig };

package/dist/config/eslint/plugins/package-json.mjs

@@ -0,0 +1,59 @@
+import path from "node:path";
+import { sortPackageJson } from "sort-package-json";
+
+//#region src/config/eslint/plugins/package-json.ts
+const sortRule = {
+	meta: {
+		docs: { description: "Enforce package.json sorting" },
+		fixable: "code",
+		schema: [{
+			type: "object",
+			properties: { sortOrder: {
+				type: "array",
+				minItems: 0,
+				items: { type: "string" }
+			} },
+			additionalProperties: false
+		}]
+	},
+	create(context) {
+		const filename = context.filename;
+		if (path.basename(filename) !== "package.json") return {};
+		const sourceCode = context.sourceCode;
+		const options = context.options ? context.options[0] : void 0;
+		return { ExportDefaultDeclaration(node) {
+			const { declaration } = node;
+			if (declaration.type !== "ObjectExpression") return;
+			const packageJsonText = sourceCode.getText(declaration);
+			const sortedText = sortPackageJson(packageJsonText, options);
+			if (packageJsonText !== sortedText) context.report({
+				node,
+				message: "package.json is not sorted correctly.",
+				fix(fixer) {
+					return fixer.replaceText(node, sortedText);
+				}
+			});
+		} };
+	}
+};
+/**
+* Processor for JSON files.
+* Simply prefixes the text with `export default` so it can be parsed by eslint as javascript.
+*/
+const jsonProcessor = {
+	meta: {
+		name: "json-processor",
+		version: "1.0.0"
+	},
+	preprocess(text) {
+		return [`export default ${text}`];
+	},
+	postprocess(messages) {
+		return messages.flat();
+	},
+	supportsAutofix: true
+};
+const packageJsonPlugin = { rules: { sort: sortRule } };
+
+//#endregion
+export { jsonProcessor, packageJsonPlugin };

package/dist/config/eslint.mjs

@@ -1,6 +1,7 @@
 import { getSkuContext } from "../context/createSkuContext.mjs";
 import { createImportOrderConfig } from "./eslint/importOrder.mjs";
 import { createEslintIgnoresConfig } from "./eslint/ignores.mjs";
+import { createJsonFilesConfig } from "./eslint/jsonFiles.mjs";
 
 //#region src/config/eslint/config.ts
 const createEslintConfig = async ({ configPath } = {}) => {
@@ -13,6 +14,7 @@ const createEslintConfig = async ({ configPath } = {}) => {
 			hasLanguagesConfig: Boolean(languages && languages.length > 0),
 			target: relativeTarget
 		}),
+		...createJsonFilesConfig(),
 		...eslintConfigSeek,
 		createImportOrderConfig(skuContext),
 		...eslintIgnore && eslintIgnore.length > 0 ? [{ ignores: [...eslintIgnore] }] : []

package/dist/packages/sku/package.mjs

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "15.7.1";
+var version = "15.8.0";
 var package_default = {
 	name: "sku",
 	version,
@@ -153,6 +153,7 @@ var package_default = {
 		"semver": "^7.3.4",
 		"serialize-javascript": "^7.0.2",
 		"serve-handler": "^6.1.3",
+		"sort-package-json": "^3.6.0",
 		"svgo-loader": "^4.0.0",
 		"terser-webpack-plugin": "^5.1.4",
 		"typescript": "~5.9.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sku",
-  "version": "15.7.1",
+  "version": "15.8.0",
   "description": "Front-end development toolkit, powered by Webpack, Babel, Vanilla Extract and Jest",
   "types": "./dist/index.d.mts",
   "bin": {
@@ -157,6 +157,7 @@
     "semver": "^7.3.4",
     "serialize-javascript": "^7.0.2",
     "serve-handler": "^6.1.3",
+    "sort-package-json": "^3.6.0",
     "svgo-loader": "^4.0.0",
     "terser-webpack-plugin": "^5.1.4",
     "typescript": "~5.9.0",