Merge pull request #10024 from bertdeblock/add-ember-source-to-peer-d…

…ependencies-in-addon-blueprint

[ENHANCEMENT] Add `ember-source` to `peerDependencies` in `addon` blueprint

blueprints/addon/additional-package.json

@@ -0,0 +1,20 @@
+{
+  "keywords": [
+    "ember-addon"
+  ],
+  "scripts": {
+    "test:ember-compatibility": "ember try:each"
+  },
+  "devDependencies": {
+    "@embroider/test-setup": "^1.8.3",
+    "ember-disable-prototype-extensions": "^1.1.3",
+    "ember-source-channel-url": "^3.0.0",
+    "ember-try": "^2.0.0"
+  },
+  "peerDependencies": {
+    "ember-source": "^3.28.0 || ^4.0.0"
+  },
+  "ember-addon": {
+    "configPath": "tests/dummy/config"
+  }
+}

blueprints/addon/index.js

@@ -5,7 +5,7 @@ const path = require('path');
 const walkSync = require('walk-sync');
 const chalk = require('chalk');
 const stringUtil = require('ember-cli-string-utils');
-const { uniq } = require('ember-cli-lodash-subset');
+const { merge, uniq } = require('ember-cli-lodash-subset');
 const SilentError = require('silent-error');
 const sortPackageJson = require('sort-package-json');
 
@@ -22,7 +22,7 @@ const replacers = {
   },
 };
 
-const ADDITIONAL_DEV_DEPENDENCIES = require('./additional-dev-dependencies.json').devDependencies;
+const ADDITIONAL_PACKAGE = require('./additional-package.json');
 
 const description = 'The default blueprint for ember-cli addons.';
 module.exports = {
@@ -43,9 +43,9 @@ module.exports = {
 
     contents.name = stringUtil.dasherize(this.options.entity.name);
     contents.description = this.description;
+
     delete contents.private;
-    contents.scripts = contents.scripts || {};
-    contents.keywords = contents.keywords || [];
+
     contents.dependencies = contents.dependencies || {};
     contents.devDependencies = contents.devDependencies || {};
 
@@ -67,17 +67,7 @@ module.exports = {
     // 100% of addons don't need ember-cli-app-version, make it opt-in instead
     delete contents.devDependencies['ember-cli-app-version'];
 
-    if (contents.keywords.indexOf('ember-addon') === -1) {
-      contents.keywords.push('ember-addon');
-    }
-
-    Object.assign(contents.devDependencies, ADDITIONAL_DEV_DEPENDENCIES);
-
-    // add `ember-compatibility` script in addons
-    contents.scripts['test:ember-compatibility'] = 'ember try:each';
-
-    contents['ember-addon'] = contents['ember-addon'] || {};
-    contents['ember-addon'].configPath = 'tests/dummy/config';
+    merge(contents, ADDITIONAL_PACKAGE);
 
     return stringifyAndNormalize(sortPackageJson(contents));
   },

dev/update-blueprint-dependencies.js

@@ -43,7 +43,7 @@ const OPTIONS = nopt({
 
 const PACKAGE_FILES = [
   '../blueprints/app/files/package.json',
-  '../blueprints/addon/additional-dev-dependencies.json',
+  '../blueprints/addon/additional-package.json',
   '../tests/fixtures/app/defaults/package.json',
   '../tests/fixtures/app/npm/package.json',
   '../tests/fixtures/app/yarn/package.json',

tests/fixtures/addon/defaults/package.json

@@ -65,6 +65,9 @@
     "qunit-dom": "^2.0.0",
     "webpack": "^5.74.0"
   },
+  "peerDependencies": {
+    "ember-source": "^3.28.0 || ^4.0.0"
+  },
   "engines": {
     "node": "14.* || 16.* || >= 18"
   },

tests/fixtures/addon/yarn/package.json

@@ -66,6 +66,9 @@
     "qunit-dom": "^2.0.0",
     "webpack": "^5.74.0"
   },
+  "peerDependencies": {
+    "ember-source": "^3.28.0 || ^4.0.0"
+  },
   "engines": {
     "node": "14.* || 16.* || >= 18"
   },

tests/unit/blueprints/addon-test.js

@@ -184,6 +184,23 @@ describe('blueprint - addon', function () {
         expect(json.dependencies).to.deep.equal({ a: '1', b: '1' });
         expect(json.devDependencies).to.deep.equal({ a: '1', b: '1' });
       });
+
+      it('adds `ember-source` to `peerDependencies`', function () {
+        let output = blueprint.updatePackageJson(
+          JSON.stringify({
+            peerDependencies: {
+              'foo-bar': '^1.0.0',
+            },
+          })
+        );
+
+        let json = JSON.parse(output);
+
+        expect(json.peerDependencies).to.deep.equal({
+          'ember-source': '^3.28.0 || ^4.0.0',
+          'foo-bar': '^1.0.0',
+        });
+      });
     });
   });
 });