sort the addon's package.json and assert it is sorted

Author: BoussonKarel

index.js

@@ -1,9 +1,23 @@
 'use strict';
 
+const path = require('path');
+const { sortPackageJson } = require('sort-package-json');
+const FileInfo = require('@ember-tooling/blueprint-model/utilities/file-info');
+
 let date = new Date();
 
 const description = 'The default blueprint for Embroider v2 addons.';
 
+function stringifyAndNormalize(contents) {
+  return `${JSON.stringify(contents, null, 2)}\n`;
+}
+
+const replacers = {
+  'package.json'(content) {
+    return this.updatePackageJson(content);
+  },
+};
+
 module.exports = {
   description,
 
@@ -60,6 +74,45 @@ module.exports = {
 
     return files;
   },
+
+  updatePackageJson(content) {
+    let contents = JSON.parse(content);
+    return stringifyAndNormalize(sortPackageJson(contents));
+  },
+
+  /**
+   * @override
+   *
+   * This modification of buildFileInfo allows our differing
+   * input files to output to a single file, depending on the options.
+   * For example:
+   *
+   *   for javascript,
+   *     _ts_eslint.config.mjs is deleted
+   *     _js_eslint.config.mjs is renamed to eslint.config.mjs
+   *
+   *   for typescript,
+   *     _js_eslint.config.mjs is deleted
+   *     _ts_eslint.config.mjs is renamed to eslint.config.mjs
+   */
+  buildFileInfo(intoDir, templateVariables, file, _commandOptions) {
+    let mappedPath = this.mapFile(file, templateVariables);
+    let options = {
+      action: 'write',
+      outputBasePath: path.normalize(intoDir),
+      outputPath: path.join(intoDir, mappedPath),
+      displayPath: path.normalize(mappedPath),
+      inputPath: this.srcPath(file),
+      templateVariables,
+      ui: this.ui,
+    };
+
+    if (file in replacers) {
+      options.replacer = replacers[file].bind(this);
+    }
+
+    return new FileInfo(options);
+  },
 };
 
 function buildBlueprintOptions(blueprintOptions) {

package.json

@@ -16,8 +16,10 @@
     "format": "prettier --write ."
   },
   "devDependencies": {
+    "@ember-tooling/blueprint-model": "^0.3.0",
     "prettier": "^3.5.3",
-    "release-plan": "^0.16.0"
+    "release-plan": "^0.16.0",
+    "sort-package-json": "^3.4.0"
   },
   "packageManager": "[email protected]"
 }

pnpm-lock.yaml

@@ -13,9 +13,11 @@ import {
   assertGeneratedCorrectly,
   dirContents,
   matchesFixture,
+  packageJsonAt,
   SUPPORTED_PACKAGE_MANAGERS,
 } from '../helpers.js';
 import { existsSync } from 'node:fs';
+import sortPackageJson from 'sort-package-json';
 
 /**
  * NOTE: tests run sequentially
@@ -108,6 +110,13 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       expect(exitCode).toEqual(0);
     });
 
+    it('has a sorted package.json', async () => {
+      const originalPackageJson = await packageJsonAt(addonDir);
+      const sortedPackageJson = await sortPackageJson(originalPackageJson);
+
+      expect(JSON.stringify(sortedPackageJson)).toEqual(JSON.stringify(originalPackageJson));
+    });
+
     describe('with fixture', () => {
       beforeEach(async () => {
         let addonFixture = fixturify.readSync('./fixtures/addon');