@commercetools-frontend/create-mc-app 23.2.0 → 23.2.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @commercetools-frontend/create-mc-app
 
+## 23.2.2
+
+### Patch Changes
+
+- [#3749](https://github.com/commercetools/merchant-center-application-kit/pull/3749) [`e9cd323`](https://github.com/commercetools/merchant-center-application-kit/commit/e9cd3235c235304809bf3cfe336c3e3e3ab85468) Thanks [@emmenko](https://github.com/emmenko)! - Fix parsing of CLI arguments
+
+- Updated dependencies []:
+  - @commercetools-frontend/application-config@23.2.2
+
+## 23.2.1
+
+### Patch Changes
+
+- [#3739](https://github.com/commercetools/merchant-center-application-kit/pull/3739) [`9dba306`](https://github.com/commercetools/merchant-center-application-kit/commit/9dba306fd920a53a027e1a4ded112c1a09eaefc3) Thanks [@emmenko](https://github.com/emmenko)! - Migrate CLI program to `commander`.
+
+- Updated dependencies []:
+  - @commercetools-frontend/application-config@23.2.1
+
 ## 23.2.0
 
 ### Patch Changes

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
-var cac = require('cac');
+var commander = require('commander');
 var listr2 = require('listr2');
 var execa = require('execa');
 var semver = require('semver');
@@ -70,7 +70,7 @@ var prettier__default = /*#__PURE__*/_interopDefault(prettier);
 
 var pkgJson = {
 	name: "@commercetools-frontend/create-mc-app",
-	version: "23.2.0",
+	version: "23.2.2",
 	description: "Create Merchant Center applications to quickly get up and running",
 	bugs: "https://github.com/commercetools/merchant-center-application-kit/issues",
 	repository: {
@@ -96,10 +96,10 @@ var pkgJson = {
 		"@babel/core": "^7.22.17",
 		"@babel/runtime": "^7.22.15",
 		"@babel/runtime-corejs3": "^7.22.15",
-		"@commercetools-frontend/application-config": "^23.2.0",
+		"@commercetools-frontend/application-config": "^23.2.2",
 		"@types/babel__core": "^7.20.1",
 		"@types/semver": "^7.5.1",
-		cac: "6.7.14",
+		commander: "^13.1.0",
 		execa: "5.1.1",
 		listr2: "5.0.8",
 		prettier: "2.8.8",
@@ -551,7 +551,7 @@ function updateApplicationConstants(options) {
 }
 
 throwIfNodeVersionIsNotSupported(process.versions.node, pkgJson.engines.node);
-const cli = cac.cac('create-mc-app');
+commander.program.name('create-mc-app').description('CLI to create a new Merchant Center customizations project based on the pre-defined templates.').version(pkgJson.version);
 
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
@@ -569,22 +569,8 @@ const messagesByApplicationType = {
 };
 const run = () => {
   // Default command
-  cli.command('[project-directory]').usage('[project-directory]\n\n  Bootstraps a new project using one of the predefined templates.').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', {
-    default: applicationTypes['custom-application']
-  }).option('--template <name>', '(optional) The name of the template to install.', {
-    default: availableTemplates.starter
-  }).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', {
-    default: 'main'
-  }).option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', {
-    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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. (default: gcp-eu)').option('--package-manager <value>', '(optional) The preferred package manager to use: npm, yarn, pnpm.').action(async (projectDirectory, options) => {
+  commander.program.argument('<project-directory>').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', applicationTypes['custom-application']).option('--template <name>', '(optional) The name of the template to install.', availableTemplates.starter).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', 'main').option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', false).option('--yes', '(optional) If set, the prompt options with default values will be skipped.', 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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. 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);
     const taskOptions = await processOptions(projectDirectory, options);
@@ -610,9 +596,7 @@ const run = () => {
     console.log('');
     console.log(`Visit https://docs.commercetools.com/merchant-center-customizations/ for more info about developing ${messages.featureName}. Enjoy 🚀`);
   });
-  cli.help();
-  cli.version(pkgJson.version);
-  cli.parse();
+  commander.program.parse();
 };
 
 exports.cli = run;

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
-var cac = require('cac');
+var commander = require('commander');
 var listr2 = require('listr2');
 var execa = require('execa');
 var semver = require('semver');
