Merge pull request #68 from grafana/jackw/clean-package-json

Migrate: Sort package.json fields
grafana · Oct 17, 2022 · bd741f0 · bd741f0
2 parents f0f7ec8 + 0c5a7c3
commit bd741f0
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/src/commands/migrate.command.ts b/src/commands/migrate.command.ts
@@ -9,6 +9,7 @@ import {
   getRemovableNpmDependencies,
   removeNpmDependencies,
   updateNpmScripts,
+  cleanUpPackageJson,
 } from '../utils/utils.npm';
 
 export const migrate = async () => {
@@ -90,7 +91,11 @@ export const migrate = async () => {
       printMessage(TEXT.updateNpmScriptsAborted);
     }
 
-    // 4. Summary
+    // Tidy package.json file so any changed fields are sorted as a
+    // package manager would expect.
+    cleanUpPackageJson();
+
+    // 7. Summary
     // -------------
     printSuccessMessage(TEXT.migrationCommandSuccess);
   } catch (error) {

diff --git a/src/utils/utils.npm.ts b/src/utils/utils.npm.ts
@@ -187,3 +187,20 @@ export function updateNpmScripts() {
 
   writePackageJson(packageJson);
 }
+
+export function cleanUpPackageJson() {
+  const packageJson = getPackageJson();
+  packageJson.scripts = sortKeysAlphabetically(packageJson.scripts);
+  packageJson.dependencies = sortKeysAlphabetically(packageJson.dependencies);
+  packageJson.devDependencies = sortKeysAlphabetically(packageJson.devDependencies);
+  writePackageJson(packageJson);
+}
+
+function sortKeysAlphabetically(obj: Record<string, string>) {
+  return Object.keys(obj)
+    .sort()
+    .reduce<Record<string, string>>((acc, key) => {
+      acc[key] = obj[key];
+      return acc;
+    }, {});
+}