fix: add pre-release warning text, hide pre-release commands from hel…

…p listing (#674) 1. fixed app install unzip concurrency issue
adobe · May 16, 2023 · 0eaa3fb · 0eaa3fb
1 parent def82b7
commit 0eaa3fb
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/src/BaseCommand.js b/src/BaseCommand.js
@@ -165,6 +165,10 @@ class BaseCommand extends Command {
   get appVersion () {
     return this.pjson.version
   }
+
+  preRelease () {
+    this.log(chalk.yellow('Pre-release warning: This command is in pre-release, and not suitable for production.'))
+  }
 }
 
 BaseCommand.flags = {

diff --git a/src/commands/app/install.js b/src/commands/app/install.js
@@ -21,11 +21,14 @@ const { validateJsonWithSchema } = require('../../lib/install-helper')
 const jsYaml = require('js-yaml')
 const { USER_CONFIG_FILE, DEPLOY_CONFIG_FILE } = require('../../lib/defaults')
 const ora = require('ora')
+const chalk = require('chalk')
 
 class InstallCommand extends BaseCommand {
   async run () {
     const { args, flags } = await this.parse(InstallCommand)
 
+    this.preRelease()
+
     aioLogger.debug(`flags: ${JSON.stringify(flags, null, 2)}`)
     aioLogger.debug(`args: ${JSON.stringify(args, null, 2)}`)
 
@@ -100,10 +103,8 @@ class InstallCommand extends BaseCommand {
 
     this.spinner.start(`Extracting app package to ${destFolderPath}...`)
     return unzipper.Open.file(zipFilePath)
-      .then((d) => {
-        d.extract({ path: destFolderPath, concurrency: 5 })
-        this.spinner.succeed(`Extracted app package to ${destFolderPath}`)
-      })
+      .then((d) => d.extract({ path: destFolderPath }))
+      .then(() => this.spinner.succeed(`Extracted app package to ${destFolderPath}`))
   }
 
   async validateConfig (outputPath, configFileName, configFilePath = path.join(outputPath, configFileName)) {
@@ -140,8 +141,10 @@ class InstallCommand extends BaseCommand {
   }
 }
 
-InstallCommand.description = `Install an Adobe Developer App Builder packaged app
-`
+InstallCommand.hidden = true // hide from help for pre-release
+
+InstallCommand.description = chalk.yellow(`(Pre-release) This command will support installing apps packaged by '<%= config.bin %> app pack'.
+`)
 
 InstallCommand.flags = {
   ...BaseCommand.flags,

diff --git a/src/commands/app/pack.js b/src/commands/app/pack.js
@@ -20,6 +20,7 @@ const execa = require('execa')
 const { loadConfigFile, writeFile } = require('../../lib/import-helper')
 const { getObjectValue } = require('../../lib/app-helper')
 const ora = require('ora')
+const chalk = require('chalk')
 
 const DEFAULTS = {
   OUTPUT_ZIP_FILE: 'app.zip',
@@ -31,6 +32,8 @@ class Pack extends BaseCommand {
   async run () {
     const { args, flags } = await this.parse(Pack)
 
+    this.preRelease()
+
     aioLogger.debug(`flags: ${JSON.stringify(flags, null, 2)}`)
     aioLogger.debug(`args: ${JSON.stringify(args, null, 2)}`)
 
@@ -268,8 +271,10 @@ class Pack extends BaseCommand {
   }
 }
 
-Pack.description = `Package a new Adobe Developer App for distribution
-`
+Pack.hidden = true // hide from help for pre-release
+
+Pack.description = chalk.yellow(`(Pre-release) This command will support packaging apps for redistribution.
+`)
 
 Pack.flags = {
   ...BaseCommand.flags,