@@ -70,7 +70,7 @@ var prettier__default = /*#__PURE__*/_interopDefault(prettier);
 
 var pkgJson = {
 	name: "@commercetools-frontend/create-mc-app",
-	version: "23.2.0",
+	version: "23.2.2",
 	description: "Create Merchant Center applications to quickly get up and running",
 	bugs: "https://github.com/commercetools/merchant-center-application-kit/issues",
 	repository: {
@@ -96,10 +96,10 @@ var pkgJson = {
 		"@babel/core": "^7.22.17",
 		"@babel/runtime": "^7.22.15",
 		"@babel/runtime-corejs3": "^7.22.15",
-		"@commercetools-frontend/application-config": "^23.2.0",
+		"@commercetools-frontend/application-config": "^23.2.2",
 		"@types/babel__core": "^7.20.1",
 		"@types/semver": "^7.5.1",
-		cac: "6.7.14",
+		commander: "^13.1.0",
 		execa: "5.1.1",
 		listr2: "5.0.8",
 		prettier: "2.8.8",
@@ -551,7 +551,7 @@ function updateApplicationConstants(options) {
 }
 
 throwIfNodeVersionIsNotSupported(process.versions.node, pkgJson.engines.node);
-const cli = cac.cac('create-mc-app');
+commander.program.name('create-mc-app').description('CLI to create a new Merchant Center customizations project based on the pre-defined templates.').version(pkgJson.version);
 
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
@@ -569,22 +569,8 @@ const messagesByApplicationType = {
 };
 const run = () => {
   // Default command
-  cli.command('[project-directory]').usage('[project-directory]\n\n  Bootstraps a new project using one of the predefined templates.').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', {
-    default: applicationTypes['custom-application']
-  }).option('--template <name>', '(optional) The name of the template to install.', {
-    default: availableTemplates.starter
-  }).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', {
-    default: 'main'
-  }).option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', {
-    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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. (default: gcp-eu)').option('--package-manager <value>', '(optional) The preferred package manager to use: npm, yarn, pnpm.').action(async (projectDirectory, options) => {
+  commander.program.argument('<project-directory>').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', applicationTypes['custom-application']).option('--template <name>', '(optional) The name of the template to install.', availableTemplates.starter).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', 'main').option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', false).option('--yes', '(optional) If set, the prompt options with default values will be skipped.', 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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. 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);
     const taskOptions = await processOptions(projectDirectory, options);
@@ -610,9 +596,7 @@ const run = () => {
     console.log('');
     console.log(`Visit https://docs.commercetools.com/merchant-center-customizations/ for more info about developing ${messages.featureName}. Enjoy 🚀`);
   });
-  cli.help();
-  cli.version(pkgJson.version);
-  cli.parse();
+  commander.program.parse();
 };
 
 exports.cli = run;

package/dist/commercetools-frontend-create-mc-app.esm.js

@@ -1,5 +1,5 @@
 import _filterInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/filter';
-import { cac } from 'cac';
+import { program } from 'commander';
 import { Listr } from 'listr2';
 import execa from 'execa';
 import semver from 'semver';
@@ -35,7 +35,7 @@ import prettier from 'prettier';
 
 var pkgJson = {
 	name: "@commercetools-frontend/create-mc-app",
-	version: "23.2.0",
+	version: "23.2.2",
 	description: "Create Merchant Center applications to quickly get up and running",
 	bugs: "https://github.com/commercetools/merchant-center-application-kit/issues",
 	repository: {
@@ -61,10 +61,10 @@ var pkgJson = {
 		"@babel/core": "^7.22.17",
 		"@babel/runtime": "^7.22.15",
 		"@babel/runtime-corejs3": "^7.22.15",
-		"@commercetools-frontend/application-config": "^23.2.0",
+		"@commercetools-frontend/application-config": "^23.2.2",
 		"@types/babel__core": "^7.20.1",
 		"@types/semver": "^7.5.1",
-		cac: "6.7.14",
+		commander: "^13.1.0",
 		execa: "5.1.1",
 		listr2: "5.0.8",
 		prettier: "2.8.8",
@@ -516,7 +516,7 @@ function updateApplicationConstants(options) {
 }
 
 throwIfNodeVersionIsNotSupported(process.versions.node, pkgJson.engines.node);
-const cli = cac('create-mc-app');
+program.name('create-mc-app').description('CLI to create a new Merchant Center customizations project based on the pre-defined templates.').version(pkgJson.version);
 
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
@@ -534,22 +534,8 @@ const messagesByApplicationType = {
 };
 const run = () => {
   // Default command
-  cli.command('[project-directory]').usage('[project-directory]\n\n  Bootstraps a new project using one of the predefined templates.').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', {
-    default: applicationTypes['custom-application']
-  }).option('--template <name>', '(optional) The name of the template to install.', {
-    default: availableTemplates.starter
-  }).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', {
-    default: 'main'
-  }).option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', {
-    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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. (default: gcp-eu)').option('--package-manager <value>', '(optional) The preferred package manager to use: npm, yarn, pnpm.').action(async (projectDirectory, options) => {
+  program.argument('<project-directory>').option('--application-type <type>', '(optional) The type of the application to create: custom-application (default) or custom-view.', applicationTypes['custom-application']).option('--template <name>', '(optional) The name of the template to install.', availableTemplates.starter).option('--template-version <version>', '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).', 'main').option('--skip-install', '(optional) Skip installing the dependencies after cloning the template.', false).option('--yes', '(optional) If set, the prompt options with default values will be skipped.', 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.').option('--cloud-identifier <value>', '(optional) Cloud region identifier. 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);
     const taskOptions = await processOptions(projectDirectory, options);
