@commercetools-frontend/create-mc-app 22.2.1 → 22.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @commercetools-frontend/create-mc-app
 
+## 22.3.0
+
+### Minor Changes
+
+- [#2976](https://github.com/commercetools/merchant-center-application-kit/pull/2976) [`9add8f46b`](https://github.com/commercetools/merchant-center-application-kit/commit/9add8f46b668fb95b2c966a087bfb00c807ab55e) Thanks [@emmenko](https://github.com/emmenko)! - We migrate from Yarn to Pnpm as the package manager for the App Kit repository. As a result of it there were several packages that didn't specify all the needed dependencies. This is fixed now.
+
+- [#3087](https://github.com/commercetools/merchant-center-application-kit/pull/3087) [`31326fc31`](https://github.com/commercetools/merchant-center-application-kit/commit/31326fc315517e98f98b2b661e7b3d8598ca3316) Thanks [@emmenko](https://github.com/emmenko)! - Support new CLI options `--package-manager`. This is useful to explicitly configure the template with the package manager of you choice.
+
+  For backwards compatibility, Yarn will be automatically used if available if the `--package-manager` option is not provided.
+
 ## 22.2.1
 
 ## 22.2.0

package/dist/commercetools-frontend-create-mc-app.cjs.dev.js

@@ -67,7 +67,7 @@ var prettier__default = /*#__PURE__*/_interopDefault(prettier);
 
 var pkgJson = {
 	name: "@commercetools-frontend/create-mc-app",
-	version: "22.2.1",
+	version: "22.3.0",
 	description: "Create Merchant Center applications to quickly get up and running",
 	bugs: "https://github.com/commercetools/merchant-center-application-kit/issues",
 	repository: {
@@ -93,6 +93,8 @@ var pkgJson = {
 		"@babel/core": "^7.20.12",
 		"@babel/runtime": "^7.20.13",
 		"@babel/runtime-corejs3": "^7.20.13",
+		"@types/babel__core": "^7.20.0",
+		"@types/semver": "^7.5.0",
 		cac: "6.7.14",
 		execa: "5.1.1",
 		listr2: "5.0.8",
@@ -117,14 +119,10 @@ async function getLatestReleaseVersion() {
 
 function hintOutdatedVersion(currentVersion, releaseVersion) {
   var _context;
-
   const hasBeenReleastedInLatestTag = semver__default["default"].gt(releaseVersion, currentVersion);
-
   const hintNewerVersions = _filterInstanceProperty__default["default"](_context = [hasBeenReleastedInLatestTag && "".concat(releaseVersion)]).call(_context, Boolean).join(', ');
-
   if (hintNewerVersions.length > 0) {
     var _context2;
-
     console.log('');
     console.log(_concatInstanceProperty__default["default"](_context2 = "New version available! ".concat(currentVersion, " -> ")).call(_context2, hintNewerVersions));
     console.log('');
@@ -132,7 +130,6 @@ function hintOutdatedVersion(currentVersion, releaseVersion) {
 }
 
 const isSemVer = version => /^(v?)([0-9].[0-9].[0-9])+/.test(version);
-
 const shouldUseYarn = () => {
   try {
     const result = execa__default["default"].commandSync('yarn --version', {
@@ -143,28 +140,30 @@ const shouldUseYarn = () => {
     return false;
   }
 };
-
+const getPreferredPackageManager = options => {
+  if (options.packageManager) {
+    return options.packageManager;
+  }
+  // Attempt to use yarn (backwards compatibility)
+  if (shouldUseYarn()) {
+    return 'yarn';
+  }
+  // Fall back to npm
+  return 'npm';
+};
 const slugify = name => name.toLowerCase().replace(/_/gi, '-');
-
 const upperFirst = value => value.charAt(0).toUpperCase() + _sliceInstanceProperty__default["default"](value).call(value, 1);
-
 const wordify = slug => {
   var _context;
-
   return _mapInstanceProperty__default["default"](_context = slug.split('-')).call(_context, word => upperFirst(word)).join(' ');
 };
-
 const resolveFilePathByExtension = requestedModule => {
   var _context2, _context4;
-
   const fileExtension = _findInstanceProperty__default["default"](_context2 = ['.js', '.ts', '.mjs', '.cjs']).call(_context2, ext => {
     var _context3;
-
     const filePath = _concatInstanceProperty__default["default"](_context3 = "".concat(requestedModule)).call(_context3, ext);
-
     return fs__default["default"].existsSync(filePath);
   });
-
   return _concatInstanceProperty__default["default"](_context4 = "".concat(requestedModule)).call(_context4, fileExtension);
 };
 
@@ -172,112 +171,91 @@ const availableTemplates = {
   starter: 'starter',
   'starter-typescript': 'starter-typescript'
 };
-
 const throwIfTemplateIsNotSupported = templateName => {
   var _context;
-
   switch (templateName) {
     case availableTemplates.starter:
     case availableTemplates['starter-typescript']:
       break;
-
     default:
       const templateNamesList = _Object$keys__default["default"](availableTemplates).toString();
-
       throw new Error(_concatInstanceProperty__default["default"](_context = "The provided template name \"".concat(templateName, "\" does not exist. Available templates are \"")).call(_context, templateNamesList, "\". Make sure you are also using the latest version of \"@commercetools-frontend/create-mc-app\"."));
   }
 };
-
 const throwIfProjectDirectoryExists = (dirName, dirPath) => {
   if (fs__default["default"].existsSync(dirPath)) {
     var _context2;
-
     throw new Error(_concatInstanceProperty__default["default"](_context2 = "A directory named \"".concat(dirName, "\" already exists at this location \"")).call(_context2, dirPath, "\". Please choose a different project name or remove the directory, then try running the command again."));
   }
 };
-
 const throwIfTemplateVersionDoesNotExist = (templateName, templateFolderPath, versionToCheck) => {
   if (!fs__default["default"].existsSync(templateFolderPath)) {
     var _context3;
-
     throw new Error(_concatInstanceProperty__default["default"](_context3 = "The downloaded template \"".concat(templateName, "\" does not exist for the given version \"")).call(_context3, versionToCheck, "\". Check the releases page if you are looking for a specific version: https://github.com/commercetools/merchant-center-application-kit/releases"));
-  } // In case the version is semver (usually release tags) we check that
+  }
+  // In case the version is semver (usually release tags) we check that
   // the cloned repository contains the template matching the given version
-
-
   if (isSemVer(versionToCheck)) {
     const templatePackageJson = JSON.parse(fs__default["default"].readFileSync(path__default["default"].join(templateFolderPath, 'package.json'), {
       encoding: 'utf8'
     }));
     const versionAsNumber = versionToCheck.replace('v', '');
-
     if (templatePackageJson.version !== versionAsNumber) {
       var _context4, _context5;
-
       throw new Error(_concatInstanceProperty__default["default"](_context4 = _concatInstanceProperty__default["default"](_context5 = "The downloaded template \"".concat(templateName, "\" does not match the version \"")).call(_context5, versionAsNumber, "\", instead got \"")).call(_context4, templatePackageJson.version, "\". Check the releases page if you want to provide a specific version: https://github.com/commercetools/merchant-center-application-kit/releases"));
     }
   }
 };
-
 const throwIfInitialProjectKeyIsMissing = initialProjectKey => {
   if (!initialProjectKey) {
     throw new Error("Provide a valid project key that you have access to.");
   }
 };
-
 const throwIfNodeVersionIsNotSupported = (currentNodeVersion, expectedVersionRange) => {
   const hasValidNodeVersion = semver__default["default"].satisfies(currentNodeVersion, expectedVersionRange);
-
   if (!hasValidNodeVersion) {
     var _context6;
-
     throw new Error(_concatInstanceProperty__default["default"](_context6 = "You are running Node ".concat(currentNodeVersion, " but create-mc-app requires Node ")).call(_context6, expectedVersionRange, ". Please update your version of Node."));
   }
 };
 
 const question = (rl, value) => new _Promise__default["default"](resolve => rl.question(value, resolve));
-
 const getEntryPointUriPath = async (rl, options) => {
   var _context;
-
   if (options.entryPointUriPath) {
     return options.entryPointUriPath;
   }
-
   const randomEntryPointUriPath = _concatInstanceProperty__default["default"](_context = "".concat(options.template, "-")).call(_context, crypto__default["default"].randomBytes(3).toString('hex'));
-
   if (options.yes) {
     return randomEntryPointUriPath;
   }
-
   const answerEntryPointUriPath = await question(rl, "Provide the Custom Application entryPointUriPath (default \"".concat(randomEntryPointUriPath, "\"): "));
   return answerEntryPointUriPath || randomEntryPointUriPath;
 };
-
 const getInitialProjectKey = async (rl, options) => {
   if (options.initialProjectKey) {
     return options.initialProjectKey;
   }
-
   const initialProjectKey = await question(rl, "Provide the initial project key for local development: ");
   throwIfInitialProjectKeyIsMissing(initialProjectKey);
   return initialProjectKey;
 };
-
 async function processOptions(projectDirectoryName, options) {
   if (!projectDirectoryName) {
     throw new Error('Missing required argument "[project-directory]"');
   }
+  const projectDirectoryPath = path__default["default"].resolve(projectDirectoryName);
 
-  const projectDirectoryPath = path__default["default"].resolve(projectDirectoryName); // Parse options
-
+  // Parse options
   let tagOrBranchVersion = options.templateVersion || 'main';
   tagOrBranchVersion = isSemVer(tagOrBranchVersion) && !_startsWithInstanceProperty__default["default"](tagOrBranchVersion).call(tagOrBranchVersion, 'v') ? "v".concat(tagOrBranchVersion) : tagOrBranchVersion;
-  const templateName = options.template; // Validate options
+  const templateName = options.template;
 
+  // Validate options
   throwIfProjectDirectoryExists(projectDirectoryName, projectDirectoryPath);
-  throwIfTemplateIsNotSupported(templateName); // Read prompts
+  throwIfTemplateIsNotSupported(templateName);
 
+  // Read prompts
   const rl = readline__default["default"].createInterface({
     input: process.stdin,
     output: process.stdout
@@ -291,18 +269,17 @@ async function processOptions(projectDirectoryName, options) {
     templateName,
     tagOrBranchVersion,
     entryPointUriPath,
-    initialProjectKey
+    initialProjectKey,
+    packageManager: options.packageManager
   };
 }
 
 const filesToBeRemoved = ['CHANGELOG.md'];
-
 function downloadTemplate(options) {
   return {
     title: 'Downloading template',
     task: () => {
       var _context;
-
       const tmpDir = os__default["default"].tmpdir();
       const tmpFolderNameForClonedRepository = ['merchant-center-application-kit', '--', options.tagOrBranchVersion, '--', _Date$now__default["default"]().toString()].join('');
       const clonedRepositoryPath = path__default["default"].join(tmpDir, tmpFolderNameForClonedRepository);
@@ -315,11 +292,9 @@ function downloadTemplate(options) {
             cwd: tmpDir,
             encoding: 'utf-8'
           });
-
           if (result.failed) {
             throw new Error(result.stderr);
           }
-
           throwIfTemplateVersionDoesNotExist(options.templateName, clonedRepositoryPath, options.tagOrBranchVersion);
           return result.stdout;
         }
@@ -327,21 +302,18 @@ function downloadTemplate(options) {
         title: _concatInstanceProperty__default["default"](_context = "Copying template ".concat(options.templateName, " into project directory ")).call(_context, options.projectDirectoryPath),
         task: async () => {
           const command = process.platform === 'win32' || process.platform === 'cygwin' ? 'move' : 'mv';
-          const result = await execa__default["default"](command, [templateFolderPath, // Wrap folder path in quotes to avoid issues with empty spaces in the folder names.
+          const result = await execa__default["default"](command, [templateFolderPath,
+          // Wrap folder path in quotes to avoid issues with empty spaces in the folder names.
           options.projectDirectoryPath], {
             encoding: 'utf-8'
           });
-
           if (result.failed) {
             throw new Error(result.stderr);
           }
-
           const templatePackageJsonPath = path__default["default"].join(options.projectDirectoryPath, 'package.json');
-
           if (!fs__default["default"].existsSync(templatePackageJsonPath)) {
             throw new Error("Unable to verify that the template application has a package.json at \"".concat(templatePackageJsonPath, "\""));
           }
-
           return result.stdout;
         }
       }, {
@@ -351,11 +323,9 @@ function downloadTemplate(options) {
           const result = await execa__default["default"](command, _mapInstanceProperty__default["default"](filesToBeRemoved).call(filesToBeRemoved, filePath => path__default["default"].join(options.projectDirectoryPath, filePath)), {
             encoding: 'utf-8'
           });
-
           if (result.failed) {
             throw new Error(result.stderr);
           }
-
           return result.stdout;
         }
       }]);
@@ -367,10 +337,10 @@ function installDependencies(options) {
   return {
     title: 'Installing dependencies (this might take a while)',
     task: () => {
-      const useYarn = shouldUseYarn();
-      const packageManager = useYarn ? 'yarn' : 'npm'; // TODO: we could check for min yarn/npm versions
-      // See https://github.com/facebook/create-react-app/blob/0f4781e8507249ce29a9ac1409fece67c1a53c38/packages/create-react-app/createReactApp.js#L225-L254
+      const packageManager = getPreferredPackageManager(options);
 
+      // TODO: we could check for min yarn/npm versions
+      // See https://github.com/facebook/create-react-app/blob/0f4781e8507249ce29a9ac1409fece67c1a53c38/packages/create-react-app/createReactApp.js#L225-L254
       return execa__default["default"](packageManager, ['install'], {
         cwd: options.projectDirectoryPath,
         encoding: 'utf-8'
@@ -380,25 +350,20 @@ function installDependencies(options) {
 }
 
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context2, _context3; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(source), !0)).call(_context2, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](target, _Object$getOwnPropertyDescriptors__default["default"](source)) : _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(source))).call(_context3, function (key) { _Object$defineProperty__default["default"](target, key, _Object$getOwnPropertyDescriptor__default["default"](source, key)); }); } return target; }
-
 const replaceApplicationKitPackageVersionWith = function (releaseVersion) {
   var _context;
-
   let dependencies = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return _reduceInstanceProperty__default["default"](_context = _Object$entries__default["default"](dependencies)).call(_context, (updatedDependencies, _ref) => {
     let _ref2 = _slicedToArray(_ref, 2),
-        dependencyName = _ref2[0],
-        dependencyVersion = _ref2[1];
-
+      dependencyName = _ref2[0],
+      dependencyVersion = _ref2[1];
     const updatedVersion = dependencyVersion === 'workspace:*' ? releaseVersion : dependencyVersion;
     return _objectSpread(_objectSpread({}, updatedDependencies), {}, {
       [dependencyName]: updatedVersion
     });
   }, {});
 };
-
 function updatePackageJson(options, releaseVersion) {
   return {
     title: 'Updating package.json',
@@ -407,7 +372,7 @@ function updatePackageJson(options, releaseVersion) {
       const appPackageJson = JSON.parse(fs__default["default"].readFileSync(packageJsonPath, {
         encoding: 'utf8'
       }));
-
+      const packageManager = getPreferredPackageManager(options);
       const updatedAppPackageJson = _Object$assign__default["default"]({}, appPackageJson, {
         version: '1.0.0',
         // Given the package name is derived from the `projectDirectoryName`
@@ -418,9 +383,11 @@ function updatePackageJson(options, releaseVersion) {
         description: '',
         // Replace the package versions with the `workspace:` syntax to the real version.
         dependencies: replaceApplicationKitPackageVersionWith(releaseVersion, appPackageJson.dependencies),
-        devDependencies: replaceApplicationKitPackageVersionWith(releaseVersion, appPackageJson.devDependencies)
+        devDependencies: replaceApplicationKitPackageVersionWith(releaseVersion, appPackageJson.devDependencies),
+        scripts: _objectSpread(_objectSpread({}, appPackageJson.scripts), {}, {
+          'start:prod:local': appPackageJson.scripts['start:prod:local'].replace('yarn', packageManager)
+        })
       });
-
       fs__default["default"].writeFileSync(packageJsonPath, _JSON$stringify__default["default"](updatedAppPackageJson, null, 2) + os__default["default"].EOL, {
         encoding: 'utf8'
       });
@@ -440,32 +407,27 @@ function replaceApplicationInfoInCustomApplicationConfig(filePath, options) {
             }) && nodePath.parent.type === 'ObjectProperty') {
               nodePath.parent.value = core.types.stringLiteral(appName);
             }
-
             if (nodePath.isIdentifier({
               name: 'initialProjectKey'
             }) && nodePath.parent.type === 'ObjectProperty') {
               nodePath.parent.value = core.types.stringLiteral(options.initialProjectKey);
             }
-
             if (nodePath.isIdentifier({
               name: 'defaultLabel'
             })) {
               const isMainMenuLinkParent = nodePath.findParent(parentPath => parentPath.isIdentifier({
                 name: 'mainMenuLink'
               }));
-
               if (isMainMenuLinkParent && nodePath.parent.type === 'ObjectProperty') {
                 nodePath.parent.value = core.types.stringLiteral(appName);
               }
             }
           }
-
         }
       };
     }],
     retainLines: true
   });
-
   if (result !== null && result !== void 0 && result.code) {
     const prettierConfig = prettier__default["default"].resolveConfig.sync(options.projectDirectoryPath);
     const formattedData = prettier__default["default"].format(result.code + os__default["default"].EOL, prettierConfig !== null && prettierConfig !== void 0 ? prettierConfig : undefined);
@@ -474,7 +436,6 @@ function replaceApplicationInfoInCustomApplicationConfig(filePath, options) {
     });
   }
 }
-
 function updateCustomApplicationConfig(options) {
   return {
     title: 'Updating Custom Applications config',
@@ -495,13 +456,11 @@ function replaceEntryPointUriPathInConstants(filePath, options) {
               nodePath.node.init = core.types.stringLiteral(options.entryPointUriPath);
             }
           }
-
         }
       };
     }],
     retainLines: true
   });