@@ -575,9 +561,7 @@ const run = () => {
     console.log('');
     console.log(`Visit https://docs.commercetools.com/merchant-center-customizations/ for more info about developing ${messages.featureName}. Enjoy 🚀`);
   });
-  cli.help();
-  cli.version(pkgJson.version);
-  cli.parse();
+  program.parse();
 };
 
 export { run as cli };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/create-mc-app",
-  "version": "23.2.0",
+  "version": "23.2.2",
   "description": "Create Merchant Center applications to quickly get up and running",
   "bugs": "https://github.com/commercetools/merchant-center-application-kit/issues",
   "repository": {
@@ -26,10 +26,10 @@
     "@babel/core": "^7.22.17",
     "@babel/runtime": "^7.22.15",
     "@babel/runtime-corejs3": "^7.22.15",
-    "@commercetools-frontend/application-config": "^23.2.0",
+    "@commercetools-frontend/application-config": "^23.2.2",
     "@types/babel__core": "^7.20.1",
     "@types/semver": "^7.5.1",
-    "cac": "6.7.14",
+    "commander": "^13.1.0",
     "execa": "5.1.1",
     "listr2": "5.0.8",
     "prettier": "2.8.8",

package/src/cli.ts

@@ -1,4 +1,4 @@
-import { cac } from 'cac';
+import { program } from 'commander';
 import { Listr, type ListrTask } from 'listr2';
 import pkgJson from '../package.json';
 import { applicationTypes, availableTemplates } from './constants';
@@ -12,7 +12,12 @@ import { throwIfNodeVersionIsNotSupported } from './validations';
 
 throwIfNodeVersionIsNotSupported(process.versions.node, pkgJson.engines.node);
 
-const cli = cac('create-mc-app');
+program
+  .name('create-mc-app')
+  .description(
+    'CLI to create a new Merchant Center customizations project based on the pre-defined templates.'
+  )
+  .version(pkgJson.version);
 
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
@@ -32,35 +37,32 @@ const messagesByApplicationType = {
 
 const run = () => {
   // Default command
-  cli
-    .command('[project-directory]')
-    .usage(
-      '[project-directory]\n\n  Bootstraps a new project using one of the predefined templates.'
-    )
+  program
+    .argument('<project-directory>')
     .option(
       '--application-type <type>',
       '(optional) The type of the application to create: custom-application (default) or custom-view.',
-      { default: applicationTypes['custom-application'] }
+      applicationTypes['custom-application']
     )
     .option(
       '--template <name>',
       '(optional) The name of the template to install.',
-      { default: availableTemplates.starter }
+      availableTemplates.starter
     )
     .option(
       '--template-version <version>',
       '(optional) The version of the template to install (either a git tag or a git branch of the "commercetools/merchant-center-application-kit" repository).',
-      { default: 'main' }
+      'main'
     )
     .option(
       '--skip-install',
       '(optional) Skip installing the dependencies after cloning the template.',
-      { default: false }
+      false
     )
     .option(
       '--yes',
       '(optional) If set, the prompt options with default values will be skipped.',
-      { default: false }
+      false
     )
     .option(
       '--entry-point-uri-path <value>',
@@ -72,18 +74,13 @@ const run = () => {
     )
     .option(
       '--cloud-identifier <value>',
-      '(optional) Cloud region identifier. (default: gcp-eu)'
+      '(optional) Cloud region identifier. 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: TCliCommandOptions) => {
-      if (!projectDirectory) {
-        cli.outputHelp();
-        return;
-      }
-
+    .action(async (projectDirectory: string, options: TCliCommandOptions) => {
       const releaseVersion = await getLatestReleaseVersion();
 
       hintOutdatedVersion(pkgJson.version, releaseVersion);
@@ -132,10 +129,7 @@ const run = () => {
       );
     });
 
-  cli.help();
-  cli.version(pkgJson.version);
-
-  cli.parse();
+  program.parse();
 };
 
 export default run;