-
   if (result !== null && result !== void 0 && result.code) {
     const prettierConfig = prettier__default["default"].resolveConfig.sync(options.projectDirectoryPath);
     const formattedData = prettier__default["default"].format(result.code + os__default["default"].EOL, prettierConfig !== null && prettierConfig !== void 0 ? prettierConfig : undefined);
@@ -510,7 +469,6 @@ function replaceEntryPointUriPathInConstants(filePath, options) {
     });
   }
 }
-
 function updateApplicationConstants(options) {
   return {
     title: 'Updating application constants',
@@ -522,14 +480,14 @@ function updateApplicationConstants(options) {
 }
 
 throwIfNodeVersionIsNotSupported(process.versions.node, pkgJson.engines.node);
-const cli = cac.cac('create-mc-app'); // Makes the script crash on unhandled rejections instead of silently
+const cli = cac.cac('create-mc-app');
+
+// Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
 // terminate the Node.js process with a non-zero exit code.
-
 process.on('unhandledRejection', err => {
   throw err;
 });
-
 const run = () => {
   // Default command
   cli.command('[project-directory]').usage('[project-directory]\n\n  Bootstraps a new Custom Application project using one of the predefined templates.').option('--template <name>', '(optional) The name of the template to install.', {
@@ -540,34 +498,33 @@ const run = () => {
     default: false
   }).option('--yes', '(optional) If set, the prompt options with default values will be skipped.', {
     default: false
-  }).option('--entry-point-uri-path <value>', '(optional) The version of the template to install. (default: starter-<hash>)').option('--initial-project-key <value>', '(optional) A commercetools project key used for the initial login in development. By default, the value is prompted in the terminal.').action(async (projectDirectory, options) => {
+  }).option('--entry-point-uri-path <value>', '(optional) The version of the template to install. (default: starter-<hash>)').option('--initial-project-key <value>', '(optional) A commercetools project key used for the initial login in development. By default, the value is prompted in the terminal.').option('--package-manager <value>', '(optional) The preferred package manager to use: npm, yarn, pnpm.').action(async (projectDirectory, options) => {
     var _context;
-
     if (!projectDirectory) {
       cli.outputHelp();
       return;
     }
-
     const releaseVersion = await getLatestReleaseVersion();
     hintOutdatedVersion(pkgJson.version, releaseVersion);
     console.log('');
     console.log("Documentation available at https://docs.commercetools.com/custom-applications");
     console.log('');
     const taskOptions = await processOptions(projectDirectory, options);
-    const taskList = new listr2.Listr(_filterInstanceProperty__default["default"](_context = [downloadTemplate(taskOptions), updatePackageJson(taskOptions, releaseVersion), updateCustomApplicationConfig(taskOptions), updateApplicationConstants(taskOptions), !options.skipInstall && installDependencies(taskOptions)]).call(_context, Boolean));
+    const shouldInstallDependencies = !options.skipInstall ||
+    // TODO: remove once we manage to ensure the package manager is installed, for example via Corepack.
+    options.packageManager === 'pnpm';
+    const taskList = new listr2.Listr(_filterInstanceProperty__default["default"](_context = [downloadTemplate(taskOptions), updatePackageJson(taskOptions, releaseVersion), updateCustomApplicationConfig(taskOptions), updateApplicationConstants(taskOptions), shouldInstallDependencies && installDependencies(taskOptions)]).call(_context, Boolean));
     await taskList.run();
-    const useYarn = shouldUseYarn();
+    const packageManager = getPreferredPackageManager(taskOptions);
     console.log('');
     console.log("\uD83C\uDF89 \uD83C\uDF89 \uD83C\uDF89 The Custom Application has been created in the \"".concat(taskOptions.projectDirectoryName, "\" folder."));
     console.log('');
     console.log("To get started:");
     console.log("$ cd ".concat(taskOptions.projectDirectoryName));
-
-    if (options.skipInstall) {
-      console.log("$ ".concat(useYarn ? 'yarn' : 'npm', " install"));
+    if (!shouldInstallDependencies) {
+      console.log("$ ".concat(packageManager, " install"));
     }
-
-    console.log("$ ".concat(useYarn ? 'yarn' : 'npm', " start"));
+    console.log("$ ".concat(packageManager, " start"));
     console.log('');
     console.log("Visit https://docs.commercetools.com/custom-applications for more info about developing Custom Applications. Enjoy \uD83D\uDE80");
   });